Overview
Payment methods represent external financial instruments (like bank accounts via Fedwire, SWIFT, and SEPA) that you can use to move money. They are entity-level and you can use them with any of your accounts. Key differences:- Accounts hold assets and balances (e.g., your USD account)
- Payment methods are external destinations (e.g., your JPMorgan Chase bank account)
Currently, payment methods are only supported as targets for transfers (withdrawals from your account to a bank).
Pre-configured payment methods
Test payment methods are automatically created in your Sandbox environment based on your entity’s region:US entities
EU entities
Prerequisites
Complete the Quickstart before proceeding if you do not yet have Sandbox API keys or a funded account. Ensure you have set your API key as an environment variable:1. List payment methods
See your available test methods, theirpaymentMethodId values, and other details:
Example response
Example response
2. Test transfer flows
Use payment methods as targets to test transfer flows. Set your IDs as environment variables:The escaped quotes (
\") in the following commands are required for bash variable substitution in JSON.Successful transfer
This simulates transferring from your Sandbox account to an active payment method:payment.transfer.processing → payment.transfer.completed).
Example response
Example response
Failed transfer
This simulates transferring to an inactive payment method to test error handling:Example error response
Example error response