Add bank payment method for payer

curl -X POST https://api.useroot.com/api/payers/payer_id/payment-methods/pay-by-bank \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "account_number": "1234567890",
  "routing_number": "021000021",
  "routing_number_type": "aba",
  "currency_code": "USD",
  "country_code": "US"
}'

{
  "data": {
    "created_at": "2024-03-20T12:00:00Z",
    "updated_at": "2024-03-20T12:00:00Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "account_last_four": "7890",
    "routing_number": "021000021",
    "currency_code": "USD",
    "country_code": "US",
    "verification_status": "verified",
    "is_default": true,
    "supported_rails": [
      "same_day_ach",
      "standard_ach"
    ],
    "payer_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Create a new bank payment method for a payer. This enables ACH Debit (pay by bank) functionality for payins.

Authentication

x-api-keystring

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

Path parameters

payer_idstringRequiredformat: "uuid"

Query parameters

is_defaultbooleanOptionalDefaults to true

Whether to set this payment method as default

Request

This endpoint expects an object.

account_numberstringRequired<=100 characters

routing_numberstringRequired<=11 characters

routing_number_typeenumOptional

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

currency_codeenumOptional

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

country_codeenumOptional

US, GB, or IN

Response

Bank payment method created successfully

dataobject

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

warningstring or null

Errors

404

Not Found Error