Sign in
latestOpenAPI 3.0.12026-08-1072354.9 KB

f44b7c6e47a6

Account opening

Create an account opening request

Creates an account opening request for a specific customer. See the account opening guide for more information about this process and its associated stages.

post/v1/accounts/opening_requests

Request body

customer_idstring required

The ID (e.g., person_id or business_id) of the customer for whom you're opening the account.

customer_type'Person' | 'Business' required

The type of customer for whom you're opening an account. Use Person for B2C and Freelancer customers and Business for B2B customers.

product_name'CURRENT_ACCOUNT_BUSINESS_FRANCE' | 'CURRENT_ACCOUNT_BUSINESS_GERMANY' | 'CURRENT_ACCOUNT_BUSINESS_ITALY' | 'CURRENT_ACCOUNT_BUSINESS_SPAIN' | 'CURRENT_ACCOUNT_CONSUMER_FRANCE' | 'CURRENT_ACCOUNT_CONSUMER_GERMANY' | 'CURRENT_ACCOUNT_CONSUMER_ITALY' | 'CURRENT_ACCOUNT_CONSUMER_SPAIN' | 'CURRENT_ACCOUNT_FREELANCER_FRANCE' | 'CURRENT_ACCOUNT_FREELANCER_GERMANY' | 'CURRENT_ACCOUNT_FREELANCER_ITALY' | 'CURRENT_ACCOUNT_FREELANCER_SPAIN' | 'CUSTOMER_CARD_SETTLEMENT' | 'DECOUPLED_CARD_CONSUMER_GERMANY' | 'EMONEY_ACCOUNT_BUSINESS_GERMANY' | 'EMONEY_ACCOUNT_CONSUMER_GERMANY' | 'EMONEY_ACCOUNT_FREELANCER_GERMANY' | 'RESTRICTED_ACCOUNT_BUSINESS_GERMANY' | 'RESTRICTED_ACCOUNT_CONSUMER_GERMANY' | 'RESTRICTED_ACCOUNT_CONSUMER_ITALY' | 'SAVINGS_ACCOUNT_CONSUMER_FRANCE' | 'SAVINGS_ACCOUNT_BUSINESS_FRANCE' | 'SAVINGS_ACCOUNT_FREELANCER_FRANCE' | 'SAVINGS_ACCOUNT_CONSUMER_GERMANY' | 'SAVINGS_ACCOUNT_BUSINESS_GERMANY' | 'SAVINGS_ACCOUNT_FREELANCER_GERMANY' | 'SAVINGS_ACCOUNT_CONSUMER_ITALY' | 'SAVINGS_ACCOUNT_BUSINESS_ITALY' | 'SAVINGS_ACCOUNT_FREELANCER_ITALY' | 'SAVINGS_ACCOUNT_CONSUMER_SPAIN' | 'SAVINGS_ACCOUNT_BUSINESS_SPAIN' | 'SAVINGS_ACCOUNT_FREELANCER_SPAIN' | 'SAVINGS_ACCOUNT_EXTERNAL_REFERENCE_CONSUMER_GERMANY' | 'SOFT_CURRENCY_ACCOUNT' | 'SUBACCOUNT_CONSUMER_FRANCE' | 'SUBACCOUNT_CONSUMER_GERMANY' | 'SUBACCOUNT_CONSUMER_ITALY' | 'SUBACCOUNT_CONSUMER_SPAIN' | 'SUBACCOUNT_BUSINESS_FRANCE' | 'SUBACCOUNT_BUSINESS_GERMANY' | 'SUBACCOUNT_BUSINESS_ITALY' | 'SUBACCOUNT_BUSINESS_SPAIN' | 'SUBACCOUNT_FREELANCER_FRANCE' | 'SUBACCOUNT_FREELANCER_GERMANY' | 'SUBACCOUNT_FREELANCER_ITALY' | 'SUBACCOUNT_FREELANCER_SPAIN' required

The product name for which you want to open an account. Check the account opening guide for more information about this field.

