Skip to main content
PUT

Authorizations

Authorization
string
header
required

Format: admin-api-key=<admin-api-key>

Admin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account. This is only used during development.

Path Parameters

id
string
required

The unique identifier for the merchant account

Body

application/json
merchant_name
string | null

Name of the Merchant Account

Example:

"NewAge Retailer"

merchant_details
object | null
metadata
object | null

Metadata is useful for storing additional, unstructured information on an object.

Response

Merchant Account Updated

id
string
required

The identifier for the Merchant Account

Maximum string length: 64
Example:

"y3oqhf46pyzuxjbcn2giaqnb44"

merchant_name
string
required

Name of the Merchant Account

Example:

"NewAge Retailer"

publishable_key
string
required

API key that will be used for server side API access

Example:

"AH3423bkjbkjdsfbkj"

organization_id
string
required

The id of the organization which the merchant is associated with

Required string length: 1 - 64
Example:

"org_q98uSGAYbjEwqs0mJwnz"

recon_status
enum<string>
required
Available options:
not_requested,
requested,
active,
disabled
merchant_details
object | null
metadata
object | null

Metadata is useful for storing additional, unstructured information on an object.

product_type
enum<string> | null
Available options:
orchestration,
vault,
recon,
recovery,
cost_observability,
dynamic_routing