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
object
careOf
string
Max length: 40
Name of the intermediary responsible for transferring a mail item between the postal system and the final recipient, e.g. 'Jane c/o John'.
This field is also to be used for company, authority and organisation names, e.g. 'Sportverein Blau-Weiss e.V.'
companyName
string
Max length: 140
Company Name to which invoice has to be billed.
countryCode
string
Country code (encoded as 2-letter code according to ISO 3166-1 alpha-2)
phone
string
Max length: 20
Phone number of the account to which invoice has to be billed.
postalCode
string
Max length: 10
Postal code
postalPlace
string
Max length: 40
Postal place, e.g. city
street
string
Max length: 60
Name of street or packstation
streetNumber
string
Max length: 10
Street or packstation number
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.
email
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.
accountHolderName
string
Account Holder full name.
iban
string
IBAN of the customer.
isMandated
boolean
Customer's consent to perform SEPA.
sepaMandateRef
string
SEPA Mandate Reference generated by Riverty's Subscription Management system.
signatureDate
string
yyyy-MM-dd
Date of the Signature when mandate was signed by the customer.
id
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:
- MR
- 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
careOf
string
Max length: 40
Name of the intermediary responsible for transferring a mail item between the postal system and the final recipient, e.g. 'Jane c/o John'.
This field is also to be used for company, authority and organisation names, e.g. 'Sportverein Blau-Weiss e.V.'
companyName
string
Max length: 140
Company Name to which invoice has to be billed.
countryCode
string
Country code (encoded as 2-letter code according to ISO 3166-1 alpha-2)
phone
string
Max length: 20
Phone number of the account to which invoice has to be billed.
postalCode
string
Max length: 10
Postal code
postalPlace
string
Max length: 40
Postal place, e.g. city
street
string
Max length: 60
Name of street or packstation
streetNumber
string
Max length: 10
Street or packstation number
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
email
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:
- MR
- 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.
accountHolderName
string
Account Holder full name.
iban
string
IBAN of the customer.
isMandated
boolean
Customer's consent to perform SEPA.
sepaMandateRef
string
SEPA Mandate Reference generated by Riverty's Subscription Management system.
signatureDate
string
yyyy-MM-dd
Date of the Signature when mandate was signed by the customer.
id
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
Responses
-
arrayobjectobjectcareOfstringMax length: 40Name of the intermediary responsible for transferring a mail item between the postal system and the final recipient, e.g. 'Jane c/o John'. This field is also to be used for company, authority and organisation names, e.g. 'Sportverein Blau-Weiss e.V.'companyNamestringMax length: 140Company Name to which invoice has to be billed.countryCodestringCountry code (encoded as 2-letter code according to ISO 3166-1 alpha-2)phonestringMax length: 20Phone number of the account to which invoice has to be billed.postalCodestringMax length: 10Postal codepostalPlacestringMax length: 40Postal place, e.g. citystreetstringMax length: 60Name of street or packstationstreetNumberstringMax length: 10Street or packstation numberaccountCategorystringEnum:
- Standard
- Reseller
Account Category. Possible values are Standard, Reseller. Default value is Standard.currencystringCurrency in which account is billed.dataFromDefaultbooleanFlag 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.emailstringMax length: 241Email address of the account to which invoice has to be billed.emailFromDefaultbooleanFlag 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.firstNamestringMax length: 40First name to which invoice has to be billed.identificationNumberstringMax length: 20Identification nummber to which invoice has to be billed.lastNamestringMax length: 40Last name to which invoice has to be billed.ownerConsumptionbooleanIf the account has the owner consumption status.objectContains information about a registered paymentobjectBank Account info is needed only in case of SEPA payment. EITHER PSP details OR bank account should be provided BUT NOT both.accountHolderNamestringAccount Holder full name.ibanstringIBAN of the customer.isMandatedbooleanCustomer's consent to perform SEPA.sepaMandateRefstringSEPA Mandate Reference generated by Riverty's Subscription Management system.signatureDatestringyyyy-MM-ddDate of the Signature when mandate was signed by the customer.idstringPayment identificationpaymentDataFromDefaultbooleanFlag 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.paymentMethodNamestringEnum:- 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 * VisapspCustomerIdstringPSP Customer identificationpspPaymentMethodIdstringPSP Payment method IdsalutationstringEnum:- MR
- MRS
Salutation of the natural person: * MR = Mr * MRS = MrstaxExemptionstringEnum:- Disabled
- Enabled
If there is any taxExemption for the account. Possible values are Disabled, Enabled. Default value is Disabled.taxIdentificationNumberstringTAX Identification nummber of the country to which invoice has to be billed.accountIdrequiredstringIdentificationnumber of that accountaccountNamestringName of that accountdefaultAccountbooleanThis 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.objectcareOfstringMax length: 40Name of the intermediary responsible for transferring a mail item between the postal system and the final recipient, e.g. 'Jane c/o John'. This field is also to be used for company, authority and organisation names, e.g. 'Sportverein Blau-Weiss e.V.'companyNamestringMax length: 140Company Name to which invoice has to be billed.countryCodestringCountry code (encoded as 2-letter code according to ISO 3166-1 alpha-2)phonestringMax length: 20Phone number of the account to which invoice has to be billed.postalCodestringMax length: 10Postal codepostalPlacestringMax length: 40Postal place, e.g. citystreetstringMax length: 60Name of street or packstationstreetNumberstringMax length: 10Street or packstation numberbirthDatestringyyyy-MM-ddDate of birth. Not applicable to companies and other legal persons.businessCodenumberBusiness CodecompanyNamestringMax length: 140Purchasing company name. Everything over 140 characters will be truncatedcustomerCategoryrequiredstringEnum:- COMPANY
- PERSON
- COMPANY_RESELLER
Customer category. Possible values: COMPANY, PERSON or COMPANY_RESELLERcustomerNumberstringMax length: 100Customer unique numbercustomerTypestringEnum:- COMPANY
- PERSON
- COMPANY_RESELLER
Customer category. Possible values: COMPANY, PERSON or COMPANY_RESELLERemailstringMax length: 241E-Mail addressfirstNamestringMax length: 40First nameidentificationNumberstringMax length: 20National ID number (if the customer is a physical person). Registration number (if the customer is a company).languagestringLanguage to be used for communication (encoded as 2-letter code according to ISO 639-1 alpha-2)lastNamestringMax length: 40Last namemobilePhonestringMax length: 20Mobile phonephonestringMax length: 20Phone numbersalutationstringEnum:- MR
- MRS
Salutation of the natural person: * MR = Mr * MRS = MrstaxIdentificationNumberstringMax length: 20Tax identification number (VAT ID) -
objectObject that contains details for an error that was encountered when accessing a third party serviceactionstringExternal action to be triggered based on error code/messagecodestringCodecustomerFacingMessagestringCustomer facing messagedescriptionstringDescriptionfieldReferencestringField referencesourcestringSource of external error code, e.g. Internal ThirdPartyACI Third-PartyPayPaltitlestringTitletypestringType or classcodestringError codedescriptionstringError descriptiontitlestringError titletypestringError type, e.g. InternalServiceError InternalValidationError InternalBusinessError ThirdPartyError Warning
-
objectObject that contains details for an error that was encountered when accessing a third party serviceactionstringExternal action to be triggered based on error code/messagecodestringCodecustomerFacingMessagestringCustomer facing messagedescriptionstringDescriptionfieldReferencestringField referencesourcestringSource of external error code, e.g. Internal ThirdPartyACI Third-PartyPayPaltitlestringTitletypestringType or classcodestringError codedescriptionstringError descriptiontitlestringError titletypestringError type, e.g. InternalServiceError InternalValidationError InternalBusinessError ThirdPartyError Warning
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