account_type'CALL_MONEY' | 'CARD_SETTLEMENT_PARTNER' | 'CHECKING_BUSINESS' | 'CHECKING_PERSONAL' | 'CHECKING_PERSONAL_OVERDRAFT' | 'CHECKING_SOLE_PROPRIETOR' | 'CHECKING_SUBACCOUNT' | 'CUSTOMER_CURRENCY_ACCOUNT' | 'DECOUPLED_CARD_BUSINESS' | 'DECOUPLED_CARD_PERSONAL' | 'EMONEY_PARKING' | 'EMONEY_PREPAID' | 'SAVINGS_BUSINESS' | 'SAVINGS_PERSONAL' | 'SAVINGS_PERSONAL_EXTERNAL_REFERENCE' | 'SAVINGS_SOLE_PROPRIETOR' | 'WALLET_BUSINESS' | 'WALLET_INSTITUTIONAL' | 'WALLET_LIQUIDITY_PROVIDER' | 'WALLET_PERSONAL' | 'WALLET_PERSONAL_PAYMENT_ACC' required

The type of account you want to open. Must correspond to the product_name and customer_type. Check the account opening guide for more information about this field.

account_purposestring

The purpose of the account. Use primary unless otherwise instructed.

account_bic'SOBKDEBBXXX' | 'SOBKDEB2XXX' | 'SOBKITM2XXX' | 'SOBKFRP2XXX' | 'SOBKESM2XXX' required

The BIC to apply to the account. Choose the BIC that corresponds with the branch in which you want to open the account.

account_currency'CAD' | 'CHF' | 'CNY' | 'DKK' | 'EUR' | 'GBP' | 'HKD' | 'JPY' | 'NOK' | 'SEK' | 'SGD' | 'USD' | 'AED' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BTN' | 'BZD' | 'CLP' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DOP' | 'DZD' | 'ETB' | 'FJD' | 'GEL' | 'GTQ' | 'GYD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'JMD' | 'JOD' | 'KES' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LKR' | 'LRD' | 'LSL' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NPR' | 'NZD' | 'OMR' | 'PEN' | 'PGK' | 'PHP' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SCR' | 'SLL' | 'SRD' | 'STN' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TRY' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'XPF' | 'ZAR' | 'ZMW' | 'EMONEY_EUR' required

The currency of the account.

Example request

{
  "customer_id": "b109ee6f66d2a061e006bd31c6455df2cper",
  "customer_type": "Person",
  "product_name": "CURRENT_ACCOUNT_CONSUMER_GERMANY",
  "account_type": "CHECKING_PERSONAL",
  "account_purpose": "primary",
  "account_bic": "SOBKDEB2XXX",
  "account_currency": "EUR"
}

Response

The account opening request was successfully initiated.

idstring

The ID of the account opening request.

customer_idstring

The ID (e.g., person_id or business_id) of the customer for whom you're opening the account.

customer_type'Person' | 'Business'

The type of customer for whom you're opening an account. Use Person for B2C and Freelancer customers and Business for B2B customers.

status'INITIATED' | 'IN_PROGRESS' | 'COMPLETED' | 'REJECTED'

The status of the account opening request.

product_name'CURRENT_ACCOUNT_BUSINESS_FRANCE' | 'CURRENT_ACCOUNT_BUSINESS_GERMANY' | 'CURRENT_ACCOUNT_BUSINESS_ITALY' | 'CURRENT_ACCOUNT_BUSINESS_SPAIN' | 'CURRENT_ACCOUNT_CONSUMER_FRANCE' | 'CURRENT_ACCOUNT_CONSUMER_GERMANY' | 'CURRENT_ACCOUNT_CONSUMER_ITALY' | 'CURRENT_ACCOUNT_CONSUMER_SPAIN' | 'CURRENT_ACCOUNT_FREELANCER_FRANCE' | 'CURRENT_ACCOUNT_FREELANCER_GERMANY' | 'CURRENT_ACCOUNT_FREELANCER_ITALY' | 'CURRENT_ACCOUNT_FREELANCER_SPAIN' | 'CUSTOMER_CARD_SETTLEMENT' | 'DECOUPLED_CARD_CONSUMER_GERMANY' | 'EMONEY_ACCOUNT_BUSINESS_GERMANY' | 'EMONEY_ACCOUNT_CONSUMER_GERMANY' | 'EMONEY_ACCOUNT_FREELANCER_GERMANY' | 'RESTRICTED_ACCOUNT_BUSINESS_GERMANY' | 'RESTRICTED_ACCOUNT_CONSUMER_GERMANY' | 'RESTRICTED_ACCOUNT_CONSUMER_ITALY' | 'SAVINGS_ACCOUNT_CONSUMER_FRANCE' | 'SAVINGS_ACCOUNT_BUSINESS_FRANCE' | 'SAVINGS_ACCOUNT_FREELANCER_FRANCE' | 'SAVINGS_ACCOUNT_CONSUMER_GERMANY' | 'SAVINGS_ACCOUNT_BUSINESS_GERMANY' | 'SAVINGS_ACCOUNT_FREELANCER_GERMANY' | 'SAVINGS_ACCOUNT_CONSUMER_ITALY' | 'SAVINGS_ACCOUNT_BUSINESS_ITALY' | 'SAVINGS_ACCOUNT_FREELANCER_ITALY' | 'SAVINGS_ACCOUNT_CONSUMER_SPAIN' | 'SAVINGS_ACCOUNT_BUSINESS_SPAIN' | 'SAVINGS_ACCOUNT_FREELANCER_SPAIN' | 'SAVINGS_ACCOUNT_EXTERNAL_REFERENCE_CONSUMER_GERMANY' | 'SOFT_CURRENCY_ACCOUNT' | 'SUBACCOUNT_CONSUMER_FRANCE' | 'SUBACCOUNT_CONSUMER_GERMANY' | 'SUBACCOUNT_CONSUMER_ITALY' | 'SUBACCOUNT_CONSUMER_SPAIN' | 'SUBACCOUNT_BUSINESS_FRANCE' | 'SUBACCOUNT_BUSINESS_GERMANY' | 'SUBACCOUNT_BUSINESS_ITALY' | 'SUBACCOUNT_BUSINESS_SPAIN' | 'SUBACCOUNT_FREELANCER_FRANCE' | 'SUBACCOUNT_FREELANCER_GERMANY' | 'SUBACCOUNT_FREELANCER_ITALY' | 'SUBACCOUNT_FREELANCER_SPAIN'

