v1

latestOpenAPI 3.1.02026-07-263436159.3 KB

Get Customer

get/{uniqueCustomerIdentifier}

Path parameters

uniqueCustomerIdentifierstring required

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.

Response

200

uniqueCustomerIdentifierstring

isActivestring

deactivationReasonstring

createdDatestring

editedDatestring

notificationUrlstring

countryCodestring

personalIdstring

firstNamestring

lastNamestring

addressstring

citystring

postalCodestring

statestring

phonestring

emailstring

languagestring

Example response

{
  "uniqueCustomerIdentifier": "PERM850515MDFPRD32",
  "isActive": "true",
  "deactivationReason": "test",
  "createdDate": "2024-04-13T08:30:00Z",
  "editedDate": "2024-04-13T08:30:00Z",
  "notificationUrl": "https://payment-form.payretailers.com/notification",
  "countryCode": "MX",
  "personalId": "PERM850515MDFPRD32",
  "firstName": "John",
  "lastName": "Doe",
  "address": "República de Perú 177",
  "city": "Ciudad de Mexico",
  "postalCode": "06010",
  "state": "Ciudad de Mexico",
  "phone": "5299999999999",
  "email": "test@payretailers.com",
  "language": "ES",
  "registeredAccounts": [
    {
      "bankName": "string",
      "accountNumber": "string",
      "accountAgencyNumber": "string",
      "accountTypeCode": "string"
    }
  ],
  "virtualAccounts": [
    {
      "id": "string",
      "paymentMethod": "string",
      "isDefault": "true",
      "isActive": "true",
      "deactivationReason": "string",
      "createdDate": "datetime",
      "editedDate": "datetime",
      "data": [
        {
          "id": "integer",
          "type": "string",
          "value": "object"
        }
      ]
    }
  ]
}