v1

latestOpenAPI 3.1.02026-07-24360204.4 KB

Get All Transfers

Use this API to get details of all transfers made from your ZWITCH account.

get/v1/transfers

Query parameters

results_per_pagestring

The number of results you want to get per API call. Use this with the start_before or start_after parameters for pagination.<ul><li>Defaul.t value 10.<li>Maximum value 100.</ul></li>Example: 15

start_beforestring

The transfer_id before which you want to get details. Use this with the results_per_page for pagination. Example: tr_uEqOtg07bcXMb99WWBVOnKP3Y

start_afterstring

The transfer_id after which you want to get details. Use this with the results_per_page for pagination. Example: tr_uEqOtg07bcXMb99WWBVOnKP3Y

from_datestring

Has to be used with to_date. The UNIX timestamp after which details should be returned. Use this with the results_per_page, start_after, and start_before for pagination. Example: 1651052818

to_datestring

Has to be used with from_date. The UNIX timestamp before which details should be returned. Use this with the results_per_page, start_after, and start_before for pagination. Example: 1651052818

debit_account_idstring

Get a list of all transfers made from the entered debit_account_id. Example: va_tIOb4zA92pAkhRzlr4Z6pbHSv

credit_account_idstring

Get a list of all transfers made to the entered credit_account_id. Example: va_lV5JpIu8AVMNfPexv4W8SyuOv

beneficiary_idstring

Get a list of all transfers made to the entered beneficiary_id. Example: vab_SVzPPMJOyRa0rI8n6CCN6wMa8

merchant_reference_idstring

The unique identifier entered when creating the transfer. Example: 1409614085

bulk_reference_idstring

The unique identifier entered when creating the bulk transfer. Example: 1409614085

Response

200

objectstring

has_moreboolean

Example response

{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "tr_aTKJAon8uLYqyk7wpP3kFAaYs",
      "object": "transfer",
      "type": "account_number",
      "amount": 1,
      "debit_account_id": "va_3Zk64YDxnBtyvkzWoIVUOIWHu",
      "beneficiary_id": "vab_KT8z4g7wlXNbef9gU5IR48PCF",
      "status": "success",
      "bank_reference_number": "214516704238",
      "currency_code": "inr",
      "payment_mode": "imps",
      "payment_remark": "Lego Death Star",
      "paid_to": "54055602160",
      "beneficiary_name": "Anil Reddy",
      "beneficiary_ifsc": "ICIC0004140",
      "bulk_transfer_id": "butr_WbudbAXT9HV3S52cz3Oy1MIVK",
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "merchant_reference_id": "1000077",
      "transacted_at": 1653476654,
      "created_at": 1653476653
    }
  ]
}