PApayretailers

Create Customer

post/

Request

  • Base URL
    https://api-sandbox.payretailers.com/api/v1/customers
  • URL
    https://api-sandbox.payretailers.com/api/v1/customers/
  • Auth
    HTTP basic

Headers

Ocp-Apim-Subscription-Keystring required

The subscription key has a length of 32 characters and will be provided within the API keys. Will be available for new integrations from July 24th onwards.

Request body

uniqueCustomerIdentifierstring

<strong style="color:red">Required if a personalId is not provided</strong><br>Your unique identifier for the Customer

notificationUrlstring required

The URL where the Customer event webhooks will be sent.

countrystring required

Country of the Customer

personalIdstring

<strong style="color:red">Required if a uniqueCustomerIdentifier is not provided</strong><br>Personal Id of the Customer.

firstNamestring

The customer's first name. Numbers and special characters are not allowed, except þ, ð, ç, ñ, accent marks (´, `, á, é, í, ó, ú, à, è, ì, ò, ù, ä, ë, ï, ö, ü, â, ê, î, ô, û), diacritical marks (~), diaereses (ë), hyphens (-), commas (,) and apostrophe (').<br>Length: up to 30 chars

lastNamestring

The customer's last name. Numbers and special characters are not allowed, except þ, ð, ç, ñ, accent marks (´, `, á, é, í, ó, ú, à, è, ì, ò, ù, ä, ë, ï, ö, ü, â, ê, î, ô, û), diacritical marks (~), diaereses (ë), hyphens (-), commas (,) and apostrophe (').<br>Length: up to 30 chars

addressstring

The user's address.<br>Length: up to 255 chars

citystring

The user's city. Numbers and special characters are not allowed, except for þ, ð, ç, ñ, accent marks (á, à, é, ó, ô, â), diacritical marks (~), diaereses (ë), dashes (-), commas (,) and apostrophe (').<br>Length: up to 60 chars.

zipstring

The Customer's post code. Only numbers and "-" are allowed. Special characters, such as +,$,() and letters [A-Z], are not allowed

statestring

The Customer's state or province.

phonestring

The Customer's phone number. Numbers and special characters, such as +,-, and (), are allowed.<br>Length: from 7 to 15 digits

emailstring

The customer's email address. Will be used by the system to send checkout instructions.

languagestring required

The Customer's language.

Response

202

Changes

No recorded changes to this operation across all 1 revision of this API.