Store an ACH account
POST/api/v3/ach
This method can be used to store a new ACH or update an existing ACH.
To update an existing card: Send a new POST request using existing routing
and number
fields with its updated values. The stored ACH will then be updated.
Notes:
- The type field must be one of:
chec
(personal checking account),busi
(business checking account), orsavi
(savings account) - The number field should be a valid bank account number
Routing number formatting for Canadian bank accounts:
0(3-digit institution code)(5 digit transit number)
Example: 032012345
Request
- application/json
Body
customer_id integer
Customer ID #
external_key string
Unique external key value
type string
Bank account type (one of: chec, busi, savi)
number string
Bank account number
routing string
Bank account routing number
name string
Name on bank account
bank string
Bank name
Responses
- 201
- 400
- 401
Object was created successfully
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
code integer
status string
message stringnullable
details objectnullable
response
object
id integer
{
"code": 0,
"status": "string",
"message": "string",
"details": {},
"response": {
"id": 0
}
}
{
"code": 201,
"status": "OK",
"message": "",
"details": {},
"response": {
"id": 1234
}
}
Bad request
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
code integer
status string
message stringnullable
details objectnullable
response boolean
{
"code": 0,
"status": "string",
"message": "string",
"details": {},
"response": true
}
{
"code": 400,
"status": "Error",
"message": "Missing or invalid parameter.",
"details": {},
"response": false
}
Authentication error
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
code integer
status string
message stringnullable
details objectnullable
response boolean
{
"code": 0,
"status": "string",
"message": "string",
"details": {},
"response": true
}
{
"code": 401,
"status": "Error",
"message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
"details": {},
"response": false
}
Loading...