Creates a new customer

post

https://sepaexpress-prod-fx.azurewebsites.net/api/services/v2/Customers

Creates a new customer. The newly created resource can be referenced by the URI given by a Location header field in the response.

Body Params

merchantId

string

required

length between 32 and 32

The unique identifier of the merchant this customer object belongs to.

salutation

string

length between 0 and 35

Customer’s salutation.

givenName

string

length between 0 and 35

Customer’s given name. Required unless a company name is provided.

familyName

string

length between 0 and 35

Customer’s family name. Required unless a company name is provided.

companyName

string

length between 0 and 70

Customer’s company name. Required unless a given name and family name are provided.

addressLine1

string

length between 0 and 70

The first line of the customer’s address.

addressLine2

string

length between 0 and 70

The second line of the customer’s address.

addressLine3

string

length between 0 and 70

The third line of the customer’s address.

postalCode

string

length between 0 and 16

The postal code of the customer’s address.

city

string

length between 0 and 35

The city of the customer’s address.

region

string

length between 0 and 35

The address region, county or department of the customer’s address.

countryCode

string

length between 2 and 2

The ISO 3166-1 alpha-2 country code of the customer’s address.

languageCode

string

length between 2 and 2

ISO 639-1 code. Used as the language for notification emails sent by SEPAexpress if your organisation does not send its own (see compliance requirements). Currently only “en”, “fr”, “de” are supported. Defaults to the country code of the address or "en" if not supported.

emailAddress

string

length between 0 and 255

Customer’s email address.

telephone

string

length between 0 and 16

Customer’s telephone number. ITU-T E.164 formatted. When validating the customer's mobile number, please note that the following structure must be strictly followed:
[+][country code][area code][subscriber number]

cellphone

string

length between 0 and 16

Customer’s cellphone number. ITU-T E.164 formatted. When validating the customer's telephone number, please note that the following structure must be strictly followed:
[+][country code][area code][subscriber number]

idempotencyKey

string

length between 0 and 32

The unique idempotency key of this entity creation. Optional, but highly recommended to use. When given, SEPAexpress checks whether an entity of this type with the specified idempotency key already exists, and fails the creation if a duplicate entity is found. The ID of the conflicting entity can be found in the error message.

memo

string

length between 0 and 255

Memo for free use by the PSP.

Responses

201Created. The request has been fulfilled and resulted in a new resource being created.

400Bad Request. The request could not be understood by the server, usually due to malformed syntax.

401Unauthorized. The client did not provide a valid authentication HTTP header or the user making the request has been disabled.

403Forbidden. The client provided a valid authentication header, but does not have permission to access this resource.

409Conflict. The resource to be created by your request already exists.

429Too many requests. A rate limit has been reached.