Sign in

v66

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

List book transfers

List book transfers

get/v1/book_transfers

Query parameters

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

Book Transfer category to be returned.

financial_account_tokenstring uuid

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

business_account_tokenstring uuid
account_tokenstring uuid
result'APPROVED' | 'DECLINED'

Book transfer result to be returned.

status'DECLINED' | 'SETTLED'

Book transfer status to be returned.

beginstring date-time

Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.

ending_beforestring

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

endstring date-time

Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.

page_sizeinteger

Page size (for pagination).

starting_afterstring

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

Response

OK

has_moreboolean required

Example response

{
  "data": [
    {
      "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"
      }
    }
  ]
}