Get\Update\Delete Customer

These endpoints operate on a specific customer record identified by its UUID (customerId). Use Get Customer to retrieve the current state, Update Customer to replace the record's fields, and Delete Customer to permanently remove it.

Get Customer

Retrieves the full customer record for a given UUID.

Get Customer

get

/v2/customer/{customerId}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customerIdstring · uuidRequired

Customer UUID

Responses

200

Successful

application/json

idstring · uuidRequired

Customer UUID.

company_namestring · max: 100Optional

Company name of the customer. Required when billing.first_name and billing.last_name are not provided.

company_registration_numberstring · max: 24Optional

Unique identifier of the company recognised by the government. Known as CoC (Chamber of Commerce) number in some countries.

email_addressstring · email · max: 255Optional

Consumer's email address.

Note: Required for 3DS. Please refer to the 3D Secure API specification for format requirements.

entity_idstringRequired

Entity ID on which the customer is created.

phone_numberstring · max: 25Optional

Cardholder's phone number.

Pattern: ^[0-9\s\-+().-]+$

titlestring · max: 120Optional

Customer's title (e.g. Mr, Mrs, Dr).

Pattern: ^[a-zA-Z\-\s.]+$

work_phonestring · max: 25Optional

Consumer's work phone number.

Pattern: ^[0-9\s\-+().-]+$

languagestringOptional

Customer language preference for Invoice documents. See Localisation for details.

created_atstring · date-timeRequired

Timestamp when this customer was created.

updated_atstring · date-timeRequired

Timestamp when this customer was last updated.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/v2/customer/{customerId}

GET /oidc/customer-service/v2/customer/{customerId} HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "billing": {
    "address_1": "text",
    "address_2": "text",
    "address_3": "text",
    "city": "text",
    "country_code": "text",
    "first_name": "text",
    "middle_name": "text",
    "last_name": "text",
    "phone": "text",
    "postal_code": "text",
    "state": "text"
  },
  "company_name": "text",
  "company_registration_number": "text",
  "email_address": "[email protected]",
  "entity_id": "text",
  "phone_number": "text",
  "shipping": {
    "address_1": "text",
    "address_2": "text",
    "address_3": "text",
    "city": "text",
    "first_name": "text",
    "middle_name": "text",
    "last_name": "text",
    "phone": "text",
    "country_code": "text",
    "postal_code": "text",
    "state": "text"
  },
  "title": "text",
  "work_phone": "text",
  "tax": {
    "identifier": "text"
  },
  "language": "text",
  "created_at": "2026-06-06T12:49:58.903Z",
  "updated_at": "2026-06-06T12:49:58.903Z"
}

How It Works

Obtain the customer UUID

The UUID is returned as id when the customer record is created. If you need to look up a UUID by email or name, use the List\Create Customers endpoint with an appropriate RSQL search filter.

Send the GET request

Pass the UUID as the customerId path parameter. Authenticate with Bearer or Basic Auth.

Read the response

A 200 response returns a CustomerResponse object containing the full record: billing, shipping, contact details, entity_id, and timestamps.

Update Customer

Replaces the stored fields of an existing customer record. Pass only the fields you wish to change alongside the required entity_id.

Update replaces the record. Any field not included in the request body will be cleared. Always retrieve the current record first and merge your changes before sending.

Update Customer

post

/v2/customer/{customerId}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customerIdstring · uuidRequired

Customer UUID

Body

company_namestring · max: 100Optional

Company name of the customer. Required when billing.first_name and billing.last_name are not provided.

company_registration_numberstring · max: 24Optional

Unique identifier of the company recognised by the government. Known as CoC (Chamber of Commerce) number in some countries.

email_addressstring · email · max: 255Optional

Consumer's email address.

Field required for: Klarna, PayPal

Note: Required for 3DS. Please refer to the 3D Secure API specification for format requirements.

entity_idstringRequired

Entity ID on which the customer is created. The Entity ID can be found at the organisation level as Organisation ID (Administration > Organizations > [Organization] > Organisation ID).

phone_numberstring · max: 25Optional

Cardholder's phone number.

Pattern: ^[0-9\s\-+().-]+$

titlestring · max: 120Optional

Customer's title (e.g. Mr, Mrs, Dr).

Pattern: ^[a-zA-Z\-\s.]+$

work_phonestring · max: 25Optional

Consumer's work phone number.

Pattern: ^[0-9\s\-+().-]+$

languagestringOptional

Customer language preference for Invoice documents. See Localisation for details.

