v1
latestOpenAPI 3.1.02026-07-132363652.9 MBPayout
Get details of a payout batch for the authenticated merchant
Get details of a payout batch for the authenticated merchant
get/api/v1/merchants/{merchantId}/payouts/{payoutBatchId}
Path parameters
merchantIdstring uuid required
The unique identifier of the merchant
The unique identifier of the merchant
payoutBatchIdstring uuid required
The unique identifier of the payout batch
The unique identifier of the payout batch
Response
Success
Example response
{
"success": true,
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"payment_reference": "QKM1ABC2DEF34G",
"currency": "GBP",
"gross_amount": "1395.94",
"fees_total": "14.00",
"net_amount": "1234.56",
"transaction_count": 5,
"payout_amount": "1111.10",
"retained_amount": "123.46",
"retention_rate": "0.1000",
"executed_at": "2024-01-15T10:30:00Z",
"created_at": "2024-01-15T10:00:00Z"
}
}