Sign in
Account

Create account

Registers a new merchant account and its associated manager.

post/accounts

Request body

namestring required

Unique business name.

slugstring required

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

country_codestring required

ISO 3166-1 alpha-2 country code.

emailstring email required
passwordstring required

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

imagestring

Base64-encoded image or URL for the account logo.

localestring

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

business_urlstring

URL of the business.

product_descriptionstring

Description of the product or service.

fee_percentnumber

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

fee_amountnumber

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

fee_platform_percentnumber

Platform fee percentage applied to orders.

fee_platform_amountnumber

Fixed platform fee applied to orders.

fee_creditnumber

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

fee_shipping_1number

Shipping fee for small-sized packages.

fee_shipping_2number

Shipping fee for medium-sized packages.

fee_shipping_3number

Shipping fee for large-sized packages.

default_parcel_sizestring

Default parcel size.

default_feenumber

Default fee.

default_gateway'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'

Default payment gateway.

allowed_gatewaysstring[]

List of allowed gateways besides the default gateway.

template_folderstring

Template folder for the Checkout.

custom_domainstring

Custom domain URL.

allow_insurance0 | 1

Allow orders to have an insurance option.

allow_shipping0 | 1

Allow orders to have a shipping option.

allow_select_parcel0 | 1

Allow the seller to select the parcel size.

allow_receipt0 | 1

Allow sending a receipt when a payment is performed.

allow_receipt_self0 | 1

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

billing_addressstring

Company's billing address.

billing_address_line_2string

Company's billing address line 2.

billing_citystring
billing_statestring
billing_zipstring
billing_countrystring
vat_idstring

Company's VAT identification number.

extra_billing_informationstring

Extra billing information.

legal_addressstring

Company's legal address.

legal_address_line_2string
legal_citystring
legal_statestring
legal_zipstring
legal_countrystring
representative_namestring

Name of the company's representative.

representative_phonestring

Phone of the company's representative.

representative_emailstring email

Email of the company's representative.

twitter_tokenstring

Twitter credentials to share orders.

twitter_secretstring

Twitter credentials to share orders.

facebook_idstring

Facebook credentials to share orders.

facebook_tokenstring

Facebook credentials to share orders.

parent_idinteger

Parent account ID. Only for subaccounts.

addon_keystring

Payment gateway credential.

addon_secretstring

Payment gateway credential.

addon_accountstring

Payment gateway credential.

addon_rebatestring

Payment gateway credential.

psd2_enabled0 | 1

Whether the account is PSD2 enabled.

receipt_subjectstring

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

receipt_messagestring

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

payment_success_messagestring

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

Example request

{
  "name": "My Company",
  "slug": "my_company",
  "country_code": "ES",
  "email": "owner@mycompany.com",
  "password": "Str0ng!Pass",
  "locale": "es"
}

Response

Account created

selfstring
merchant_idstring

Unique merchant identifier (addon_key).

namestring
emailstring email
currencystring
country_codestring
business_urlstring nullable
business_phonestring nullable
business_descriptionstring nullable
image_urlstring nullable
public_keystring
secret_keystring

Secret API key. Only visible to the account owner.

allow_shipping0 | 1
value_shippingnumber
is_activeboolean
psd2_enabled0 | 1
allowed_gatewaysstring[]
gatewaysobject[] nullable

List of configured payment gateway objects for the account.

default_gatewaystring nullable
created_atstring date-time nullable

Example response

{
  "self": "/2.0/accounts/me",
  "name": "My Company",
  "currency": "EUR",
  "country_code": "ES"
}

Changes

Changed in 1 of the 4 revisions of this API.1153

  • ff825f6602c81153See the full diff
    • ▲

      added the new required request property slug

      new-required-request-property

    • ●

      the country_code request property's maxLength was set to 2

      request-property-max-length-set

    • ○

      added the new optional request property addon_account

      new-optional-request-property

    • ○

      added the new optional request property addon_key

      new-optional-request-property

    • ○

      added the new optional request property addon_rebate

      new-optional-request-property

    • ○

      added the new optional request property addon_secret

      new-optional-request-property

    • ○

      added the new optional request property allow_insurance

      new-optional-request-property

    • ○

      added the new optional request property allow_receipt

      new-optional-request-property

    • ○

      added the new optional request property allow_receipt_self

      new-optional-request-property

    • ○

      added the new optional request property allow_select_parcel

      new-optional-request-property

    • ○

      added the new optional request property allow_shipping

      new-optional-request-property

    • ○

      added the new optional request property allowed_gateways

      new-optional-request-property

    • ○

      added the new optional request property billing_address

      new-optional-request-property

    • ○

      added the new optional request property billing_address_line_2

      new-optional-request-property

    • ○

      added the new optional request property billing_city

      new-optional-request-property

    • ○

      added the new optional request property billing_country

      new-optional-request-property

    • ○

      added the new optional request property billing_state

      new-optional-request-property

    • ○

      added the new optional request property billing_zip

      new-optional-request-property

    • ○

      added the new optional request property business_url

      new-optional-request-property

    • ○

      added the new optional request property custom_domain

      new-optional-request-property

    • ○

      added the new optional request property default_fee

      new-optional-request-property

    • ○

      added the new optional request property default_gateway

      new-optional-request-property

    • ○

      added the new optional request property default_parcel_size

      new-optional-request-property

    • ○

      added the new optional request property extra_billing_information

      new-optional-request-property

    • ○

      added the new optional request property facebook_id

      new-optional-request-property

    • ○

      added the new optional request property facebook_token

      new-optional-request-property

    • ○

      added the new optional request property fee_amount

      new-optional-request-property

    • ○

      added the new optional request property fee_credit

      new-optional-request-property

    • ○

      added the new optional request property fee_percent

      new-optional-request-property

    • ○

      added the new optional request property fee_platform_amount

      new-optional-request-property

    • ○

      added the new optional request property fee_platform_percent

      new-optional-request-property

    • ○

      added the new optional request property fee_shipping_1

      new-optional-request-property

    • ○

      added the new optional request property fee_shipping_2

      new-optional-request-property

    • ○

      added the new optional request property fee_shipping_3

      new-optional-request-property

    • ○

      added the new optional request property image

      new-optional-request-property

    • ○

      added the new optional request property legal_address

      new-optional-request-property

    • ○

      added the new optional request property legal_address_line_2

      new-optional-request-property

    • ○

      added the new optional request property legal_city

      new-optional-request-property

    • ○

      added the new optional request property legal_country

      new-optional-request-property

    • ○

      added the new optional request property legal_state

      new-optional-request-property

    • ○

      added the new optional request property legal_zip

      new-optional-request-property

    • ○

      added the new optional request property parent_id

      new-optional-request-property

    • ○

      added the new optional request property payment_success_message

      new-optional-request-property

    • ○

      added the new optional request property product_description

      new-optional-request-property

    • ○

      added the new optional request property psd2_enabled

      new-optional-request-property

    • ○

      added the new optional request property receipt_message

      new-optional-request-property

    • ○

      added the new optional request property receipt_subject

      new-optional-request-property

    • ○

      added the new optional request property representative_email

      new-optional-request-property

    • ○

      added the new optional request property representative_name

      new-optional-request-property

    • ○

      added the new optional request property representative_phone

      new-optional-request-property

    • ○

      added the new optional request property template_folder

      new-optional-request-property

    • ○

      added the new optional request property twitter_secret

      new-optional-request-property

    • ○

      added the new optional request property twitter_token

      new-optional-request-property

    • ○

      added the new optional request property vat_id

      new-optional-request-property

    • ○

      added the optional property gateways to the response with the 200 status

      response-optional-property-added