increase-test
PATCH/account_numbers/{account_number_id}

Update an Account Number

Updates an Account Number's name, status, or inbound payment settings. Supply only the properties you want to change; status and inbound ACH debit settings must use their accepted values.

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

1 parameter · 4 body fields
account_number_idstringrequired
The identifier of the Account Number to update.

Properties to update on the Account Number; all fields are optional.

inbound_achobjectoptional
Options related to how this Account Number handles inbound ACH transfers.
inbound_checksobjectoptional
Options related to how this Account Number should handle inbound check withdrawals.
namestringoptional
The name you choose for the Account Number.
statusstringoptional
This indicates if transfers can be made to the Account Number.
Allowed:activedisabledcanceled

3 status codes
200Returns the updated Account Number, including its current name, 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

The account_number_id path parameter must identify the Account Number to update. name must be 1 to 200 characters, status must be active, disabled, or canceled, and supplied inbound settings must use their accepted values.