Sign in

v4

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-04-277127123.7 KB
Account

Update current account

Updates settings for the authenticated account. Accepts all parameters from Create Account plus the ones listed here.

put/accounts/me

Request body

namestring
allow_shipping0 | 1 required

Required. Set to 1 to allow shipping on orders.

value_shippingnumber

Required when allow_shipping is 1. Shipping fee value.

fee_shippingnumber

Shipping fee amount (alternative to value_shipping).

business_phonestring

Must be a valid phone number.

business_descriptionstring

Description of the account/business.

imagestring

Base64-encoded image or URL for the account logo.

custom_domainstring

Custom domain URL.

addon_accountstring

Addon's account credential.

subaccountsinteger[]

Array of subaccount IDs associated with this account.

allowed_gatewaysstring[]

Array of allowed gateways for the account.

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.

psd2_enabled0 | 1
metadataobject

Example request

{
  "name": "My Company",
  "allow_shipping": 0,
  "business_phone": "+34666999666",
  "business_description": "Description of the business"
}

Response

Updated account

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"
}