Create Customer

Path

POST /businesses/{businessCode}/customers

Request Parameters

businessCode

required

string

Business Code

X-Request-ID

string

The unique ID of this particular request/transaction. Subsequent requests with the same request ID might get ignored.

Request Body

application/json

currency

string

Currency used in order (encoded as 3-letter code according to ISO 4217)

required

object

Customer object

array

object

accountCategory

string

Enum:

Standard

Reseller

Account Category. Possible values are Standard, Reseller. Default value is Standard.

currency

string

Currency in which account is billed.

dataFromDefault

boolean

Flag to be set false only when basic account data needs to be explicitly updated. When it is set to true, basic data of account will be inherited from default account of the customer.

string

Max length: 241

Email address of the account to which invoice has to be billed.

emailFromDefault

boolean

Flag to be set false only when email needs to be explicitly updated. When it is set to true,email will be inherited from default account of the customer.

firstName

string

Max length: 40

First name to which invoice has to be billed.

identificationNumber

string

Max length: 20

Identification nummber to which invoice has to be billed.

lastName

string

Max length: 40

Last name to which invoice has to be billed.

ownerConsumption

boolean

If the account has the owner consumption status.

object

Contains information about a registered payment

object

Bank Account info is needed only in case of SEPA payment. EITHER PSP details OR bank account should be provided BUT NOT both.

string

Payment identification

paymentDataFromDefault

boolean

Flag to be set false only when paymentRegistration data needs to be explicitly updated. When it is set to true,payment Resgistration will be inherited from default account of the customer.

paymentMethodName

string

Enum:

AfterPayDirectDebit

AfterPayInstallmentsDirectDebit

AfterPayInstallmentsOpenInvoice

AfterPayOpenInvoice

AmazonPay

AmericanExpress

ApplePayExpressCheckout

ArvatoDirectDebitSepa

Bancontact

Blik

BlikCodeOnly

CashOnDelivery

DinersClub

Discover

Eps

Giftcard

Giropay

GooglePay

Ideal

InAppAmazon

InAppApple

InAppGoogle

InStoreOpenInvoice

InStorePickup

InStorePrepayment

Klarna

KlarnaDirectDebit

KlarnaInstallments

KlarnaOpenInvoice

KlarnaPayLater

KlarnaPayOverTime

LoyaltyCard

MasterCard

Multibanco

OpenInvoice

PayPal

PayPalExpressCheckout

PayU

PrePayment

Przelewy24

Sofort

Trustly

Visa

Name of the payment method being used: * AfterPayDirectDebit * AfterPayInstallmentsDirectDebit * AfterPayInstallmentsOpenInvoice * AfterPayOpenInvoice * AmazonPay * AmericanExpress * ApplePayExpressCheckout * ArvatoDirectDebitSepa * Bancontact * Blik * BlikCodeOnly * CashOnDelivery * DinersClub * Discover * Eps * Giftcard * Giropay * GooglePay * Ideal * InAppAmazon * InAppApple * InAppGoogle * InStoreOpenInvoice * InStorePickup * InStorePrepayment * Klarna * KlarnaDirectDebit * KlarnaInstallments * KlarnaOpenInvoice * KlarnaPayLater * KlarnaPayOverTime * LoyaltyCard * MasterCard * Multibanco * OpenInvoice * PayPal * PayPalExpressCheckout * PayU * PrePayment * Przelewy24 * Sofort * Trustly * Visa

pspCustomerId

string

PSP Customer identification

pspPaymentMethodId

string

PSP Payment method Id

salutation

string

Enum:

MRS

Salutation of the natural person: * MR = Mr * MRS = Mrs

taxExemption

string

Enum:

Disabled

Enabled

If there is any taxExemption for the account. Possible values are Disabled, Enabled. Default value is Disabled.

taxIdentificationNumber

string

TAX Identification nummber of the country to which invoice has to be billed.

accountId

required

string

Identificationnumber of that account

accountName

string