The product name for which you want to open an account. Check the account opening guide for more information about this field.

account_type'CALL_MONEY' | 'CARD_SETTLEMENT_PARTNER' | 'CHECKING_BUSINESS' | 'CHECKING_PERSONAL' | 'CHECKING_PERSONAL_OVERDRAFT' | 'CHECKING_SOLE_PROPRIETOR' | 'CHECKING_SUBACCOUNT' | 'CUSTOMER_CURRENCY_ACCOUNT' | 'DECOUPLED_CARD_BUSINESS' | 'DECOUPLED_CARD_PERSONAL' | 'EMONEY_PARKING' | 'EMONEY_PREPAID' | 'SAVINGS_BUSINESS' | 'SAVINGS_PERSONAL' | 'SAVINGS_PERSONAL_EXTERNAL_REFERENCE' | 'SAVINGS_SOLE_PROPRIETOR' | 'WALLET_BUSINESS' | 'WALLET_INSTITUTIONAL' | 'WALLET_LIQUIDITY_PROVIDER' | 'WALLET_PERSONAL' | 'WALLET_PERSONAL_PAYMENT_ACC'

The type of account you want to open. Must correspond to the product_name and customer_type. Check the account opening guide for more information about this field.

account_purposestring

The purpose of the account. Use primary unless otherwise instructed.

account_bicstring

The BIC to apply to the account. Choose the BIC that corresponds with the branch in which you want to open the account.

account_currencystring

The currency of the account.

{"stackTrail":"components:schemas:account_opening_request:properties:rejection_reason","oasType":"schema","type":"unknown","description":"The reason why the AOR was rejected.","example":{"failed_validation":"consumer_age_over_18","details":"Customer is not over 18 years old."}}
account_idstring

The ID of the account.

ibanstring

The IBAN of the account.

created_atstring date-time

The timestamp (date-time) when the AOR was created.

updated_atstring date-time

The timestamp (date-time) when the AOR was last updated.

Example response

{
  "id": "f8d7fbbd587047a0aa449ce69d2d6c08aorq",
  "customer_id": "b109ee6f66d2a061e006bd31c6455df2cper",
  "customer_type": "Person",
  "status": "COMPLETED",
  "product_name": "CURRENT_ACCOUNT_CONSUMER_GERMANY",
  "account_type": "CHECKING_PERSONAL",
  "account_purpose": "primary",
  "account_bic": "SOBKDEB2XXX",
  "account_currency": "EUR",
  "rejection_reason": {
    "failed_validation": "consumer_age_over_18",
    "details": "Customer is not over 18 years old."
  },
  "account_id": "c5a0e32369e9372e0fdf490294cecd8dcacc",
  "iban": "DE49110101013998767672",
  "created_at": "2021-12-22T15:05:33.634+00:00",
  "updated_at": "2021-12-22T15:05:33.634+00:00"
}