BVbvnk
Fiat Payments

Get transfer

Changed on

Retrieves a specific transfer details.

get/payment/v1/transfers/{transactionReference}

Request

Path parameters

transactionReferencestring uuid required
Example:5dc4e061-31c6-4b96-8c4d-0ea984aece0b

The transactionReference of the transfer that you want to retrieve.

Response

OK

transactionReferencestring uuid

Unique identifier for the transaction.

paymentReferencestring

Optional payment reference.

walletIdstring

Identifier for the debit wallet associated with the transaction.

status'PENDING' | 'COMPLETED' | 'FAILED' | 'REJECTED'

The status of the transaction.

createdAtstring date-time

Timestamp when the transaction was created.

metadataMetadata

Custom metadata key-value pairs. Structure: key: value. Restrictions:

  • Maximum five keys.

  • Each key maximum length 50 characters.

  • Each value maximum length 100 characters.

  • Keys and values must be simple strings.

Example response

{
  "transactionReference": "123e4567-e89b-12d3-a456-426614174000",
  "paymentReference": "Invoice #12345",
  "amount": {
    "value": 1000,
    "currency": "USD"
  },
  "fee": {
    "value": 10,
    "currency": "USD"
  },
  "walletId": "a:24092328494070:G5i4XZ9:1",
  "status": "PROCESSING",
  "createdAt": "2024-09-26T14:30:00Z",
  "details": {
    "type": "WALLET",
    "beneficiary": {
      "entityType": "COMPANY",
      "companyDetails": {
        "name": "Doe Corp"
      },
      "address": {
        "addressLine1": "123 Bank St",
        "addressLine2": "Suite 500",
        "region": "New York",
        "city": "New York",
        "countryCode": "US",
        "postCode": "10001"
      },
      "walletId": "a:24092328494070:G5i4XZ9:1"
    }
  },
  "metadata": {
    "source": "api",
    "orderId": "ORD-48213"
  }
}

Changes

  • 97d6c0d2fe2eRevision changes
    • breaking

      the / response's property type changed from object to array for status

    • warning

      removed the optional property // from the response with the status

    • info

      added the required property to the response with the status