Sign in

v66

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

Get book transfer by token

Get book transfer by token

get/v1/book_transfers/{book_transfer_token}

Path parameters

book_transfer_tokenstring uuid required

Id of the book transfer to retrieve

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"
  }
}