Skip to main content

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)
Example: You have $1000 in your Coinbase USD account. You can withdraw $100 to your JPMorgan Chase bank, then later withdraw $200 to your Bank of America account. Each external bank is a separate payment method. In Sandbox, test payment methods are automatically created at the entity level based on your entity’s region and can be used with all your accounts.
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:
Test transfer flows with both active and inactive payment methods to ensure your integration properly handles success and error states before going live.

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, their paymentMethodId values, and other details:

2. Test transfer flows

Use payment methods as targets to test transfer flows.
You will need your accountId and paymentMethodId values in the next step:
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:
The transfer completes successfully, your account balance decreases, and you receive webhook events (payment.transfer.processingpayment.transfer.completed).

Failed transfer

This simulates transferring to an inactive payment method to test error handling:
The transfer fails with an error response. Use this to test how your application handles failed transfers.
For more transfer examples, see the Transfers guide.

API reference