Outbound Payments ​
Use OutboundPayments to send funds to another party’s external bank account or FinancialAccount. To send money to an account belonging to the same user, use an OutboundTransfer.
Simulate OutboundPayment state changes with the /v1/test_helpers/treasury/outbound_payments endpoints. These methods can only be called on test mode objects.
Related guide: Moving money with Treasury using OutboundPayment objects
Endpoints ​
Create an OutboundPayment ​
- POST /v1/treasury/outbound_payments
Retrieve an OutboundPayment ​
- GET /v1/treasury/outbound_payments/:id
List all OutboundPayments ​
- GET /v1/treasury/outbound_payments
Cancel an OutboundPayment ​
- POST /v1/treasury/outbound_payments/:id/cancel
Test mode: Fail an OutboundPayment ​
- POST /v1/test_helpers/treasury/outbound_payments/:id/fail
Test mode: Post an OutboundPayment ​
- POST /v1/test_helpers/treasury/outbound_payments/:id/post
Test mode: Return an OutboundPayment ​
- POST /v1/test_helpers/treasury/outbound_payments/:id/return
Test mode: Update an OutboundPayment ​
- POST /v1/test_helpers/treasury/outbound_payments/:id