update customer

SecurityAuthApiKey or
Request
path Parameters
customerPhoneNumber
required
string

The phoneNumber of customer to search for

header Parameters
Signature
string

Signature is hash value of the request body salted with your SECRET_TOKEN assigned by Leanpay.

To create hash follow these steps:
1. Create string in format: ENDPOINT_URL + SECRET_TOKEN + RAW_BODY_PAYLOAD
2. Hash this string using SHA256 algorithm

Example

SECRET_TOKEN provided by Leanpay: mysecrettoken

RAW_BODY_PAYLOAD:
{
  "param1": "value1",
  "param2": "value2",
  "param3": "value3"
}

ENDPOINT_URL: https://leanpay.com/example

Now, string for SHA256 will look like this:
https://leanpay.com/examplemysecrettoken{
  "param1": "value1",
  "param2": "value2",
  "param3": "value3"
}

Result hex: 1710009175f64afa322281b48d460e117aff65d52db12253bdfc75a9d866fecd

Request Body schema: application/json
object (Address)

Address details.

createdBy
string

The identity that created the customer.

email
string

Email of the customer.

firstName
required
string

First name of the customer.

required
object (IdentityCard)

Identity card details.

lastName
required
string

Last name of the customer.

Responses
200

Post successfull.

400

The request was malformed or missing a field.

Possible causes:

  • The request was malformed or missing a field, or
  • Some other business exception occurred.

Response contains field 'message' with error code in the format: 'error.business.`ERROR_CODE`'.

Error code list:

  • error.business.DATA_NOT_AVAILABLE - Data for a requested date is not ready yet. Try again later.
401

Authentication is required to perform this request.

403

Permission is required to access this resource

500

The server encountered an internal error while processing this request

put/v1/customers/{customerPhoneNumber}
Request samples
application/json
{
  • "address": {
    },
  • "createdBy": "string",
  • "email": "string",
  • "firstName": "string",
  • "identityCard": {
    },
  • "lastName": "string"
}
Response samples
application/json
{
  • "customer": {
    }
}