v1

latestOpenAPI 3.1.12026-07-2452287575.4 KB
Payment Methods

Validate a Payment Method

Validate a new PaymentMethod before attaching it to a Company. Please note that only bank PaymentMethods can be validated at this time.

When testing in the Routable Sandbox, you can deterministically control the results you wish to receive for each check based on the values of the last two digits of the account_number:

The last digit is the desired verification result, second to last is the desired ownership result.

Pass the following number in a check's digit to get the result you want: 1: match 2: mismatch 3: no_data 4: unable_to_verify 5-9 and 0: result undefined

post/v1/companies/{company_id}/payment-methods/validate

Path parameters

company_idstring uuid required
Example:8c581d79-bb84-4bc1-b1c5-8c073264a569

The Company ID.

Request body

type'bank' required

The type of payment method.

is_primaryboolean

Whether this company account is marked as the primary account for a Company.

Response

OK

idstring uuid

The PaymentMethod Validation Inquiry ID.