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.
{ "id": "obp_1MtaD72eZvKYlo2Cu5d5S1kX", "object": "treasury.outbound_payment", "amount": 10000, "cancelable": false, "created": 1680716009, "currency": "usd", "customer": "cus_4QFOF3xrvBT2nU", "description": "OutboundPayment to a 3rd party", "destination_payment_method": "pm_1MtaD82eZvKYlo2CtGr4OxTt", "destination_payment_method_details": { "type": "us_bank_account", "destination": "ba_1MtaD62eZvKYlo2C8vwjm7bc" }, "end_user_details": { "ip_address": null, "present": false }, "expected_arrival_date": 1680716009, "financial_account": "fa_1MtaD72eZvKYlo2CYKM3DnUI", "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKOrhtqEGMgYgdA-GrKk6NZNsf-FXPEqqbHm44fwJ57pNybbkweviYUDJGYFOw4f9cAqpfvPKQZ6y0S2C5DYyRwmDs_36", "livemode": false, "metadata": {}, "returned_details": null, "statement_descriptor": "payment", "status": "processing", "status_transitions": { "canceled_at": null, "failed_at": null, "posted_at": null, "returned_at": null }, "transaction": "trxn_1MtaD72eZvKYlo2CmUu4Vs5c"}
Returns a list of OutboundPayments sent from the specified FinancialAccount.
Parameters
- financial_
accountstringRequired Returns objects associated with this FinancialAccount.
- createdobject
Only return OutboundPayments that were created during the given date interval.
- customerstring
Only return OutboundPayments sent to this customer.
- statusenum
Only return OutboundPayments that have the given status:
processing
,failed
,posted
,returned
, orcanceled
.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
OutboundPayments, starting after OutboundPayments starting_
. Each entry in the array is a separate OutboundPayments object. If no more OutboundPayments are available, the resulting array is empty.
{ "object": "list", "url": "/v1/treasury/outbound_payments", "has_more": false, "data": [ { "id": "obp_1MtaD72eZvKYlo2Cu5d5S1kX", "object": "treasury.outbound_payment", "amount": 10000, "cancelable": false, "created": 1680716009, "currency": "usd", "customer": "cus_4QFOF3xrvBT2nU", "description": "OutboundPayment to a 3rd party", "destination_payment_method": "pm_1MtaD82eZvKYlo2CtGr4OxTt", "destination_payment_method_details": { "type": "us_bank_account", "destination": "ba_1MtaD62eZvKYlo2C8vwjm7bc" }, "end_user_details": { "ip_address": null, "present": false }, "expected_arrival_date": 1680716009, "financial_account": "fa_1MtaD72eZvKYlo2CYKM3DnUI", "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKOrhtqEGMgYgdA-GrKk6NZNsf-FXPEqqbHm44fwJ57pNybbkweviYUDJGYFOw4f9cAqpfvPKQZ6y0S2C5DYyRwmDs_36", "livemode": false, "metadata": {}, "returned_details": null, "statement_descriptor": "payment", "status": "processing", "status_transitions": { "canceled_at": null, "failed_at": null, "posted_at": null, "returned_at": null }, "transaction": "trxn_1MtaD72eZvKYlo2CmUu4Vs5c" } {...} {...} ],}
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.
{ "id": "obp_1MtaD72eZvKYlo2Cu5d5S1kX", "object": "treasury.outbound_payment", "amount": 10000, "cancelable": false, "created": 1680716009, "currency": "usd", "customer": null, "description": "OutboundPayment to a 3rd party", "destination_payment_method": null, "destination_payment_method_details": { "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": null }, "financial_account": { "id": "fa_1LpyM72eZvKYlo2CiUmr2kuV", "network": "stripe" }, "type": "financial_account" }, "end_user_details": { "ip_address": null, "present": false }, "expected_arrival_date": 1680716009, "financial_account": "fa_1MtaD72eZvKYlo2CYKM3DnUI", "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKOrhtqEGMgakyczTzCY6NZMi6lMnZXTYms--WBYQzUXzaEJ_JwErEK5FXXW8F9Qy7fEzKvsHEOzyjS9AtIuK8sUjgWdU", "livemode": false, "metadata": {}, "returned_details": null, "statement_descriptor": "payment", "status": "canceled", "status_transitions": { "posted_at": null, "failed_at": null, "canceled_at": 1680716010, "returned_at": null }, "transaction": "trxn_1MtaD72eZvKYlo2CmUu4Vs5c"}
Test mode: Fail an OutboundPaymentTest helper
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.
{ "id": "obp_1MtaD72eZvKYlo2C36lgqC6Y", "object": "treasury.outbound_payment", "amount": 10000, "cancelable": false, "created": 1680716009, "currency": "usd", "customer": null, "description": "OutboundPayment to a 3rd party", "destination_payment_method": null, "destination_payment_method_details": { "type": "us_bank_account", "destination": "ba_1MtaD62eZvKYlo2C8vwjm7bc" }, "end_user_details": { "ip_address": null, "present": false }, "expected_arrival_date": 1680716009, "financial_account": "fa_1MtaD72eZvKYlo2CYKM3DnUI", "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKOrhtqEGMgbuLATJtPw6NZOxERTeGKynM40SUCL6A1sqeZF9vkrX4q4M0rI4eY7EhfkOVvyileEuRReLgXE2crXLg7sd", "livemode": false, "metadata": {}, "returned_details": null, "statement_descriptor": "payment", "status": "failed", "status_transitions": { "failed_at": 1680716010, "posted_at": null, "returned_at": null, "canceled_at": null }, "transaction": "trxn_1MtaD72eZvKYlo2CmUu4Vs5c"}
Test mode: Post an OutboundPaymentTest helper
Transitions a test mode created OutboundPayment to the posted
status. The OutboundPayment must already be in the processing
state.
Parameters
No parameters.
Returns
Returns the OutboundPayment object in the posted state. Returns an error if the OutboundPayment has already been posted or cannot be posted.
{ "id": "obp_1MtaD72eZvKYlo2C36lgqC6Y", "object": "treasury.outbound_payment", "amount": 10000, "cancelable": false, "created": 1680716009, "currency": "usd", "customer": null, "description": "OutboundPayment to a 3rd party", "destination_payment_method": null, "destination_payment_method_details": { "type": "us_bank_account", "destination": "ba_1MtaD62eZvKYlo2C8vwjm7bc" }, "end_user_details": { "ip_address": null, "present": false }, "expected_arrival_date": 1680716009, "financial_account": "fa_1MtaD72eZvKYlo2CYKM3DnUI", "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKOrhtqEGMgawWNwbI_w6NZNOI4y6vNpfIP-oQAT5mkBRbOHJN1f08r7jF-UumeywdupuJr7P2cxF8L5JRSVPMmttq_kA", "livemode": false, "metadata": {}, "returned_details": null, "statement_descriptor": "payment", "status": "posted", "status_transitions": { "failed_at": null, "posted_at": 1680716010, "returned_at": null, "canceled_at": null }, "transaction": "trxn_1MtaD72eZvKYlo2CmUu4Vs5c"}