List all OutboundPayments
GET / v1 / treasury / outbound_payments
Returns a list of OutboundPayments sent from the specified FinancialAccount.
Parameters
- financial _ account string Returns objects associated with this FinancialAccount.
- created object Only return OutboundPayments that were created during the given date interval.
- customer string Only return OutboundPayments sent to this customer.
- status enum Only return OutboundPayments that have the given status:
processing,failed,posted,returned, orcanceled.
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array of up to limit OutboundPayments, starting after OutboundPayments starting_after. Each entry in the array is a separate OutboundPayments object. If no more OutboundPayments are available, the resulting array is empty.
Response
Cancel an OutboundPayment
POST / v1 / treasury / outbound_payments /:id / cancel
Cancel an OutboundPayment.
Parameters
No parameters.
Returns
Returns the OutboundPayment object if the cancellation succeeded. Returns an error if the OutboundPayment has already been canceled or cannot be canceled.
Response
Test mode: Fail an OutboundPayment Test helper
POST / v1 / test_helpers / treasury / outbound_payments /:id / fail
Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.
Parameters
No parameters.
Returns
Returns the OutboundPayment object in the failed state. Returns an error if the OutboundPayment has already been failed or cannot be failed.
Response