Skip to content

Batch Payment Groups

A batch group is a named collection of up to 1000 transfers that can be managed as a single unit. Batch groups are primarily used for funding multiple transfers with a single payment.

Workflow:

  1. Create a batch group with a source currency
  2. Add transfers to the group (up to 1000)
  3. Complete the batch group to close it for modifications
  4. Fund the batch group from a balance or via direct debit

Individual transfers in the group follow standard transfer lifecycle and can be tracked separately.

Schemas
Operations

Batch Group

idstring, (uuid)

Batch group ID.

Example:"54a6bc09-cef9-49a8-9041-f1f0c654cd88"
versioninteger, (int64)

Batch version, used for concurrency control. This number is updated whenever there is a change to the batch group state (its status, the identity of the transfers in the batch, etc).

Some API operations require this version in requests, and operations may be rejected when the requested version does not match the server's version.

The version is a signed integer and is not ordered with respect to any previous version.

Example:123
namestring

Descriptive name for the batch group.

Example:"My batch group"
sourceCurrencystring

Source currency code (ISO 4217 Alphabetic Code). This currency is expected to be used for funding the batch group.

Example:"GBP"
statusstring

Current batch group status:

  • NEW — New batch group with zero or more transfers. Able to have more transfers added to it. Transfers in a NEW group cannot yet be funded and paid out.
  • COMPLETED — The batch group has had all desired transfers added and is now closed to further changes. Transfers in the group can now be funded and paid out. Note: COMPLETED does not imply payouts have been successfully completed.
  • MARKED_FOR_CANCELLATION — Cancellation of the transfers in the batch group was requested.
  • PROCESSING_CANCEL — Transfers in the group are being cancelled.
  • CANCELLED — Transfers in the group have been cancelled.
Enum:"NEW""COMPLETED""MARKED_FOR_CANCELLATION""PROCESSING_CANCEL""CANCELLED"
Example:"COMPLETED"
transferIdsArray of integers, (int64)

The IDs of all transfers successfully added to the group.

Example:
[
  234,
  456
]
payInDetailsArray of objects

List of pay-in details describing how the batch group can be funded. Provided only when the batch group is in the COMPLETED state.

Currently supported types: bank_transfer.

{
  "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd88",
  "version": 123,
  "name": "My batch group",
  "sourceCurrency": "GBP",
  "status": "COMPLETED",
  "transferIds": [
    234,
    456
  ],
  "payInDetails": [
    {
      "type": "bank_transfer",
      "reference": "B5323",
      "amount": 12504.54,
      "currency": "NOK",
      "name": "TransferWise Ltd",
      "branchName": null,
      "accountNumber": "9910728",
      "accountType": null,
      "bankCode": "8301",
      "bankAddress": { … },
      "transferWiseAddress": { … },
      "iban": null,
      "bban": "83019910728",
      "institutionNumber": null,
      "transitNumber": null,
      "beneficiaryBankBIC": null,
      "intermediaryBankBIC": null,
      "fpsIdentifier": null,
      "clearingNumber": null
    }
  ]
}