GET
/v1/treasury/outbound_paymentsList outbound payments
Lists OutboundPayments sent from a specified FinancialAccount. Use financial_account to scope the results, apply filters such as status or created, and use cursor parameters to paginate the list.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
createdobjectoptional
Filter OutboundPayments by their creation date or date interval.
customerstringoptional
Return only OutboundPayments sent to this customer. Maximum 5000 characters.
ending_beforestringoptional
Pagination cursor identifying the first object on the preceding page. Maximum 5000 characters.
expandarray<string>optional
Response fields to expand; each value can contain up to 5000 characters.
financial_accountstringrequired
FinancialAccount associated with the OutboundPayments to return.
limitintegeroptional
Maximum number of objects to return. Must be between 1 and 100; defaults to 10 when omitted.
starting_afterstringoptional
Pagination cursor identifying the last object on the preceding page. Maximum 5000 characters.
statusstringoptional
Filter by payment status: canceled, failed, posted, processing, or returned.
200Returns a paginated list object containing OutboundPayment records, a `has_more` indicator, the list object type, and the list URL.
dataarray<OutboundPayment>required
Details about each object.
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired
Error handling
financial_account identifies the FinancialAccount whose payments you want to list. status must be one of canceled, failed, posted, processing, or returned, and limit must be between 1 and 100 when supplied.