Sign in

v66

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-042174421.1 MB
Book Transfer

Create book transfer

Book transfer funds between two financial accounts or between a financial account and card

post/v1/book_transfers

Request body

amountinteger required

Amount to be transferred in the currency's smallest unit (e.g., cents for USD). This should always be a positive value.

category'ADJUSTMENT' | 'BALANCE_OR_FUNDING' | 'DERECOGNITION' | 'DISPUTE' | 'FEE' | 'INTERNAL' | 'REWARD' | 'PROGRAM_FUNDING' | 'PROGRAM_TRANSFER' | 'TRANSFER' required
from_financial_account_tokenstring uuid required

Globally unique identifier for the financial account or card that will send the funds. Accepted type dependent on the program's use case.

memostring

Optional descriptor for the transfer.

subtypestring required

The program specific subtype code for the specified category/type.

to_financial_account_tokenstring uuid required

Globally unique identifier for the financial account or card that will receive the funds. Accepted type dependent on the program's use case.

tokenstring uuid

Customer-provided token that will serve as an idempotency token. This token will become the transaction token.

type'ATM_BALANCE_INQUIRY' | 'ATM_WITHDRAWAL' | 'ATM_DECLINE' | 'INTERNATIONAL_ATM_WITHDRAWAL' | 'INACTIVITY' | 'STATEMENT' | 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'CUSTOMER_SERVICE' | 'ACCOUNT_MAINTENANCE' | 'ACCOUNT_ACTIVATION' | 'ACCOUNT_CLOSURE' | 'CARD_REPLACEMENT' | 'CARD_DELIVERY' | 'CARD_CREATE' | 'CURRENCY_CONVERSION' | 'INTEREST' | 'LATE_PAYMENT' | 'BILL_PAYMENT' | 'PAYMENT_FEE' | 'CASH_BACK' | 'ACCOUNT_TO_ACCOUNT' | 'CARD_TO_CARD' | 'DISBURSE' | 'BILLING_ERROR' | 'LOSS_WRITE_OFF' | 'EXPIRED_CARD' | 'EARLY_DERECOGNITION' | 'ESCHEATMENT' | 'INACTIVITY_FEE_DOWN' | 'PROVISIONAL_CREDIT' | 'DISPUTE_WON' | 'SERVICE' | 'TRANSFER' | 'COLLECTION' | 'LITHIC_PROGRAM_TRANSFER' | 'BANK_PROGRAM_TRANSFER' required

Type of the book transfer

external_idstring

External ID defined by the customer

on_closed_account'FAIL' | 'USE_SUSPENSE'

What to do if the financial account is closed when posting an operation

hold_tokenstring uuid

Token of an existing hold to settle when this transfer is initiated

Response

OK

status'PENDING' | 'SETTLED' | 'DECLINED' | 'REVERSED' | 'CANCELED' | 'RETURNED' required
tokenstring uuid required

Unique identifier for the transaction

createdstring date-time required

ISO 8601 timestamp of when the transaction was created

updatedstring date-time required

ISO 8601 timestamp of when the transaction was last updated

family'TRANSFER' required

TRANSFER - Book Transfer Transaction

result'APPROVED' | 'DECLINED' required
category'ADJUSTMENT' | 'BALANCE_OR_FUNDING' | 'DERECOGNITION' | 'DISPUTE' | 'FEE' | 'INTERNAL' | 'REWARD' | 'PROGRAM_FUNDING' | 'PROGRAM_TRANSFER' | 'TRANSFER' required
currencystring required

3-character alphabetic ISO 4217 code for the settling currency of the transaction

settled_amountinteger required

Amount of the transaction that has been settled in the currency's smallest unit (e.g., cents)

pending_amountinteger required

Pending amount of the transaction in the currency's smallest unit (e.g., cents), including any acquirer fees.

The value of this field will go to zero over time once the financial transaction is settled.

from_financial_account_tokenstring uuid required

Globally unique identifier for the financial account or card that will send the funds. Accepted type dependent on the program's use case

to_financial_account_tokenstring uuid required

Globally unique identifier for the financial account or card that will receive the funds. Accepted type dependent on the program's use case

external_idstring nullable

External ID defined by the customer

Example response

{
  "currency": "USD",
  "settled_amount": 500,
  "pending_amount": 1000,
  "transaction_series": {
    "type": "FEE",
    "related_transaction_token": "123e4567-e89b-12d3-a456-426614174000",
    "related_transaction_event_token": "123e4567-e89b-12d3-a456-426614174000"
  }
}