Check the Status of a Payout

This endpoint is used 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

EnvironmentEndpoint
ProductionGET https://api.bvnk.com/payment/v1/payouts/{{transactionReference}}
SandboxGET 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"
    }
}

AttributeTypeDescription
transactionReferenceStringUnique reference identifier for the transaction.
paymentReferenceStringReference or description for the payment.
amountObjectObject containing the amount and currency of the transaction.
amount.valueNumberThe value of the transaction.
amount.currencyStringThe currency of the transaction.
feeObjectObject containing the fee amount and currency.
fee.valueNumberThe value of the fee.
fee.currencyStringThe currency for the fee.
walletIdStringUnique identifier for the wallet.
statusStringStatus of the transaction.
createdAtStringTimestamp for when the transaction was created.
detailsObjectContains details of the payout, including the entity and bank info.
details.
type
StringType of transaction.
details.details.
entityType
StringType of the entity involved.
details.details.companyDetails.
name
StringName of the company associated with the transaction.
details.details.
address
ObjectAddress information for the company or beneficiary.
details.details.address.
addressLine1
StringFirst line of the address.
details.details.address.
addressLine2
StringSecond line of the address (optional).
details.details.address.
region
StringRegion or state of the address.
details.details.address.
city
StringCity of the address.
details.details.address.
countryCode
StringCountry code of the address.
details.details.address.
postCode
StringPostal code of the address.
details.details.address.
fullAddress
StringFull concatenated address string.
details.details.
bankAccount
ObjectObject containing the bank account information.
details.details.bankAccount.
format
StringBank account format.
details.details.bankAccount.
bankName
StringName of the bank associated with the account.
details.details.bankAccount.
accountNumber
StringBank account number.
details.details.bankAccount.
bankCode
StringBank's SWIFT/BIC code.
details.details.bankAccount.
bankAddress
ObjectAddress of the bank.
details.details.bankAccount.bankAddress.
addressLine1
StringFirst line of the bank's address.
details.details.bankAccount.bankAddress.
addressLine2
StringSecond line of the bank's address.
details.details.bankAccount.bankAddress.
region
StringRegion or state of the bank's address.
details.details.bankAccount.bankAddress.
city
StringCity of the bank's address.
details.details.bankAccount.bankAddress.
countryCode
StringCountry code of the bank's address.
details.details.bankAccount.bankAddress.
postCode
StringPostal code of the bank's address.
details.details.bankAccount.bankAddress.
fullAddress
StringFull concatenated address string of the bank.
details.details.
correspondentBic
StringCorrespondent bank BIC code (if applicable).
metadataObjectMetadata related to the transaction.
metadata.field1StringAdditional metadata field 1.
metadata.field2StringAdditional metadata field 2.