BVbvnk
Fiat Payments
Crypto Payments

Create internal transfer

Changed on

Creates an internal stablecoin and fiat transfer between customer's and partner's wallets.

Payment combinations:

  • Crypto to crypto

  • Fiat to fiat

post/payment/v2/transfers

Request

Headers

Idempotency-Keystring uuid required
Example:1e74002e-74a1-48fd-b707-147c3187a3e1

Client-generated unique identifier for the request in UUID format. Ensures that retried requests are not processed more than once.

Request body

walletIdstring required

Identifier for your debit wallet associated with the transaction.

amountnumber float required

Transfer amount in fiat and crypto currency units.

currencystring required

Currency code. Supports both fiat (ISO-4217) and crypto currencies.

referencestring required

Internal identifier that is shown in the CSV reports for custom use cases. Can be a UUID or any string to identify the payment.

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 request

{
  "beneficiary": {
    "walletId": "a:24122329329347:HsdJVhW:1"
  },
  "metadata": {
    "source": "api",
    "orderId": "ORD-48213"
  }
}

Response

Transfer created 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

      for the header request parameter Idempotency-Key, the minLength was increased from 3 to 36

    • breaking

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

    • breaking

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

    • warning

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

    • warning

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

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status