Create an OutboundPayment
POST / v1 / treasury / outbound_payments
Creates an OutboundPayment.
Parameters
- amount integer Required Amount (in cents) to be transferred.
- currency enum Required Three-letter ISO currency code, in lowercase. Must be a supported currency.
- financial _ account string Required The FinancialAccount to pull funds from.
- customer string ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the
destination_payment_methodpassed in. - description string An arbitrary string attached to the object. Often useful for displaying to users.
- destination _ payment _ method string The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with
destination_payment_method_data. - destination _ payment _ method _ data object Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with
destination_payment_method. - destination _ payment _ method _ options object Payment method-specific configuration for this OutboundPayment.
- end _ user _ details object End user details.
- metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata. - purpose enum Preview feature The purpose of the OutboundPayment, if applicable. This list is not exhaustive, do not specify this parameter if your purpose does not match any that are provided. Possible enum values
payroll - statement _ descriptor string The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for
achpayments, 140 characters forus_domestic_wirepayments, or 500 characters forstripenetwork transfers. Can only include -#.amp;*, spaces, and alphanumeric characters. The default value is “payment”.
Returns
Returns an OutboundPayment object if there were no issues with OutboundPayment creation.
Response
Retrieve an OutboundPayment
GET / v1 / treasury / outbound_payments /:id
Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.
Parameters
No parameters.
Returns
Returns an OutboundPayment object if a valid identifier was provided. Otherwise, returns an error.
Response
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