Create ACH wallet

Creates an ACH wallet for the selected payer and returns the created wallet.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Request

This endpoint expects an object.
payer_iddoubleRequired
payer ID identifier.
payer_typeenumRequired
payer type value.
merchant_account_iddoubleRequired
merchant account ID identifier.
wallet_descriptionstring or nullOptional
wallet description value.
activeboolean or nullOptional
active flag.
modeenum or nullOptional
mode value.
Allowed values:
client_secretstring or nullOptional
client secret value.
checkout_session_idstring or nullOptional
checkout session ID identifier.
routing_numberstring or nullOptional
routing number value.
account_numberstring or nullOptional
account number value.
account_typeenum or nullOptional
account type value.
Allowed values:
bank_namestring or nullOptional
bank name display value.
customer_billing_namestring or nullOptional
customer billing name display value.
name_on_accountstring or nullOptional
name on account display value.
customer_address_1string or nullOptional
customer address 1 value.
customer_address_2string or nullOptional
customer address 2 value.
customer_citystring or nullOptional
customer city value.
customer_statestring or nullOptional
customer state value.
customer_zipstring or nullOptional
customer zip value.
customer_countrystring or nullOptional
customer country value.
customer_phonestring or nullOptional
customer phone phone number.
customer_emailstring or nullOptional
customer email used for login, contact, or delivery flows.

Response

Successful POST response for /api/v1/wallet/create/ach.

statusstring
messagestring
dataobject