Name of that account

defaultAccount

boolean

This is a flag internal to our Subscription management System.There is just one default account internally created by the system and any further accounts created by merchants could never be default account. Setting this value to true is not possible.

object

birthDate

string

yyyy-MM-dd

Date of birth. Not applicable to companies and other legal persons.

businessCode

number

Business Code

companyName

string

Max length: 140

Purchasing company name. Everything over 140 characters will be truncated

customerCategory

required

string

Enum:

COMPANY

PERSON

COMPANY_RESELLER

Customer category. Possible values: COMPANY, PERSON or COMPANY_RESELLER

customerNumber

string

Max length: 100

Customer unique number

customerType

string

Enum:

COMPANY

PERSON

COMPANY_RESELLER

Customer category. Possible values: COMPANY, PERSON or COMPANY_RESELLER

string

Max length: 241

E-Mail address

firstName

string

Max length: 40

First name

identificationNumber

string

Max length: 20

National ID number (if the customer is a physical person). Registration number (if the customer is a company).

language

string

Language to be used for communication (encoded as 2-letter code according to ISO 639-1 alpha-2)

lastName

string

Max length: 40

Last name

mobilePhone

string

Max length: 20

Mobile phone

phone

string

Max length: 20

Phone number

salutation

string

Enum:

MRS

Salutation of the natural person: * MR = Mr * MRS = Mrs

taxIdentificationNumber

string

Max length: 20

Tax identification number (VAT ID)

object

Contains information about a registered payment

object

Bank Account info is needed only in case of SEPA payment. EITHER PSP details OR bank account should be provided BUT NOT both.

string

Payment identification

paymentDataFromDefault

boolean

Flag to be set false only when paymentRegistration data needs to be explicitly updated. When it is set to true,payment Resgistration will be inherited from default account of the customer.

paymentMethodName

string

Enum:

AfterPayDirectDebit

AfterPayInstallmentsDirectDebit

AfterPayInstallmentsOpenInvoice

AfterPayOpenInvoice

AmazonPay

AmericanExpress

ApplePayExpressCheckout

ArvatoDirectDebitSepa

Bancontact

Blik

BlikCodeOnly

CashOnDelivery

DinersClub

Discover

Eps

Giftcard

Giropay

GooglePay

Ideal

InAppAmazon

InAppApple

InAppGoogle

InStoreOpenInvoice

InStorePickup

InStorePrepayment

Klarna

KlarnaDirectDebit

KlarnaInstallments

KlarnaOpenInvoice

KlarnaPayLater

KlarnaPayOverTime

LoyaltyCard

MasterCard

Multibanco

OpenInvoice

PayPal

PayPalExpressCheckout

PayU

PrePayment

Przelewy24

Sofort

Trustly

Visa

pspCustomerId

string

PSP Customer identification

pspPaymentMethodId

string

PSP Payment method Id

Responses

array

object

accountCategory

string

Enum:

Standard

Reseller

Account Category. Possible values are Standard, Reseller. Default value is Standard.

currency

string

Currency in which account is billed.

dataFromDefault

boolean

Flag to be set false only when basic account data needs to be explicitly updated. When it is set to true, basic data of account will be inherited from default account of the customer.

string

Max length: 241

Email address of the account to which invoice has to be billed.

emailFromDefault

boolean

Flag to be set false only when email needs to be explicitly updated. When it is set to true,email will be inherited from default account of the customer.

firstName

string

Max length: 40

First name to which invoice has to be billed.

identificationNumber

string

Max length: 20

Identification nummber to which invoice has to be billed.

lastName

string

Max length: 40

Last name to which invoice has to be billed.

ownerConsumption

boolean

If the account has the owner consumption status.

object

Contains information about a registered payment

object

Bank Account info is needed only in case of SEPA payment. EITHER PSP details OR bank account should be provided BUT NOT both.

string

Payment identification

paymentDataFromDefault

boolean

