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 APIs.

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_PMXrJy7xKcFW97xx1z8QigcLo",
      "object": "transfer",
      "type": "account_number",
      "amount": 3.69,
      "debit_account_id": "sa_WWAHxveQ4TXAEs2dxRSbeDh9V",
      "beneficiary_id": "sab_eKiCE1tH8GVAkmzbTUzOLNqqg",
      "status": "success",
      "bank_reference_number": "STCB220221051342",
      "currency_code": "inr",
      "message": "success",
      "payment_mode": "neft",
      "payment_remark": "Lego Death Star",
      "paid_to": "10000000001642",
      "otp_attempts": 1,
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "merchant_reference_id": "1002358",
      "transacted_at": 1663585417,
      "is_sandbox": true,
      "created_at": 1663585262
    }
  ]
}

Learn more about the Get All Transfer API.

Get Transfer by ID

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

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

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

{
  "id": "tr_PMXrJy7xKcFW97xx1z8QigcLo",
  "object": "transfer",
  "type": "account_number",
  "amount": 3.69,
  "debit_account_id": "sa_WWAHxveQ4TXAEs2dxRSbeDh9V",
  "beneficiary_id": "sab_eKiCE1tH8GVAkmzbTUzOLNqqg",
  "status": "success",
  "bank_reference_number": "STCB220221051342",
  "currency_code": "inr",
  "message": "success",
  "payment_mode": "neft",
  "payment_remark": "Lego Death Star",
  "paid_to": "10000000001642",
  "otp_attempts": 1,
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  },
  "merchant_reference_id": "1002358",
  "transacted_at": 1663585417,
  "is_sandbox": true,
  "created_at": 1663585262
}

Learn more about the Get Transfer by ID API.