BVbvnk
Fiat Payments
Crypto Payments

Get transfer

Changed on

Retrieves a specific transfer details.

get/payment/v2/transfers/{transferId}

Request

Path parameters

transferIdstring uuid required
Example:ae29acc3-c54a-11f0-90b6-21c3f364ff25

The transfer ID that you want to retrieve.

Response

Transfer retrieved successfully

idstring uuid required

Unique transfer identifier.

referencestring required

Transfer unique reference that you must provide.

type'payment:transfer' required

Payment type constant for transfers.

status'PROCESSING' | 'COMPLETED' | 'FAILED' required

Current transfer status. More statuses may be added in future releases.

method'BOOK' required

Transfer method.

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.

createdAtstring date-time required

Creation timestamp.

updatedAtstring date-time required

Last update timestamp.

Example response

{
  "type": "payment:transfer",
  "method": "BOOK",
  "fees": {
    "processingFee": {
      "amount": 100.5,
      "currency": "USD"
    }
  },
  "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