Get a disbursement batch

GET

/v2/payments/bulk-withdrawals/batches/{id}

Requires DISBURSEMENTS_READ, granted by PAYMENTS_READ or DISBURSEMENTS_WRITE (bundles)

Returns a disbursement batch with its status and totals. While withdrawals in the batch are still pending, feeQuote shows the fees they will incur.

Parameters

Path Parameters

id*

Batch ID.

Type

string

Required

Example"5b9a3c1e-2f4d-4a7b-9c8e-1d2f3a4b5c6d"

Format

"uuid"

Responses

OK

Content-Type

application/json

{

"id": "string",

"label": "string",

"currency": "string",

"totalAmount": "string",

"withdrawalCount": 0,

"status": "string",

"uploadedBy": "string",

"uploadedByName": {

"name": "string",

"surname": "string"

},

"approvedBy": "string",

"approvedByName": {

"name": "string",

"surname": "string"

},

"approvedAt": "string",

"createdAt": "string",

"updatedAt": "string",

"completedAt": "string",

"feeQuote": {

"fee": "string",

"currency": "string",

"withdrawalCount": 0,

"grossTotal": "string",

"requiredTotal": "string",

"feeGroups": [

{

"actionType": "string",

"withdrawalCount": 0,

"grossTotal": "string"

}

]

}

}

Samples

Errors

HTTP	Error	When
400	BAD_REQUEST	A query parameter or field is invalid.
400	-11INVALID_REQUEST	The batch ID isn't a valid UUID.
403	-16098PAYMENTS_USER_ACCESS_NOT_CONFIGURED	Payments haven't been set up for your business yet.
404	NOT_FOUND	No batch with this ID exists on your account.
500	INTERNAL_ERROR	Unexpected error in the payments service.
502	-16097EXCHANGE_API_ERROR	The payments service failed to process the request.
502	EXCHANGE_API_ERROR	The payments service couldn't complete the request. Try again later.
503	-16099PAYMENTS_BACKEND_PROXY_DISABLED	Payments endpoints are temporarily unavailable.

Plus the errors common to all signed endpoints.