v5

latestOpenAPI 3.1.02026-07-262421791.5 MB

batch-group

Create a batch group transfer

Create a transfer in the batch group using a previously created recipient account and quote.

For the request body format, see transfer creation. For quote and recipient creation, see quote creation and recipient creation.

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

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

targetAccountinteger required

Recipient account ID.

sourceAccountinteger

Refund recipient account ID.

quoteUuidstring uuid required

Quote ID.

customerTransactionIdstring uuid required

Unique identifier you generate for this transfer attempt.

Example request

{
  "targetAccount": 67890,
  "sourceAccount": 12345,
  "quoteUuid": "bd244a95-dcf8-4c31-aac8-bf5e2f3e54c0",
  "customerTransactionId": "a]1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "details": {
    "reference": "to my friend",
    "transferPurpose": "verification.transfers.purpose.pay.bills",
    "transferPurposeSubTransferPurpose": "verification.sub.transfers.purpose.pay.interpretation.service",
    "sourceOfFunds": "verification.source.of.funds.other"
  }
}

Response

Transfer created successfully. Returns a transfer object.

object required

Transfer object. See Transfer API reference for full details.