BVbvnk
Fiat Payments

Create internal transfer

Changed on

Create an internal Fiat transfer to an existing beneficiary wallet.

post/payment/v1/transfers

Request

Headers

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

Unique request identifier (any string, preferably in UUID format).

Request body

walletIdstring required

Identifier for the debit wallet associated with the transaction.

paymentReferencestring required

Custom identifier supplied for a transaction. It is used to link a transaction to a specific customer or use case. Note that the value is visible to the beneficiary. Only whitespaces, alphanumeric characters (a-z, A-Z, 0-9), commas (,) and periods (.).

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

{
  "walletId": "a:24092328494070:G5i4XZ9:1",
  "amount": {
    "value": 700,
    "currency": "USD"
  },
  "paymentReference": "Payment for invoice 12345",
  "instruction": {
    "type": "FIAT",
    "beneficiary": {
      "walletId": "a:87333266494070:G5i9AT9:1"
    }
  },
  "metadata": {
    "source": "api",
    "orderId": "ORD-48213"
  }
}

Response

Created

transactionReferencestring uuid required

Unique identifier for the transaction.

Example response

{
  "transactionReference": "123e4567-e89b-12d3-a456-426614174000",
  "fee": {
    "value": 10,
    "currency": "USD"
  }
}

Changes

  • 97d6c0d2fe2eRevision changes
    • 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