Flag to be set false only when paymentRegistration data needs to be explicitly updated. When it is set to true,payment Resgistration will be inherited from default account of the customer.

paymentMethodName

string

Enum:

AfterPayDirectDebit

AfterPayInstallmentsDirectDebit

AfterPayInstallmentsOpenInvoice

AfterPayOpenInvoice

AmazonPay

AmericanExpress

ApplePayExpressCheckout

ArvatoDirectDebitSepa

Bancontact

Blik

BlikCodeOnly

CashOnDelivery

DinersClub

Discover

Eps

Giftcard

Giropay

GooglePay

Ideal

InAppAmazon

InAppApple

InAppGoogle

InStoreOpenInvoice

InStorePickup

InStorePrepayment

Klarna

KlarnaDirectDebit

KlarnaInstallments

KlarnaOpenInvoice

KlarnaPayLater

KlarnaPayOverTime

LoyaltyCard

MasterCard

Multibanco

OpenInvoice

PayPal

PayPalExpressCheckout

PayU

PrePayment

Przelewy24

Sofort

Trustly

Visa

pspCustomerId

string

PSP Customer identification

pspPaymentMethodId

string

PSP Payment method Id

salutation

string

Enum:

MRS

Salutation of the natural person: * MR = Mr * MRS = Mrs

taxExemption

string

Enum:

Disabled

Enabled

If there is any taxExemption for the account. Possible values are Disabled, Enabled. Default value is Disabled.

taxIdentificationNumber

string

TAX Identification nummber of the country to which invoice has to be billed.

accountId

required

string

Identificationnumber of that account

accountName

string

Name of that account

defaultAccount

boolean

object

birthDate

string

yyyy-MM-dd

Date of birth. Not applicable to companies and other legal persons.

businessCode

number

Business Code

companyName

string

Max length: 140

Purchasing company name. Everything over 140 characters will be truncated

customerCategory

required

string

Enum:

COMPANY

PERSON

COMPANY_RESELLER

Customer category. Possible values: COMPANY, PERSON or COMPANY_RESELLER

customerNumber

string

Max length: 100

Customer unique number

customerType

string

Enum:

COMPANY

PERSON

COMPANY_RESELLER

Customer category. Possible values: COMPANY, PERSON or COMPANY_RESELLER

string

Max length: 241

E-Mail address

firstName

string

Max length: 40

First name

identificationNumber

string

Max length: 20

National ID number (if the customer is a physical person). Registration number (if the customer is a company).

language

string

Language to be used for communication (encoded as 2-letter code according to ISO 639-1 alpha-2)

lastName

string

Max length: 40

Last name

mobilePhone

string

Max length: 20

Mobile phone

phone

string

Max length: 20

Phone number

salutation

string

Enum:

MRS

Salutation of the natural person: * MR = Mr * MRS = Mrs

taxIdentificationNumber

string

Max length: 20

Tax identification number (VAT ID)

Create Customer example

Request Example

    
        {
 "currency": "EUR",
 "customer": {
  "email": "test@test.com",
  "phone": "+37258XXX585",
  "address": {
   "careOf": "c/o Mr. Bloom",
   "street": "exampleStreet",
   "postalCode": "12345",
   "addressType": "main address",
   "countryCode": "DE",
   "postalPlace": "exampleCity",
   "streetNumber": "1234",
   "streetNumberAdditional": "d"
  },
  "language": "de",
  "lastName": "Doe",
  "birthDate": "1980-09-01T00:00:00Z",
  "firstName": "John",
  "salutation": "MR",
  "companyName": "myCompany",
  "mobilePhone": "+37258774XXX",
  "customerNumber": "cust1234",
  "customerCategory": "categoryABC",
  "identificationNumber": "700XXX651",
  "taxIdentificationNumber": "12345678L"
 },
 "paymentRegistration": {
  "id": "ACVB123455675669",
  "pspCustomerId": "string",
  "pspPaymentMethodId": "string"
 }
}

Response Example

    
        null