Check the Status of a Payout
This endpoint is used by a user to check the status of a payout which was initiated.
BETA Endpoints
Please note that these endpoints are currently in beta, and they may undergo changes as we continue to improve and refine the functionality.
Request
Environment | Endpoint |
---|---|
Production | GET https://api.bvnk.com/payment/v1/payouts/{{transactionReference}} |
Sandbox | GET https://api.sandbox.bvnk.com/payment/v1/payouts/{{transactionReference}} |
Response
{
"transactionReference": "1a0c24c7-c578-40ff-92cc-7a56c320db00",
"paymentReference": "Ref112455",
"amount": {
"value": 100.00,
"currency": "GBP"
},
"fee": {
"value": 0.00,
"currency": "GBP"
},
"walletId": "a:24071743000626:go5SB1l:1",
"status": "PENDING_APPROVAL",
"createdAt": "2024-09-10T11:13:51.465939Z",
"details": {
"type": "FIAT",
"beneficiary": {
"entityType": "COMPANY",
"companyDetails": {
"name": "Company ABC"
},
"individualDetails": null,
"address": {
"addressLine1": null,
"addressLine2": null,
"city": null,
"region": null,
"postCode": null,
"countryCode": "GB",
"fullAddress": null
},
"bankAccount": {
"format": "SCAN",
"bankName": null,
"accountNumber": "00015179",
"bankCode": "040825",
"bankAddress": {
"addressLine1": null,
"addressLine2": null,
"city": null,
"region": null,
"postCode": null,
"countryCode": "GB",
"fullAddress": null
}
},
"correspondentBic": null
}
},
"metadata": {
"someKey": "someValue",
"someKey2": {
"someKey3": "someValue3"
}
}
}
{
"transactionReference": "86c00ba9-91b4-40fc-bec7-85e10c1ab2af",
"paymentReference": "0IIJSsG4ki",
"amount": {
"value": 100.00,
"currency": "EUR"
},
"fee": {
"value": 0.00,
"currency": "EUR"
},
"walletId": "a:24071743003474:xE95Oq7:1",
"status": "PROCESSING",
"createdAt": "2024-08-22T11:51:16.814863Z",
"details": {
"type": "FIAT",
"beneficiary": {
"entityType": "COMPANY",
"companyDetails": {
"name": "Company ABC"
},
"individualDetails": null,
"address": {
"addressLine1": null,
"addressLine2": null,
"city": null,
"region": null,
"postCode": null,
"countryCode": "FR",
"fullAddress": null
},
"bankAccount": {
"format": "IBAN",
"bankName": null,
"accountNumber": "FR7630006000011234567890189",
"bankCode": "AGRIFRPP",
"bankAddress": {
"addressLine1": null,
"addressLine2": null,
"city": null,
"region": null,
"postCode": null,
"countryCode": "FR",
"fullAddress": null
}
},
"correspondentBic": null
}
},
"metadata": {
"someKey": "someValue",
"someKey2": {
"someKey3": "someValue3"
}
}
}
Updated 9 days ago