Check Payout Status
The Payout Status API endpoint allows you to check the current status of an initiated payout. It can also be used to verify the payout's state after receiving status change webhooks or whenever additional confirmation is required.
To check the status of a payout, send the GET /payment/v1/payouts/{transactionReference}
request with the specified reference of the previous transaction ({transactionReference}
).
In the successful response, you receive the details on the transaction and its status.
{
"transactionReference": "123e4567-e89b-12d3-a456-426614174000",
"paymentReference": "Payment for invoice #12345",
"amount": {
"value": 1000,
"currency": "GBP"
},
"fee": {
"value": 0.00,
"currency": "GBP"
},
"walletId": "a:24071743003474:xE95Oq7:1",
"status": "PROCESSING",
"createdAt": "2024-09-26T14:30:00Z",
"details": {
"type": "FIAT",
"beneficiary": {
"entityType": "COMPANY",
"businessDetails": {
"businessName": "Doe Corp"
},
"address": {
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"region": "London",
"city": "London",
"country": "GB",
"postCode": "12345",
"fullAddress": "123 Main St Suite 500"
},
"bankAccount": {
"format": "IBAN",
"bankName": "ABC Bank",
"accountNumber": "GB29NWBK60161331926819",
"bankCode": "NWBKGB2L",
"bankAddress": {
"addressLine1": "123 Main St",
"addressLine2": "Suite 500",
"region": "London",
"city": "London",
"country": "GB",
"postCode": "12345",
"fullAddress": "123 Main St Suite 500"
}
},
"correspondentBic": "ABCDEF12"
}
},
"metadata": {
"field1": "field1 value",
"field2": "field2 value"
}
}
Updated 12 days ago
What’s Next