Create a bank account payment account

Creates a new payment account for bank accounts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Bank account information

string
required

The name on the bank account.

string
length between 0 and 17

Bank account number. Required unless a token is supplied.

string

A token indicating bank account information as received from a payment gateway. The account number may not be sent with it.
Please note that the following gateways require a specific format:
Authorize.net: "customer_profile_id::payment_profile_id"

string
length between 0 and 4

The last four digits of the bank account. Optional, and only allowed with a token. Recommended: some processors reject later updates to an account saved without it.

string

Email address associated with the bank account.

string

Phone number associated with the bank account.

string
length between 0 and 9

Bank routing number. Required unless a token or Canadian institution and transit numbers are supplied. Optional but recommended with a token: some processors reject later updates to an account saved without it.

string
length between 0 and 3

Canadian bank institution number.

string
length between 0 and 5

Canadian transit number.

string
enum
required

Indicates the type of bank account.

Allowed:
string

Bank name.

string

Check number.

int32
required
1 to 2147483647

Foreign identifier indicating the customer account associated with this payment method

int32
0 to 2147483647

Foreign identifier indicating the address associated with this payment method
If no address is supplied, the billing address on the customer is used

Metadata
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/html