Check the Status of a Transfer

This endpoint is used by a user to check the status of a transfer which they initiated.


🚧

Early Access

Please note that this endpoint is currently in early access, and it may undergo changes as we continue to improve and refine the functionality.

Request:

EnvironmentEndpoint
ProductionGET https://api.bvnk.com/payment/v1/transfers/{transaction_id}
SandboxGET https://api.sandbox.bvnk.com/payment/v1/transfers/{transaction_id}
curl --location 'https://api.sandbox.bvnk.com/payment/api/v1/transfers/{transaction_id}' \
--header 'Authorization: Hawk id="vOjKT0txxpp6TMQP6QTQziyBjAiVnMGNH3dbFa0SGhK7OFsMD6lWFPaN8TXCqkXk", ts="1724772959", nonce="BP1z-t", mac="hE8lI09+RMuhyH834VJnP6RNuQA+Cb97mWVWt1SGj9M="'

Response:

{
   "transactionReference":"493fe5f3-5cbe-49cb-9786-f1a03e1e61f1",
   "paymentReference":"REF850136",
   "amount":{
      "value":25,
      "currency":"EUR"
   },
   "fee":{
      "value":0.0,
      "currency":"EUR"
   },
   "walletId": "a:23120645967001:kIlS5t3:1",
   "status": "COMPLETED",
   "createdAt": "2024-08-09T10:49:33.809785Z"
   "details":{
      "type": "WALLET",
      "beneficiary": {
         "entityType": "COMPANY",
         "companyDetails": {
            "name":"some-name"
         },
         "individualDetails": null,
         "address":{
            "addressLine1": "Level 3",
            "addressLine2": "89 Charterhouse St, Barbican",
            "city": "London",
            "region": "London",
            "postCode": "EC1M 6PE",
            "countryCode": "GB"
         },
         "walletId": "a:23120645967001:kIlS5t1:1"
      }
   }
}

Attribute

Type

Description

transactionReference

String

Unique reference identifier for the transaction (UUID).

paymentReference

String

Reference or description for the payment.

amount

Object

Object containing the amount and currency of the transfer.

amount.value

Number

The value of the transfer.

amount.currency

String

The currency of the transfer.

fee

Object

Contains information about the fees related to the transfer.

fee.value

Number

The value of the fee.

fee.currency

String

The currency of the fee.

walletId

String

Unique identifier for the wallet from where funds are being transferred out.

status

String

The status for the transfer.

createdAt

String

The date the transfer was created.

details

Object

Contains details of the transfer, including the entity and bank info.

details.
type

String

Type of transaction (e.g., "FIAT").

details.
beneficiary

Object

Contains beneficiary information.

details.beneficiary.
entityType

String

Specifies the type of beneficiary.

details.beneficiary
companyDetails

Object

Specifies the company details of the beneficiary.

details.beneficiary.
individualDetails

Object

Specifies the company details of the beneficiary.

details.beneficiary.
address

String

Specifies the address details of the beneficiary.

details.beneficiary.
walletId

String

Specifies the walletId details of the beneficiary where the funds should be transferred to.

Possible Statuses:

  • PENDING
  • COMPLETED
  • FAILED
  • REJECTED