Sign in

v66

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-042174421.1 MB
External Payments

List external payments

List external payments

get/v1/external_payments

Query parameters

category'EXTERNAL_WIRE' | 'EXTERNAL_ACH' | 'EXTERNAL_CHECK' | 'EXTERNAL_FEDNOW' | 'EXTERNAL_RTP' | 'EXTERNAL_TRANSFER'

The external rail the funds moved on

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
result'APPROVED' | 'DECLINED'

External Payment result to be returned.

status'PENDING' | 'SETTLED' | 'DECLINED' | 'REVERSED' | 'CANCELED' | 'RETURNED'

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