Skip to navigation

Add bank payment method for payer

View as Markdown

Create a bank payment method for a payer (ACH Debit). Returns 201 with verification_status pending; verification continues asynchronously. Set default only after verified.

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

OR
AuthorizationBearer

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

payer_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
account_numberstringRequired<=100 characters
routing_numberstringRequired<=11 characters
routing_number_typeenumOptional

aba (US), bic (GB), or ifsc (IN)

Allowed values:
currency_codeenumOptional

USD (US), GBP (GB), or INR (IN)

Allowed values:
country_codeenumOptional
US, GB, or IN
Allowed values:

Response

Bank payment method created as pending; verification continues asynchronously

dataobject

Shared response model for bank payment methods (both payee and payer).

warningstring or nullOptional

Errors

404
Not Found Error