Create Account

Body

application/json

name

string

required

Unique business name.

Maximum string length: 255

Example:

"My Company"

slug

string

required

Unique slugged name derived from name (e.g. "My Account" → "my_account").

Example:

"my_company"

country_code

string

required

ISO 3166-1 alpha-2 country code.

Maximum string length: 2

Example:

"ES"

string<email>

required

Maximum string length: 255

Example:

"owner@mycompany.com"

password

string

required

Strong password (lower + upper case + symbol + number).

Required string length: 8 - 255

Example:

"Str0ng!Pass"

image

string

Base64-encoded image or URL for the account logo.

locale

string

Notifications will be sent in this language (e.g. es, en).

Example:

"es"

business_url

string

URL of the business.

product_description

string

Description of the product or service.

fee_percent

number

Fee applied to orders (including platform's fee).

fee_amount

number

Fixed fee applied to orders (including platform's fee).

fee_platform_percent

number

Platform fee percentage applied to orders.

fee_platform_amount

number

Fixed platform fee applied to orders.

fee_credit

number

Credit fee applied to orders (including platform's fee).

fee_shipping_1

number

Shipping fee for small-sized packages.

fee_shipping_2

number

Shipping fee for medium-sized packages.

fee_shipping_3

number

Shipping fee for large-sized packages.

default_parcel_size

string

Default parcel size.

default_fee

number

Default fee.

default_gateway

enum<string>

Default payment gateway.

Available options:

ADDON,

ADDON_V2,

ADDON_ICE,

ADDON_HPP,

ADDON_APPLE_PAY,

AZUPAY,

BANKWIRE,

WALLET,

DCP,

EPX,

REDSYS_V2,

REDSYS_APPLE_PAY,

REDSYS_AUTH,

STRIPE,

DOCOMO,

SIBS_MBWAY,

SIBS_MULTIBANCO,

SEQURA,

UNNAX,

PAYPAL,

BIZUM,

INESPAY

allowed_gateways

string[]

List of allowed gateways besides the default gateway.

template_folder

string

Template folder for the Checkout.

custom_domain

string

Custom domain URL.

allow_insurance

enum<integer>

Allow orders to have an insurance option.

Available options:

0,

1

allow_shipping

enum<integer>

Allow orders to have a shipping option.

Available options:

0,

1

allow_select_parcel

enum<integer>

Allow the seller to select the parcel size.

Available options:

0,

1

allow_receipt

enum<integer>

Allow sending a receipt when a payment is performed.

Available options:

0,

1

allow_receipt_self

enum<integer>

Allow receiving a receipt in the account email when a payment is performed.

Available options:

0,

1

billing_address

string

Company's billing address.

billing_address_line_2

string

Company's billing address line 2.

billing_city

string

billing_state

string

billing_zip

string

billing_country

string

Maximum string length: 2

vat_id

string

Company's VAT identification number.

extra_billing_information

string

Extra billing information.

legal_address

string

Company's legal address.

legal_address_line_2

string

legal_city

string

legal_state

string

legal_zip

string

legal_country

string

Maximum string length: 2

representative_name

string

Name of the company's representative.

representative_phone

string

Phone of the company's representative.

representative_email

string<email>

Email of the company's representative.

twitter_token

string

Twitter credentials to share orders.

twitter_secret

string

Twitter credentials to share orders.

facebook_id

string

Facebook credentials to share orders.

facebook_token

string

Facebook credentials to share orders.

parent_id

integer

Parent account ID. Only for subaccounts.

addon_key

string

Payment gateway credential.

addon_secret

string

Payment gateway credential.

addon_account

string

Payment gateway credential.

addon_rebate

string

Payment gateway credential.

psd2_enabled

enum<integer>

Whether the account is PSD2 enabled.

Available options:

0,

1

receipt_subject

string

Subject of the email sent to the customer (selected pricing plans only).

receipt_message

string

Message of the email sent to the customer (selected pricing plans only).

payment_success_message

string

Message shown to customers on successful payment (selected pricing plans only).

Response

Account created

self

string

Example:

"/2.0/accounts/me"

merchant_id

string

Unique merchant identifier (addon_key).

name

string

Example:

"My Company"

string<email>

currency

string

Example:

"EUR"

country_code

string

Example:

"ES"

business_url

string | null

business_phone

string | null

business_description

string | null

image_url

string | null

public_key

string

secret_key

string

Secret API key. Only visible to the account owner.

allow_shipping

enum<integer>

Available options:

0,

1

value_shipping

number

is_active

boolean

psd2_enabled

enum<integer>

Available options:

0,

1

allowed_gateways

string[]

gateways

object[] | null

List of configured payment gateway objects for the account.

default_gateway

string | null

created_at

string<date-time> | null

API Reference

Body

Response