PaymentAccounts

Create a bank account payment account

Changed on

Creates a new payment account for bank accounts.

post/v1/PaymentAccounts/bankaccount

Request

Request body

account_namestring required

The name on the bank account.

account_numberstring

Bank account number. Required unless a token is supplied.

tokenstring

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"

last_4string

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.

emailstring

Email address associated with the bank account.

phonestring

Phone number associated with the bank account.

routing_numberstring

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.

institution_numberstring

Canadian bank institution number.

transit_numberstring

Canadian transit number.

account_type'CHECKING' | 'SAVINGS' required

Indicates the type of bank account.

bank_namestring

Bank name.

check_numberstring

Check number.

customer_idinteger required

Foreign identifier indicating the customer account associated with this payment method

address_idinteger

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

Response

Created

okboolean
idinteger

Changes

    • breaking

      request body became required

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: text/html)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: text/html)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: text/html)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: text/html)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: text/html)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: text/html)

    • info

      the request property became optional (media type: application/json)

    • info

      the request property became optional (media type: text/json)

    • info

      the request property became optional (media type: text/html)

    • info

      the request property became optional (media type: application/json)

    • info

      the request property became optional (media type: text/json)

    • info

      the request property became optional (media type: text/html)