Skip to content

Retrieving a Customer

A method for retrieving data for a linked customer.

URL

Method: GET

  • Production: https://api.pay.kvell.group/v1/customers/{customer_key}
  • Stage: https://api.pay.stage.kvell.group/v1/customers/{customer_key}

Request parameters

Name Data type Required Description
customer_key string Yes Customer identifier in the merchant's system

Request headers

Name Data type Required Description
X-Api-Key string Yes Unique shop identifier
X-Signature string Yes Signature

The X-Signature signature is generated by concatenating X-Api-Key, customer_key, and secret_key. sha256 is computed from the resulting string:

sha256({x-api-key}{customer_key}{secret_key})

where secret_key is the secret key found in the merchant's shop settings.

Response

Response example

{
  "id": 123,
  "customer_key": "customer-42",
  "merchant_point_id": 15,
  "email": "customer@example.com",
  "phone": "79991234567"
}

email and phone can be null.

{
  "errors": [
    {
      "code": 20101,
      "message": "Customer not found"
    }
  ]
}

{
  "errors": [
    {
      "message": "customer_key: Field required",
      "code": 20098
    }
  ]
}