PaymentDetails#Validate

Validate a Payment Detail

This endpoint can determine whether the provided payment detail will pass regex checks.

NB: It does not guarantee it will be accepted by our payment partners. Nor does it guarantee it will be the recipients intended account.

Example Request

curl https://{{base_url}}/users/USER_ID/payment_details/validate
-X POST \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-type: application/json" \
-d '{
    "payment_detail": {
        "bank_name": "Chase",
        "account_name": "Gordon's Chase Business Account",
        "account_number": "253009233489",
        "routing_number": "026013356",
        "beneficiary_type": "business",
        "company_number": "12-3456789",
        "currency": "usd",
        "address_line1": "24 Theatre St.",
        "city": "Paramount",
        "state": "CA",
        "country": "US",
        "postal_code": "90723",
        "rails": null
    }
}'

Endpoint Information

Validate Payment Detail Parameters

POST https://{{base_url}}/users/:user_id/payment_details/validate

Path Parameters

Name
Type
Description

user_id*

UUID

ID of the User which the Payment Detail belongs to.

Request Body

Name
Type
Description

account_name

String

A name to identify the bank account, e.g. 'Chris's Revolut'.

account_number

String

currency

String

The currency that the bank account accepts. E.g. 'usd', 'eur'.

address_line1

String

The first line of the address of the person or organisation that controls the bank account.

address_line2

String

The second line of the address of the person or organisation that controls the bank account.

city

String

The city where the person or organisation that controls the bank account is located.

state

String

The state/district where the person or organisation that controls the bank account is located.

postal_code

String

The postal/zip code where the person or organisation that controls the bank account is located.

country

String

The country where the person or organisation that controls the bank account is located. Given in ISO 3166-1 alpha-2 format.

beneficiary_type

String

individual or business

routing_number

String

bank_name

String

The name of the bank associated with the account. e.g. 'Revolut'

sort_code

String

iban

String

swift_bic

String

document_number

String

account_type

String

rib_number

String

purpose_of_transfer

String

purpose_of_payment_code

String

bsb_number

String

rails

String

{
    "payment_detail": {
        "valid": true,
        "errors": []
    }
}

Last updated