Import a batch transfer order

Creates one batch transfer in a single request. The batch may contain
multiple transfer orders of different types.

  • Only one batch can be imported per request.
  • A batch may contain up to 1000 transfer orders.
  • The common debit account is passed at the top level in debitAccount.
  • Individual orders are passed in the transferOrders array.

Validation rules

  • debitAccount and transferOrders are required.
  • transferOrders must not be empty.
  • Maximum 1000 orders per batch.
  • If position is provided for one order, it must be provided for all orders.
  • Debit/credit accountNumber must be in a valid format.
  • accountCurrencyCode must be a valid ISO currency code.
  • Fields and currency restrictions are validated per transfer type rules
    (same as for single transfers).
Body Params
string

Optional name for the batch.

debitAccount
object
required

Account number and currency used for debit or credit account identification.

transferOrders
array of objects
required
length between 1 and 1000

List of transfer orders in the batch. Must not be empty. Maximum number of orders per batch: 1000.

transferOrders*

A single order within a batch transfer. The debit account is defined at the batch level; these fields are the same as for single transfer orders except debitAccount and transferExternalId are not used here.

string
enum
required

Transfer type.

Allowed:
integer

Document number for this order.

integer

Order position in the batch. If provided for one order, must be provided for all orders. Must be unique and greater than 0.

amount
object
required

Amount and currency for a transfer order.

string
length ≤ 140

Payment description / purpose. Maximum length: 140 characters.

string
length ≤ 210

Additional description. Maximum length: 210 characters.

creditAccount
object

Account number and currency used for debit or credit account identification.

string

Beneficiary name. Required where applicable by transfer type.

string

Beneficiary tax / identification code. Optional.

string

Beneficiary bank code. Required where applicable by transfer type.

string

Beneficiary bank name. Optional.

string

Beneficiary address. Required for TransferToOtherBankForeignCurrency.

string
enum

Fee charge detail for foreign currency transfers to other banks. Required for TransferToOtherBankForeignCurrency. Allowed: SHA, OUR.

Allowed:
string

Taxpayer code. Required for TreasuryTransfer.

string

Taxpayer name. Required for TreasuryTransfer.

string
^\d{9}$

9-digit treasury code. Required for TreasuryTransfer.

string

External transfer ID assigned by the client system. Used for duplicate control and for later batch ID lookup via GET /bab/v1/transfers/batch/id.

string

Receiver identifier validation parameter. Optional.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json