Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
batch-group

Fund a batch group

Funds all transfers in a batch group from a multi-currency account balance. Transfers are paid out immediately.

The batch group must first be completed, and there must be enough funds in the account for the whole batch. Otherwise, an insufficient funds error will be returned.

{% admonition type="warning" %} This endpoint is SCA protected when it applies. If your profile is registered within the UK and/or EEA, SCA most likely applies to you. For more information, please read implementing SCA. {% /admonition %}

post/v3/profiles/{profileId}/batch-payments/{batchGroupId}/payments

Path parameters

profileIdinteger required
Example:12345678

The ID of the profile that the batch group is associated with.

batchGroupIdstring uuid required
Example:54a6bc09-cef9-49a8-9041-f1f0c654cd88

The batch group ID.

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

type'BALANCE' required

The method of payment to use.

Example request

{
  "type": "BALANCE"
}

Response

Batch group funded successfully.

idstring uuid

Unique batch group ID.

namestring

Descriptive name.

fileNamestring nullable

If this batch was submitted as a file, this is the given file name.

alreadyPaidboolean

Not applicable to this use case.

shortIdinteger

Not applicable to this use case.

userIdinteger

The ID of the user who initiated this payment.

profileIdinteger

The ID of the profile this payment belongs to.

sourceCurrencystring

The source currency of the batch. Note that if there are insufficient funds, an automatic conversion from another currency can occur.

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

Current batch group status.

groupType'API' | 'FILE'

Whether this batch was submitted over the API or as a file.

transferIdsinteger[]

The IDs of all transfers in the group.

Example response

{
  "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd88",
  "name": "My batch group",
  "alreadyPaid": true,
  "shortId": 12345,
  "userId": 33333333,
  "profileId": 44444444,
  "sourceCurrency": "GBP",
  "status": "COMPLETED",
  "groupType": "API",
  "transferIds": [
    100001,
    100002,
    100003
  ]
}