Check the status of a payout
This endpoint is used by 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": "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",
"details": {
"entityType": "COMPANY",
"companyDetails": {
"name": "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"
}
}
Attribute | Type | Description |
---|---|---|
transactionReference | String | Unique reference identifier for the transaction. |
paymentReference | String | Reference or description for the payment. |
amount | Object | Object containing the amount and currency of the transaction. |
amount.value | Number | The value of the transaction. |
amount.currency | String | The currency of the transaction. |
fee | Object | Object containing the fee amount and currency. |
fee.value | Number | The value of the fee. |
fee.currency | String | The currency for the fee. |
walletId | String | Unique identifier for the wallet. |
status | String | Status of the transaction. |
createdAt | String | Timestamp for when the transaction was created. |
details | Object | Contains details of the payout, including the entity and bank info. |
details. type | String | Type of transaction. |
details.details. entityType | String | Type of the entity involved. |
details.details.companyDetails. name | String | Name of the company associated with the transaction. |
details.details. address | Object | Address information for the company or beneficiary. |
details.details.address. addressLine1 | String | First line of the address. |
details.details.address. addressLine2 | String | Second line of the address (optional). |
details.details.address. region | String | Region or state of the address. |
details.details.address. city | String | City of the address. |
details.details.address. countryCode | String | Country code of the address. |
details.details.address. postCode | String | Postal code of the address. |
details.details.address. fullAddress | String | Full concatenated address string. |
details.details. bankAccount | Object | Object containing the bank account information. |
details.details.bankAccount. format | String | Bank account format. |
details.details.bankAccount. bankName | String | Name of the bank associated with the account. |
details.details.bankAccount. accountNumber | String | Bank account number. |
details.details.bankAccount. bankCode | String | Bank's SWIFT/BIC code. |
details.details.bankAccount. bankAddress | Object | Address of the bank. |
details.details.bankAccount.bankAddress. addressLine1 | String | First line of the bank's address. |
details.details.bankAccount.bankAddress. addressLine2 | String | Second line of the bank's address. |
details.details.bankAccount.bankAddress. region | String | Region or state of the bank's address. |
details.details.bankAccount.bankAddress. city | String | City of the bank's address. |
details.details.bankAccount.bankAddress. countryCode | String | Country code of the bank's address. |
details.details.bankAccount.bankAddress. postCode | String | Postal code of the bank's address. |
details.details.bankAccount.bankAddress. fullAddress | String | Full concatenated address string of the bank. |
details.details. correspondentBic | String | Correspondent bank BIC code (if applicable). |
metadata | Object | Metadata related to the transaction. |
metadata.field1 | String | Additional metadata field 1. |
metadata.field2 | String | Additional metadata field 2. |
Updated 2 days ago
What’s Next