Responses

200

Successful

application/json

idstring · uuidRequired

Customer UUID.

company_namestring · max: 100Optional

Company name of the customer. Required when billing.first_name and billing.last_name are not provided.

company_registration_numberstring · max: 24Optional

Unique identifier of the company recognised by the government. Known as CoC (Chamber of Commerce) number in some countries.

email_addressstring · email · max: 255Optional

Consumer's email address.

Note: Required for 3DS. Please refer to the 3D Secure API specification for format requirements.

entity_idstringRequired

Entity ID on which the customer is created.

phone_numberstring · max: 25Optional

Cardholder's phone number.

Pattern: ^[0-9\s\-+().-]+$

titlestring · max: 120Optional

Customer's title (e.g. Mr, Mrs, Dr).

Pattern: ^[a-zA-Z\-\s.]+$

work_phonestring · max: 25Optional

Consumer's work phone number.

Pattern: ^[0-9\s\-+().-]+$

languagestringOptional

Customer language preference for Invoice documents. See Localisation for details.

created_atstring · date-timeRequired

Timestamp when this customer was created.

updated_atstring · date-timeRequired

Timestamp when this customer was last updated.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/v2/customer/{customerId}

POST /oidc/customer-service/v2/customer/{customerId} HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 648

{
  "billing": {
    "address_1": "text",
    "address_2": "text",
    "address_3": "text",
    "city": "text",
    "country_code": "text",
    "first_name": "text",
    "middle_name": "text",
    "last_name": "text",
    "phone": "text",
    "postal_code": "text",
    "state": "text"
  },
  "company_name": "text",
  "company_registration_number": "text",
  "email_address": "[email protected]",
  "entity_id": "text",
  "phone_number": "text",
  "shipping": {
    "address_1": "text",
    "address_2": "text",
    "address_3": "text",
    "city": "text",
    "first_name": "text",
    "middle_name": "text",
    "last_name": "text",
    "phone": "text",
    "country_code": "text",
    "postal_code": "text",
    "state": "text"
  },
  "title": "text",
  "work_phone": "text",
  "tax": {
    "identifier": "text"
  },
  "language": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "billing": {
    "address_1": "text",
    "address_2": "text",
    "address_3": "text",
    "city": "text",
    "country_code": "text",
    "first_name": "text",
    "middle_name": "text",
    "last_name": "text",
    "phone": "text",
    "postal_code": "text",
    "state": "text"
  },
  "company_name": "text",
  "company_registration_number": "text",
  "email_address": "[email protected]",
  "entity_id": "text",
  "phone_number": "text",
  "shipping": {
    "address_1": "text",
    "address_2": "text",
    "address_3": "text",
    "city": "text",
    "first_name": "text",
    "middle_name": "text",
    "last_name": "text",
    "phone": "text",
    "country_code": "text",
    "postal_code": "text",
    "state": "text"
  },
  "title": "text",
  "work_phone": "text",
  "tax": {
    "identifier": "text"
  },
  "language": "text",
  "created_at": "2026-06-06T12:49:58.903Z",
  "updated_at": "2026-06-06T12:49:58.903Z"
}

Update workflow

Retrieve the current record

Call GET /v2/customer/{customerId} and capture the full response body.

Merge your changes

Modify the fields you need to update in the captured object. Keep all other existing fields intact to avoid unintended data loss.

Send the POST request

Submit the merged object as the request body to POST /v2/customer/{customerId}. The entity_id field is required.

Confirm the response

A 200 response returns the updated CustomerResponse. Verify the changed fields reflect your intent before continuing.

Delete Customer

Permanently removes a customer record. This action cannot be undone.

Deleting a customer record is irreversible. Any downstream services or payment flows that reference this customer UUID will no longer be able to retrieve the associated data.

Delete Customer

delete

/v2/customer/{customerId}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customerIdstring · uuidRequired

Customer UUID

Responses

204

Customer successfully deleted

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

/v2/customer/{customerId}

DELETE /oidc/customer-service/v2/customer/{customerId} HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

A successful delete returns 204 No Content with an empty body.

Get vs Update — Key Differences

GET /v2/customer/{customerId}

Read-only — no request body
Returns the current state of the record
Safe to call repeatedly without side effects
Use to look up customer data before an update

POST /v2/customer/{customerId}

Writes — request body required
Replaces the full record
entity_id is required in the body
Retrieve first, merge changes, then submit

PreviousCustomer NextList\Create Customers

Last updated 17 days ago

Was this helpful?