Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
batch-group

Create a batch group

Create a new batch group.

A batch group can hold up to 1000 transfers that will be funded together. After creating the group, add transfers to it, then complete the group to receive pay-in details.

post/v3/profiles/{profileId}/batch-groups

Path parameters

profileIdinteger required
Example:12345678

The ID of the profile to create the batch group for.

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Request body

sourceCurrencystring required

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

namestring required

Descriptive name for display purposes. Recommended to use a name that uniquely represents this batch. Maximum length of 100 characters.

Example request

{
  "sourceCurrency": "GBP",
  "name": "My batch group"
}

Response

Batch group created successfully.

Note that payInDetails is empty for newly created batch groups.

idstring uuid

Batch group ID.

versioninteger

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.

namestring

Descriptive name for the batch group.

sourceCurrencystring

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

status'NEW' | 'COMPLETED' | 'MARKED_FOR_CANCELLATION' | 'PROCESSING_CANCEL' | 'CANCELLED'

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.
transferIdsinteger[]

The IDs of all transfers successfully added to the group.

Example response

{
  "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",
      "accountNumber": "9910728",
      "bankCode": "8301",
      "bankAddress": {
        "name": "CitiBank Europe Plc",
        "firstLine": "Bolette brygge 1",
        "postCode": "0252",
        "city": "Oslo",
        "country": "Norway"
      },
      "transferWiseAddress": {
        "name": "TransferWise Ltd",
        "firstLine": "6th Floor, The Tea Building, 56 Shoreditch High Street",
        "postCode": "E1 6JJ",
        "city": "London",
        "country": "United Kingdom"
      },
      "bban": "83019910728"
    }
  ]
}