Manage Transfers

Learn about the APIs available to manage transfers.

Listed below are the various actions available to manage transfers.

  • Get Transfers : Get a list of all transfers you have made using ZWITCH APIs.
  • Get Transfers by ID : Get the details of an individual transfer.

Get Transfers

Use the below endpoint to get a list of all transfers you have made from using ZWITCH API.

GET: https://api.zwitch.io/v1/transfers

Below is a sample response for the Get Transfers API.

{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "tr_1RXhgvAsznx9zgA0PJ7QzpWCi",
      "object": "transfer",
      "type": "vpa",
      "amount": 3.69,
      "debit_account_id": "va_NB6MHERYZRWuOEq3zB5qhnH7k",
      "beneficiary_id": "vab_bj7y4CkSxKWRqCDq7ACBfwahz",
      "status": "success",
      "bank_reference_number": "115913409927",
      "currency_code": "inr",
      "message": "Transaction success",
      "payment_mode": "upi",
      "payment_remark": "Lego Death Star",
      "paid_to": "ganga-reddy2090@example",
      "otp_attempts": 0,
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "merchant_reference_id": "1002301",
      "transacted_at": 1662637616,
      "is_sandbox": true,
      "created_at": 1662637616
    },
    {
      "id": "tr_mYKdOvYMvG3ksU85ZZXheEGOc",
      "object": "transfer",
      "type": "account_number",
      "amount": 3.69,
      "debit_account_id": "va_NB6MHERYZRWuOEq3zB5qhnH7k",
      "beneficiary_id": "vab_z2O7HI3l7BY1w71SCzUJOAjZv",
      "status": "success",
      "bank_reference_number": "768143496212159",
      "currency_code": "inr",
      "payment_mode": "neft",
      "payment_remark": "Lego Death Star",
      "paid_to": "10000000002238",
      "otp_attempts": 0,
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "merchant_reference_id": "1002300",
      "transacted_at": 1662637607,
      "is_sandbox": true,
      "created_at": 1662637607
    }
  ]
}

Get Transfer by ID

Use the below endpoint to get details of a transfers by id using ZWITCH API.

GET: https://api.zwitch.io/v1/transfers/{transfer_id}

Below is a sample response for the Get Transfer by ID API.

{
  "id": "tr_1RXhgvAsznx9zgA0PJ7QzpWCi",
  "object": "transfer",
  "type": "vpa",
  "amount": 3.69,
  "debit_account_id": "va_NB6MHERYZRWuOEq3zB5qhnH7k",
  "beneficiary_id": "vab_bj7y4CkSxKWRqCDq7ACBfwahz",
  "status": "success",
  "bank_reference_number": "115913409927",
  "currency_code": "inr",
  "message": "Transaction success",
  "payment_mode": "upi",
  "payment_remark": "Lego Death Star",
  "paid_to": "ganga-reddy2090@example",
  "otp_attempts": 0,
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  },
  "merchant_reference_id": "1002301",
  "transacted_at": 1662637616,
  "is_sandbox": true,
  "created_at": 1662637616
}