v1

latestOpenAPI 3.1.02026-07-24360204.4 KB

Create Bulk Transfer

Use this API to create a bulk transfer.

post/v2/transfers/bulk

Request body

typestring required

Type of bulk transfer you want to create. Possible values: <ul><li>account_number</li>

debit_account_idstring required

The account_id from which money should be debited. Note: Currently, you can only use a virtual account used as a transfer wallet as a debit account. Example: va_thdScysrIYcT7R5X1NuMhbRNH

bulk_reference_idstring required

Unique reference for the bulk transfer request set by you. <ul><li>Only alphabets and numbers are allowed.</li><li>Minimum: 7 characters.</li><li>Maximum: 40 characters.</li></ul>Example: 1234567890123

Response

200

idstring

objectstring

typestring

statusstring

total_individual_transfersinteger

total_transfer_amountinteger

bulk_reference_idstring

updated_atinteger

is_sandboxboolean

created_atinteger

Example response

{
  "id": "butr_n6kbQ4UPg2D0hN9Vo3x8gDkDK",
  "object": "bulk_transfer",
  "type": "account_number",
  "status": "queued",
  "debit_account_details": {
    "name": "Anil Reddy",
    "account_number": "797979267664205",
    "ifsc": "IDFB0040101"
  },
  "total_individual_transfers": 1,
  "total_transfer_amount": 1000,
  "bulk_reference_id": "1234522442433222243236",
  "updated_at": 1677239064,
  "is_sandbox": true,
  "created_at": 1677239064
}