increase-test
POST/account_numbers

Create an Account Number

Creates an Account Number belonging to a specified Account. Supply account_id and a name; you can also configure how the Account Number handles inbound ACH transfers and checks.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

Account Number details, including its owning Account and optional inbound payment settings.

account_idstringrequired
The Account the Account Number should belong to.
inbound_achobjectoptional
Options related to how this Account Number should handle inbound ACH transfers.
inbound_checksobjectoptional
Options related to how this Account Number should handle inbound check withdrawals.
namestringrequired
The name you choose for the Account Number.

3 status codes
200Returns the created Account Number, including its identifier, account and routing numbers, status, and inbound payment settings.
account_idstringrequired
The identifier for the account this Account Number belongs to.
account_numberstringrequired
The account number.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account Number was created.
idstringrequired
The Account Number identifier.
idempotency_keystringrequired
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
inbound_achobjectrequired
Properties related to how this Account Number handles inbound ACH transfers.
inbound_checksobjectrequired
Properties related to how this Account Number should handle inbound check withdrawals.
namestringrequired
The name you choose for the Account Number.
routing_numberstringrequired
The American Bankers' Association (ABA) Routing Transit Number (RTN).
statusstringrequired
This indicates if payments can be made to the Account Number.
Allowed:activedisabledcanceled
typestringrequired
A constant representing the object's type. For this resource it will always be `account_number`.
Allowed:account_number
4XXReturned when the request encounters a client error.
5XXReturned when the service encounters a server error.

Error handling

account_id and name are required, and name must be 1 to 200 characters. If you include inbound_ach, it must contain debit_status set to allowed or blocked; if you include inbound_checks, it must contain status set to allowed or check_transfers_only.