Add bank payment method
Adds a new bank account payment method for a payee. Supports pay-to-bank transfers with account and routing number details for United States and Great Britain bank accounts.
The payment method is created as pending and returns 201. Account verification runs asynchronously. Use GET payment methods or payment_method.verified / payment_method.failed webhooks to observe the terminal status. Create-time default is not applied — call set-default after verified.
Path Parameters
Request Body — bank account shapes
Send country_code, currency_code, routing_number_type, account_number, and routing_number consistent with one of the supported rows below. Internally inconsistent combinations (for example US country with an IBAN-shaped account, or GB with ABA routing) return 400 validation errors.
When country_code and currency_code are omitted
They default to US and USD; routing_number_type defaults to aba.
Great Britain notes
- IBAN must validate structurally (including check digits) and use the
GBcountry prefix for v1. - On create, verification returns
pending; use GET list/detail on payment methods or webhooks to observeverifiedorfailed.
Request Body fields
Response Body
Success Responses
Error Responses
Authentication
RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.
Short-lived session JWT from the Session Tokens API. Send as Authorization: Bearer <token>. Accepted on payment-method endpoints for a specific payee or payer; mint tokens with an API key.
Path parameters
Request
aba (US), bic (GB), or ifsc (IN)
USD (US), GBP (GB), or INR (IN)
Response
Bank payment method created as pending; verification continues asynchronously
Shared response model for bank payment methods (both payee and payer).