Skip to main content
PUT
aid_account_settings_put

Authorizations

Authorization
string
header
required

Bearer authentication (token authentication) should be used for accessing the API.

Use Get Token to get an access token for client credentials. Pass the token in the request header:

where the access_token is JSON Web Tokens (JWT).

Path Parameters

aid
string<^[PT]{1}\d{8}$>
required

An id that uniquely identifies the account.

Required string length: 9

Body

application/json
company
object

The details of an account company

billing
object

The details of the billing for the account

services
object
onboarding
object

Response

Account

applicant
object
required

The individual completing the account registration

company
object
required

The details of an account company

billing
object
required

The details of the billing for the account

id
string<uuid>
read-only

An UUID that uniquely identifies the resource

created_at
string<date-time>
read-only

The date-time when the resource was created

created_by
string
read-only

The ID of the user/client created the resource

Example:

"1c92f7e1-2897-4d46-bdcc-c127a914fb4e"

updated_at
string<date-time>
read-only

The date-time when the resource was last updated

deleted_by
string
read-only

The ID of the user/client created the resource

Example:

"1c92f7e1-2897-4d46-bdcc-c127a914fb4e"

deleted_at
string<date-time>
read-only
jwks
object
read-only

Alternative JWKS configured for validating access token issued by external authentication.

payment_case_status
enum<string>
Available options:
ACTIVE,
DECLINED,
UNDER_MANUAL_REVIEW,
AUTOMATIC_REVIEW,
WAITING_FOR_SIGNATURE,
WAITING_FOR_DECLARATION,
ERROR,
ARCHIVED,
WAITING_FOR_DETAILS,
TERMINATED
projected_sales
string
read-only

Projected sales declared by merchant.

average_transaction_value
string
read-only
merchant_category_code
string<mcc>
read-only

Merchant category code declared by merchant.

delivery_timeline
enum<string>
read-only
Available options:
P0W,
P1D,
P2D,
P5D,
P2W,
P4W,
P12W,
P1Y
most_expensive_product_price
string
read-only

Price of most expensive product declared by merchant.

gift_card_revenue_percentage
string
read-only

Percentage of revenue coming from gift card transactions declared by merchant.

credit_rating
string
read-only

The most recent credit rating of the merchant.

prev_credit_rating
string
read-only

The previous credit rating of the merchant.

currency
enum<string>
read-only

The currency of the various values declared by the merchant, such as most_expensive_product_price, average_transaction_value, and so on.

Available options:
NOK,
SEK,
DKK,
EUR
subscription
object

Subscription plan for the account

attachments
object[]
account_id
string
read-only

The id that uniquely identifies the account.

partner_id
string<^[PT]{1}(?=(?:.{3})$)[0-9]*$>
read-only

The id of the partner associated with the account

livemode
boolean
default:false

Flag indicating whether the account exists in live mode and test mode.

active
boolean
default:false
read-only

The account is active

language_code
string

The preferred language for the account as defined by BCP 47 (IETF BCP 47, "Tags for Identifying Languages").

platform_type
enum<string>
read-only

Optional type of platform for merchants using split payout.

Available options:
marketplace,
aggregator
allowed_merchant_category_codes
string[]

Restricts the MCC codes available for selection during merchant onboarding.

Pattern: ^\d{4}$
connections
object
read-only

Connections to external services registered on the merchant account

services
object
read-only

Status on services enabled on the merchant account

configuration
object

Configuration options for the account.

onboarding
object
Last modified on July 22, 2026