Update an account

post

https://sandbox-api.coris.ai/api/v0_2/accounts/{account_id}/

Changes details on an account and returns the updated account, so the change is complete when the response arrives. Use it to correct merchant details or profile fields such as average_ticket, but not reference_id. A change can start a monitoring run, which can update the account later, and no webhook event reports the update itself.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

string

required

The account's Coris ID or your reference_id. Example: your_id_1.

Body Params

Account Update Request

The fields to change. Omitted fields stay as they are, and null clears a stored merchant profile field.

business_name

string

The legal name of the business. Example: Acme Plumbing Co.

business_description

string

A free-text description of the business. Example: Plumbing contractor in San Jose, CA.

name

string

The display name of the account. Example: Acme Plumbing.

dba_name

string

The doing business as (DBA) name, which Coris also uses as the display name.

first_name

string

The first name of the authorized representative. Example: Alex.

last_name

string

The last name of the authorized representative. Example: Rivera.

address

object

The primary address of the business.

phone

string

The phone number on the account. Example: 408 555 0134.

website

string

The primary website, as a full URL. Example: https://www.acmeplumbing.example.

string

The email address on the account. Example: [email protected].

boarded_iso

string

The ISO that boarded this merchant. Example: Acme ISO.

sponsor_bank

string

The sponsor bank for this merchant. Example: Acme Sponsor Bank.

average_ticket

integer | null

≥ 0

The average transaction amount, in cents, as a whole number of 0 or more. Send null to clear it.

high_ticket

integer | null

≥ 0

The highest expected transaction amount, in cents, as a whole number of 0 or more. Send null to clear it.

average_monthly_volume

integer | null

≥ 0

The average monthly volume, in cents, as a whole number of 0 or more. Send null to clear it.

card_present_percentage

number | null

0 to 100

The percentage of transactions with the card present, from 0 to 100, which need not total 100 with card_not_present_percentage. Send null to clear it.

card_not_present_percentage

number | null

0 to 100

The percentage of transactions without the card present, from 0 to 100, which need not total 100 with card_present_percentage. Send null to clear it.

card_descriptor

string | null

The text on cardholder statements, 1 to 256 characters. Send null to clear it.

merchant_id

string | null

Your merchant ID, 1 to 256 characters. Send null to clear it.

mcc_code

string | null

The Merchant Category Code, 1 to 256 characters. Send null to clear it.

mcc_description

string | null

The description of the Merchant Category Code, 1 to 256 characters. Send null to clear it.

Headers

X-Coris-Expand-Objects

string

Send this header with any string value if you want nested objects in full.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

A field is missing or invalid. Read the response body, fix the field and resend.

422

The fields do not fit together. Read the plain-text body and fix them.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

200The account was updated.

401The key is missing, or it is wrong for this host. Send Authorization: Token YOUR_API_KEY with a key issued for this environment.

403Your API key cannot set boarded_iso to this value. Send a value your key allows.

404No item has this ID in your workspace. Check the ID and the environment.

429You passed a rate limit. If Retry-After is present, wait that many seconds, then retry. If it is absent, you hit the concurrency limit, so back off for a few seconds and reduce parallel calls.

500Coris could not complete the request. Retry with backoff. If it continues, contact support.