BVbvnk
Internal Transfers

Perform transfer action

Changed on

Performs an action on a V3 transfer.

Supported actions:

  • ACCEPT_QUOTE: Accepts a conversion quote for a transfer in PENDING_QUOTE_ACCEPTANCE status. Requires the digest value from the transfer's conversion object.

  • REFRESH_QUOTE: Refreshes an expired quote for a transfer. Returns the transfer with updated conversion details and a new expiration time.

post/payment/v3/transfers/{transferId}/actions

Request

Path parameters

transferIdstring uuid required
Example:d4a904e0-b040-4132-a6d3-ed7d03cdfce7

The unique identifier of the transfer to perform an action on.

Request body

type'ACCEPT_QUOTE' | 'REFRESH_QUOTE' required

Action type to perform on the transfer.

  • ACCEPT_QUOTE: Accepts the conversion quote for a transfer in PENDING_QUOTE_ACCEPTANCE status. The digest field is required and must match the value from the transfer's conversion object.

  • REFRESH_QUOTE: Refreshes a quote that has expired. Returns the transfer with updated conversion details, a new expiration time, and a new digest value.

digeststring

Quote digest taken from the conversion object of a transfer in PENDING_QUOTE_ACCEPTANCE status. Required for ACCEPT_QUOTE action. The quote must be accepted before the transfer is settled.

Response

Action performed successfully

idstring uuid required

Unique transfer identifier.

referencestring required

Transfer reference provided in the request.

type'payment:transfer' required

Payment type constant for transfers.

status'PROCESSING' | 'PENDING_QUOTE_ACCEPTANCE' | 'EXPIRED' | 'COMPLETED' | 'FAILED' required

Current transfer status.

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.

expiresAtstring date-time

Transfer expiration timestamp. Unaccepted quote transfers expire 24 hours after creation.

createdAtstring date-time required

Creation timestamp.

updatedAtstring date-time required

Last update timestamp.

method'BOOK'

Transfer method.

Example response

{
  "type": "payment:transfer",
  "metadata": {
    "source": "api",
    "orderId": "ORD-48213"
  },
  "fees": {
    "processingFee": {
      "amount": 100.5,
      "currency": "USD"
    }
  },
  "trackingDetails": [
    {
      "externalTransactionId": "123e4567-e89b-12d3-a456-426614174000",
      "imad": "20260304ABCDXXXX012345",
      "omad": "20260304QMQP021000080",
      "traceNumber": "021000080123456",
      "uetr": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "method": "BOOK"
}

Changes