Manage Bulk Transfer

Listed below are the various actions available to manage bulk transfers.

Get All Transfers: Utilize this API to get all the transfers against a bulk transfer request by querying the bulk reference ID.
Get Bulk Transfer by ID: Utilize the "Get Bulk Transfer by ID" API to access detailed information about the bulk transfer.

Get All Transfers

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

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

📘
Note:
The endpoint for this API is the same as the Get All Transfers API.
Pass the bulk_reference_id as a query parameter to get the details of all individual transfers created via a bulk transfer request.

Below is a sample response for the Get All Transfers API.

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "tr_ULEQP1iAtMBsEDuL2d3K3jmrj",
      "object": "transfer",
      "type": "account_number",
      "amount": 1,
      "debit_account_id": "va_Zpo4BFKhHIfDijxPP9vzVF6Id",
      "beneficiary_id": "vab_F55ddzMlmZzLWupwNAa0qFCR6",
      "status": "pending",
      "currency_code": "inr",
      "payment_mode": "imps",
      "payment_remark": "test",
      "paid_to": "414000000012",
      "beneficiary_name": "Anil Reddy",
      "beneficiary_ifsc": "ICIC0004140",
      "bulk_transfer_id": "butr_WbudbAXT9HV3S52cz3Oy1MIVK",
      "otp_attempts": 0,
      "metadata": {
        "key_1": "DD",
        "key_2": "XoF"
      },
      "merchant_reference_id": "1710930495",
      "transacted_at": 1710930495,
      "is_sandbox": true,
      "created_at": 1710930495
    },
    {
      "id": "tr_djthyd8bttY1gKSHoT2deVuxA",
      "object": "transfer",
      "type": "account_number",
      "amount": 1,
      "debit_account_id": "va_Zpo4BFKhHIfDijxPP9vzVF6Id",
      "beneficiary_id": "vab_v1kQE5Zkdn8RKj9wm4U8YzEb8",
      "status": "pending",
      "currency_code": "inr",
      "payment_mode": "imps",
      "payment_remark": "test",
      "paid_to": "50100000000013",
      "beneficiary_name": "Rahul Reddy",
      "beneficiary_ifsc": "HDFC0000832",
      "bulk_transfer_id": "butr_WbudbAXT9HV3S52cz3Oy1MIVK",
      "otp_attempts": 0,
      "metadata": {
        "key_1": "DD",
        "key_2": "XoF"
      },
      "merchant_reference_id": "1710930494",
      "transacted_at": 1710930495,
      "is_sandbox": true,
      "created_at": 1710930495
    }
  ]
}

Learn more about the Get All Transfer API.

Get Bulk Transfer by ID

Use the below endpoint to get specific details of the bulk transfers.

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

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

{
  "id": "butr_n6kbQ4UPg2D0hN9Vo3x8gDkDK",
  "object": "bulk_transfer",
  "type": "account_number",
  "status": "queued",
  "debit_account_details": {
    "name": "Anil Reddy",
    "account_number": "194020010215",
    "ifsc": "ICIC0000296"
  },
  "total_individual_transfers": 2,
  "total_transfer_amount": 2,
  "bulk_reference_id": "1004224",
  "updated_at": 1677239064,
  "is_sandbox": true,
  "created_at": 1677239064
}

Learn more about the Get Bulk Transfer by ID API.

Get All Transfers

📘Note:

Get Bulk Transfer by ID

📘
Note: