Update a customer

• Sandbox: PATCH https://payme-store-staging.payme.io/api/customers/{guid}
• Production: PATCH https://payme-store.payme.io/api/customers/{guid}

Credentials

• Header Authorization: Bearer <token>

Changes some fields of one of the seller's customers. Fields you don't send, or send empty, keep their values. A payment_tokens array you send replaces all of the customer's saved tokens.

The request names the phone fields phone and additional_phone and sends the address fields at the top level; responses name them phone_number and additional_phone_number and nest the address in address. Fields the API doesn't know are ignored.

To replace the whole customer in one call, PUT /customers/{guid} takes the same body as POST /customers, with the same required fields.

Send Authorization: Bearer <auth_token>, the token from POST /auth-tokens. Hosts, tokens and the error format: Hosts, authentication and errors.

Parameters

Request body

Content type: application/json

The fields to change.

Request example

{
  "email": "dana.levi@example.com",
  "phone": "0527654321",
  "city": "Haifa"
}

Code samples

curl

curl -X PATCH 'https://payme-store-staging.payme.io/api/customers/<guid>' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  --data-raw '{
  "email": "dana.levi@example.com",
  "phone": "0527654321",
  "city": "Haifa"
}'

Node.js

const response = await fetch("https://payme-store-staging.payme.io/api/customers/<guid>", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer <YOUR_TOKEN>",
  },
  body: JSON.stringify({
    "email": "dana.levi@example.com",
    "phone": "0527654321",
    "city": "Haifa"
  }),
});

console.log(await response.text());

Python

import requests

response = requests.patch(
    "https://payme-store-staging.payme.io/api/customers/<guid>",
    headers={
        "Authorization": "Bearer <YOUR_TOKEN>",
    },
    json={
        "email": "dana.levi@example.com",
        "phone": "0527654321",
        "city": "Haifa",
    },
)

print(response.text)

PHP

<?php

$body = <<<'BODY'
{
  "email": "dana.levi@example.com",
  "phone": "0527654321",
  "city": "Haifa"
}
BODY;

$ch = curl_init('https://payme-store-staging.payme.io/api/customers/<guid>');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'Authorization: Bearer <YOUR_TOKEN>',
    ],
    CURLOPT_POSTFIELDS => $body,
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Responses

200 — Customer updated. (success)

{
  "guid": "6c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "created_at": "2026-11-01T09:30:00.000Z",
  "updated_at": "2026-11-09T10:00:00.000Z"
}

400 — A field is invalid, the body isn't valid JSON, or guid isn't a UUID. (error)

{
  "status_error_details": "Field validation failed.",
  "validation_errors": {
    "email": {
      "is_email": "The value must be a valid email address."
    }
  },
  "status_error_code": 501,
  "session": "f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"
}

401 — The Authorization header is missing, or the access token is invalid or expired. Get a new token with POST /refresh-exchanges or POST /auth-tokens. (error)

{
  "status_error_details": "Unauthorized",
  "status_error_code": 999,
  "session": "f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"
}

404 — The customer doesn't exist, was deleted, or belongs to another seller. (error)

{
  "status_error_details": "Customer not found",
  "status_error_code": 999,
  "session": "f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"
}

409 — customer_external_id is already used by another of the seller's customers. (error)

{
  "status_error_details": "Customer external id already exist",
  "status_error_code": 999,
  "session": "f3a1c2b0-9e4d-11ef-8c1a-0242ac120002"
}

500 — Server error. Contact PayMe support and quote the session. (error)