Customers

Use Case Loyalty

Based on the generic functionality other use cases could be applicable.

Loyalty programs that reward and redeem points are a common part of payments between merchants and customers. The identification of a customer is often handled by providing an additional loyalty token like a plastic card during the checkout. This loyalty token (customer reference) could be added to a virtual wallet also. The loyalty account associated with the token is referenced with a number identifying the customer.

Until now, customers required a payment card and a loyalty card. CCV provides a solution where a loyalty card (physical or virtual) is no longer required and becomes fully integrated within the payment for rewarding and redeeming.

CCV provides a solution in which registered customers can be linked to the payment card they use in the shop. Once the link is set up between the loyalty card and payment card, the merchant receives the customer reference within the payment flow for loyalty processing. A merchant can query the customer data using the payment card in the CCV terminal.

All sensitive card data remains within the CCV ecosystem and is never exposed to the merchant. The only data the terminal exposes is the customer reference if a payment card link is found.

To interact with the customer reference data, CCV provides this API which can be used to initially register a customer reference, retrieve the links available, remove any links or remove all data of a customer. The merchant is responsible to comply with privacy and other regulations and manage the OPT-IN/OPT-OUT.

In-store functionality

Usage steps:

A CCV terminal must be set up in your store and connected to an electronic cash register that supports OPI and the specific customer reference functionality.
Add a customer through the API and include the customer reference (e.g. loyalty account number) and provide a timestamp until which the linking of new payment cards will be enabled. This way the ECR does not need to have specific enrollment functionality.
When the customer comes to the store: capture the customer reference, include the customer reference within the payment transaction, and link the payment card to this customer (but only if the linking of new payment cards is (still) enabled for this customer).
For all subsequent transactions, get the card link using the customer reference via the terminal.

Online functionality

Usage steps:

Add a customer through the API and include the customer reference (e.g.loyalty account number), one or more identifiers used to recognize the customer (e.g. barcode numbers) and timestamp until which new payment card will be linked to the customer.
Optionally update the timestamp until which new payment cards are linked to the customer
Get all linked cards for a customer for displaying and information purposes to the customer
Remove one or all linked cards for a customer
Remove a customer including all linked cards.

How it works (when and how to use the API calls)

The following “how it works” shows how the use case reflects on the various API calls.

1. Pre-registration before linking

The pre-registration is initiated with the API call Add Customer. After the API call, any subsequent payment card transaction which has a provided link reference included will be linked to the customer until the provided timestamp is expired.

During the full customer journey Get Customer can be used to retrieve in every step the latest information and status.

If the customer or merchant wants to change the payment card linking status, it can update the customer with Update Customer to set a new timestamp after which no new payment cards will be linked. The timestamp is a long integer with the number of seconds since the Unix Epoch time. Use the minimum value to disable the linking of any new payment cards and the maximum value to enable the linking of new payment cards until further notice.

2. Retrieve link information to inform the customer

After the payment card is linked with the loyalty card the merchant can retrieve the latest information via Get All Payment Cards. A masked PAN is included that could be presented to the customer. Within the payment card data, a CCV internal id is included which can be used to remove a payment card link.

3. Remove the link

If the customer or merchant would like to remove a single payment card link the Remove Payment Card has to be used with the appropriate card id selected.

4. Remove the customer

Full removal of the customer can be initiated with the Remove Customer which removes the customer including all payment card links.

5. Multiple cards, mobile phones, and or wearable devices

Multiple payment cards can be linked to a single customer. When a payment card that is already linked to a customer (A) is linked to the customer (B), the link to the customer (A) is removed and the payment card is linked to the new customer (B).

If a customer has multiple cards or devices with the same bank account number, all the cards and devices have to be individually linked. When you get a replacement card, also this replacement card needs to be linked.

API Changes

The API contains endpoints to manage customers and their linked cards.

Communication with the API is described in the general API documentation

Schemas

Customer Object

A customer as referenced by the merchant is an entity that can be linked to payment cards. Use cases like loyalty allow multiple people to be referenced as the same customer by linking their payment card to the same customer.

The registration expiration is an optional parameter for how long a registration request may be honored. Card link requests after this time will be ignored.

Name	Type	Size	Format	Description
id	string		UUID Type 4	The unique UUID assigned by the PSP to the customer
externalId	string	max 64		The unique ID assigned by the merchant to the customer
customerReference	string	max 64		The reference returned when querying the link of payment card
registrationExpiration	integer		Unix Epoch Time in milliseconds	The timestamp after which the registration can no longer be valid
created	integer		Unix Epoch Time in milliseconds	The server datetime the customer was created
lastUpdated	integer		Unix Epoch Time in milliseconds	The server datetime the customer was updated
registered	integer		Unix Epoch Time in milliseconds	The server datetime the customers first card was registered
linkReferences	array	25	Link Reference	The list of link references to identify the customer when creating card links

Link Reference Object

A link reference identifies a customer during the card linking process. The difference with the customer reference is its use:

a link reference is used to create the link between a customer and a payment card
a customer reference is queried for a given payment card

A customer reference can be used as a link reference, but it is not required. If desired, define the customer reference explicitly as a link reference.

!IMPORTANT A link reference must be unique for all customers from a merchant.

Type	Size	Format	Description
string	max 64		A reference to link a customer to a payment card

Paged Customers Object

A paged list of customers.

Name	Type	Description
data	array of Customer	A list of customers. The maximum number of customers in this list is defined by the page size.
page	page	Information about the total amount of customers and the current returned list.

Page Object

A page contains information about the current paged list and the total amount of entities over all pages.

Name	Type	Description
size	integer	The maximum size of the current page.
number	integer	The number of the current page. (The first page has number 0)
totalElements	integer	The total amount of elements over all pages.
totalPages	integer	The total number of available pages.

Card Object

A card represents a physical payment card linked to a customer. The PAN is not stored but can be identified with a merchant specific token. The same PAN for the same customer will never have the same token for different merchants.

Name	Type	Size	Format	Description
id	string	36	UUID Type 4	The unique UUID assigned by the PSP to the card
maskedPan	string	13-19	`[\d]{4}[X]{5,11}[\d]{4}`	The masked number of the card PAN
created	integer		Unix Epoch Time in milliseconds	The server datetime the card was created
lastUpdated	integer		Unix Epoch Time in milliseconds	The server datetime the card was updated

Customers by id

Manage customers with identifiers assigned by CCV.

Action: Add Customer

Add a new customer to the merchant account.

Request

Resource: /api/v1/customer
Method: POST
Authentication: Required
Content-Type: application/json
Parameters:

Name	Type	Size	Format	Inclusion	Description
externalId	string	max 64		Optional	The unique ID assigned by the merchant to the customer
customerReference	string	max 64		Required	The reference to link with payment cards
registrationExpiration	integer		Unix Epoch Time in milliseconds	Required	The timestamp after which the registration can no longer be valid
linkReferences	array	25	Link Reference	Optional	The list of link references to identify the customer when creating card links

Example

POST /api/v1/customer HTTP/1.1
Host: api.psp.ccv.eu
user-agent: curl/7.74.0
accept: application/json
content-type:application/json

{
    "externalId" : "a2d33fe6",
    "customerReference" : "123456789",
    "registrationExpiration": 1612194997000,
    "linkReferences" : ["123456789", "49-LF-LF", "31612345678"]
}

Response Success

Status Code: 200 OK
Content-Type: application/json
Body: A single Customer Object

Example

HTTP/1.1 200
Content-Type: application/json
Transfer-Encoding: chunked

{
    "id" : "632785d0-e01b-466d-8048-f5539665444d",
    "externalId" : "a2d33fe6",
    "customerReference" : "123456789",
    "registrationExpiration": 1612194997000,
    "linkReferences" : ["123456789", "49-LF-LF", "31612345678"],
    "created": 1612195375000,
    "lastUpdated" : 1612195375000,
    "registered" : null
}

Response Error: Invalid data

Status Code: 400 Bad Request
Content-Type: application/json
Body: A Error

{
  "type" : "input_error",
  "message" : "customerReference is invalid",
  "reference" : "718ee617",
  "field" : "customerReference",
  "fields": [
      {
        "field": "customerReference",
        "message": "size must be between 1 and 64"
      }
    ]
}

Response Error: External Id Not Unique

Status Code: 400 Bad Request
Content-Type: application/json
Body: A Error

{
  "type" : "input_error",
  "message" : "externalId is not unique",
  "reference" : "718ee617",
  "field" : "externalId",
  "fields": [
      {
        "field": "externalId",
        "message": "the value must be unique"
      }
    ]
}

Response Error: Others

See Error Handling for other possible error responses.

Action: Get Customer

Retrieve a customer from the merchant account.

Request

Resource: /api/v1/customer/{id}
Method: GET
Authentication: Required
Path Parameters:

Name	Type	Size	Format	Inclusion	Description
id	string		UUID Type 4	Required	The unique UUID assigned by the PSP to the customer

Example

GET /api/v1/customer/632785d0-e01b-466d-8048-f5539665444d HTTP/1.1
Host: api.psp.ccv.eu
User-Agent: curl/7.74.0
Accept: application/json

Response Success

Status Code: 200 OK
Content-Type: application/json
Body: A single Customer Object

Response Error: Customer not found

Status Code: 404 Not Found
Content-Type: application/json
Body: A Error

{
  "type" : "input_error",
  "message" : "Customer not found",
  "reference" : "718ee617",
  "field" : "id"
}

Response Error: Others

See Error Handling for other possible error responses.

Action: Update Customer

Use an update to enable/disable card linking, remove link references, etc.

!IMPORTANT An update must contain the new state of the customer. Partial updates (‘patching’) is not supported. Undefined fields are interpreted as null and overwrite any value set for those fields.

Request

Resource: /api/v1/customer/{id}
Method: PUT
Authentication: Required
Content-Type: application/json
Path Parameters:

Name	Type	Size	Format	Inclusion	Description
id	string		UUID Type 4	Required	The unique UUID assigned by the PSP to the customer

Request Body

Name	Type	Size	Format	Inclusion	Description
externalId	string	max 64		Optional	The unique ID assigned by the merchant to the customer
customerReference	string	max 64		Required	The reference to link with payment cards
registrationExpiration	integer		Unix Epoch Time in milliseconds	Required	The timestamp after which the registration can no longer be valid
linkReferences	array	25	Link Reference	Optional	The list of link references to identify the customer when creating card links

Example - Disable card linking

PUT /api/v1/customer/632785d0-e01b-466d-8048-f5539665444d HTTP/1.1
Host: api.psp.ccv.eu
user-agent: curl/7.74.0
accept: application/json
content-type: application/json

{
    "externalId" : "a2d33fe6",
    "customerReference" : "123456789",
    "registrationExpiration": 0,
    "linkReferences" : ["123456789", "49-LF-LF", "31612345678"]
}

Example - Add a link reference

Given that the link references of the customer are 123456789, 49-LF-LF, 31612345678, when you want to add reference ABCDE then send a list of the current and new references, 123456789, 49-LF-LF, 31612345678, ABCDE

PUT /api/v1/customer/632785d0-e01b-466d-8048-f5539665444d HTTP/1.1
Host: api.psp.ccv.eu
user-agent: curl/7.74.0
accept: application/json
content-type: application/json

{
    "externalId" : "a2d33fe6",
    "customerReference" : "123456789",
    "registrationExpiration": 1612194997000,
    "linkReferences" : ["123456789", "49-LF-LF", "31612345678", "ABCDE"]
}

Example - Remove a link reference

Given that the link references of the customer are 123456789, 49-LF-LF, 31612345678, when you want to remove reference 31612345678 then send a list containing the remaining references, 123456789, 49-LF-LF.

PUT /api/v1/customer/632785d0-e01b-466d-8048-f5539665444d HTTP/1.1
Host: api.psp.ccv.eu
user-agent: curl/7.74.0
accept: application/json
content-type: application/json

{
    "externalId" : "a2d33fe6",
    "customerReference" : "123456789",
    "registrationExpiration": 1612194997000,
    "linkReferences" : ["123456789", "49-LF-LF"]
}

Response Success

Status Code: 204 No Content

Response Error: Customer not found

Status Code: 404 Not Found
Content-Type: application/json
Body: A Error

{
  "type" : "input_error",
  "message" : "Customer not found",
  "reference" : "718ee617",
  "field" : "id"
}

Response Error: Others

See Error Handling for other possible error responses.

Action: Remove Customer

Remove a customer and their linked cards from the merchant account.

Important: All customer and card data is removed and unrecoverable.

Request

Resource: /api/v1/customer/{id}
Method: DELETE
Authentication: Required
Path Parameters:

Name	Type	Size	Format	Inclusion	Description
id	string		UUID Type 4	Required	The unique UUID assigned by the PSP to the customer

Example

DELETE /api/v1/customer/632785d0-e01b-466d-8048-f5539665444d HTTP/1.1
Host: api.psp.ccv.eu
user-agent: curl/7.74.0

Response Success

Status Code: 204 No Content

Response Error: Others

See Error Handling for other possible error responses.

Action: Get All Cards

Get all cards from a customer.

Request

Resource: /api/v1/customer/{id}/card
Method: GET
Authentication: Required
Content-Type: application/json
Path Parameters:

Name	Type	Size	Format	Inclusion	Description
id	string		UUID Type 4	Required	The unique UUID assigned by the PSP to the customer

Example

GET /api/v1/customer/9bfb4cc4-6555-11eb-ae93-0242ac130002/card HTTP/1.1
Host: api.psp.ccv.eu
user-agent: curl/7.74.0
accept: application/json

Response Success: Cards Found

Status Code: 200 OK
Content-Type: application/json
Body: An unsorted JSON array of objects with type Card Object

Example

[
    {
        "id" : "9bfb4cc4-6555-11eb-ae93-0242ac130002",
        "maskedPan" : "4111XXXXXXXX1111",
        "created" : 1612270671000,
        "lastUpdated" : 1612270671000
    },
    {
        "id" : "63ec8459-5e4c-4299-af83-57702241b67f",
        "maskedPan" : "5222XXXXXXXX2222",
        "created" : 1614327207000,
        "lastUpdated" : 1614327207000
    }
]

Response Success: No Cards Found

Status Code: 204 No Content

Response Error: Customer not found

Status Code: 404 Not Found
Content-Type: application/json
Body: A Error

{
  "type" : "input_error",
  "message" : "Customer not found",
  "reference" : "718ee617",
  "field" : "id"
}

Response Error: Others

See Error Handling for other possible error responses.

Action: Remove All Cards

Remove all cards from a customer.

Important: All card data is removed and unrecoverable.

Request

Resource: /api/v1/customer/{id}/card
Method: DELETE
Authentication: Required
Path Parameters:

Name	Type	Size	Format	Inclusion	Description
id	string		UUID Type 4	Required	The unique UUID assigned by the PSP to the customer

Example

DELETE /api/v1/customer/632785d0-e01b-466d-8048-f5539665444d/card HTTP/1.1
Host: api.psp.ccv.eu
user-agent: curl/7.74.0

Response Success

Status Code: 204 No Content

Response Error: Customer not found

Status Code: 404 Not Found
Content-Type: application/json
Body: A Error

{
  "type" : "input_error",
  "message" : "Customer not found",
  "reference" : "718ee617",
  "field" : "id"
}

Response Error: Others

See Error Handling for possible error responses.

Customers by external id

Manage customers with identifiers provided by the merchant. In order to differentiate between the operations of the Customers endpoint, all paths will start with /customer/externalId.

Action: Get Customer

Retrieve a customer from the merchant account.

Request

Resource: /api/v1/customer/externalId/{externalId}
Method: GET
Authentication: Required
Path Parameters:

Name	Type	Size	Format	Inclusion	Description
externalId	string	max 64		Required	The unique ID assigned by the merchant to the customer

Example

GET /api/v1/customer/externalId/a2d33fe6 HTTP/1.1
Host: api.psp.ccv.eu
User-Agent: curl/7.74.0
Accept: application/json

Response Success

Status Code: 200 OK
Content-Type: application/json
Body: An array of objects of type Customer Object

Response Error: Customer not found

Status Code: 404 Not Found
Content-Type: application/json
Body: A Error

{
  "type" : "input_error",
  "message" : "Customer not found",
  "reference" : "718ee617",
  "field" : "externalId"
}

Response Error: Others

See Error Handling for other possible error responses.

Action: Update Customer

Use an update to enable/disable card linking, remove link references, etc.

Request

Resource: /api/v1/customer/externalId/{externalId}
Method: PUT
Authentication: Required
Content-Type: application/json
Path Parameters:

Name	Type	Size	Format	Inclusion	Description
externalId	string	max 64		Required	The unique ID assigned by the merchant to the customer

Request Body

Name	Type	Size	Format	Inclusion	Description
externalId	string	max 64		Optional	The unique ID assigned by the merchant to the customer
customerReference	string	max 64		Required	The reference to link with payment cards
registrationExpiration	integer		Unix Epoch Time in milliseconds	Optional	The timestamp after which the registration can no longer be valid
linkReferences	array	25	Link Reference	Optional	The list of link references to identify the customer when creating card links

Example - Disable card linking

PUT /api/v1/customer/externalId/a2d33fe6 HTTP/1.1
Host: api.psp.ccv.eu
user-agent: curl/7.74.0
accept: application/json
content-type: application/json

{
    "externalId" : "a2d33fe6",
    "customerReference" : "123456789",
    "registrationExpiration": 0,
    "linkReferences" : ["123456789", "49-LF-LF", "31612345678"]
}

Example - Add a link reference

PUT /api/v1/customer/externalId/a2d33fe6 HTTP/1.1
Host: api.psp.ccv.eu
user-agent: curl/7.74.0
accept: application/json
content-type: application/json

{
    "externalId" : "a2d33fe6",
    "customerReference" : "123456789",
    "registrationExpiration": 1612194997000,
    "linkReferences" : ["123456789", "49-LF-LF", "31612345678", "ABCDE"]
}

Example - Remove a link reference

PUT /api/v1/customer/externalId/a2d33fe6 HTTP/1.1
Host: api.psp.ccv.eu
user-agent: curl/7.74.0
accept: application/json
content-type: application/json

{
    "externalId" : "a2d33fe6",
    "customerReference" : "123456789",
    "registrationExpiration": 1612194997000,
    "linkReferences" : ["123456789", "49-LF-LF"]
}

Response Success

Status Code: 204 No Content

Response Error: Customer not found

Status Code: 404 Not Found
Content-Type: application/json
Body: A Error

{
  "type" : "input_error",
  "message" : "Customer not found",
  "reference" : "718ee617",
  "field" : "externalId"
}

Response Error: Others

See Error Handling for other possible error responses.

Action: Remove Customer

Remove a customer and their linked cards from the merchant account.

Important: All customer and card data is removed and unrecoverable.

Request

Resource: /api/v1/customer/externalId/{externalId}
Method: DELETE
Authentication: Required
Path Parameters:

Name	Type	Size	Format	Inclusion	Description
externalId	string	max 64		Required	The unique ID assigned by the merchant to the customer

Example

DELETE /api/v1/customer/externalId/a2d33fe6 HTTP/1.1
Host: api.psp.ccv.eu
user-agent: curl/7.74.0

Response Success

Status Code: 204 No Content

Response Error: Others

See Error Handling for other possible error responses.

Action: Get All Cards

Get all cards from a customer.

Request

Resource: /api/v1/customer/externalId/{externalId}/card
Method: GET
Authentication: Required
Content-Type: application/json
Path Parameters:

Name	Type	Size	Format	Inclusion	Description
externalId	string	max 64		Required	The unique ID assigned by the merchant to the customer

Example

GET /api/v1/customer/externalId/a2d33fe6/card HTTP/1.1
Host: api.psp.ccv.eu
user-agent: curl/7.74.0
accept: application/json

Response Success: Cards Found

Status Code: 200 OK
Content-Type: application/json
Body: An unsorted JSON array of objects with type Card Object

Example

[
    {
        "id" : "9bfb4cc4-6555-11eb-ae93-0242ac130002",
        "maskedPan" : "4111XXXXXXXX1111",
        "created" : 1612270671000,
        "lastUpdated" : 1612270671000
    },
    {
        "id" : "63ec8459-5e4c-4299-af83-57702241b67f",
        "maskedPan" : "5222XXXXXXXX2222",
        "created" : 1614327207000,
        "lastUpdated" : 1614327207000
    }
]

Response Success: No Cards Found

Status Code: 204 No Content

Response Error: Customer not found

Status Code: 404 Not Found
Content-Type: application/json
Body: A Error

{
  "type" : "input_error",
  "message" : "Customer not found",
  "reference" : "718ee617",
  "field" : "externalId"
}

Response Error: Others

See Error Handling for other possible error responses.

Action: Remove All Cards

Remove all cards from a customer.

Important: All card data is removed and unrecoverable.

Request

Resource: /api/v1/customer/externalId/{externalId}/card
Method: DELETE
Authentication: Required
Path Parameters:

Name	Type	Size	Format	Inclusion	Description
externalId	string	max 64		Required	The unique ID assigned by the merchant to the customer

Example

DELETE /api/v1/customer/externalId/a2d33fe6/card HTTP/1.1
Host: api.psp.ccv.eu
user-agent: curl/7.74.0

Response Success

Status Code: 204 No Content

Response Error: Customer not found

Status Code: 404 Not Found
Content-Type: application/json
Body: A Error

{
  "type" : "input_error",
  "message" : "Customer not found",
  "reference" : "718ee617",
  "field" : "externalId"
}

Response Error: Others

See Error Handling for possible error responses.

Customers by reference

Manage customers with identifiers provided by the merchant.

Action: Get Customer

Retrieve a customer from the merchant account.

Request

Resource: /api/v1/customer?customerReference={customerReference}&page={page}&size={size}
Method: GET
Authentication: Required
Content-Type: application/json
Parameters:

Name	Type	Size	Inclusion	Description
customerReference	string	max 64	Required	The reference to link with payment cards
page	integer		Optional	The page of customers that is requested. First page is 0. (default = 0)
size	integer	max 50	Optional	The number of customers that is requested per page. (default = 10)

Example

GET /api/v1/customer?customerReference=123456789&page=0&size=10 HTTP/1.1
Host: api.psp.ccv.eu
user-agent: curl/7.74.0
accept: application/json
content-type:application/json

Response Success

Status Code: 200 OK
Content-Type: application/json
Body: A Paged Customer Object List

Example

HTTP/1.1 200
Content-Type: application/json
Transfer-Encoding: chunked

{
   "data": [
      {
          "id" : "632785d0-e01b-466d-8048-f5539665444d",
          "externalId" : "a2d33fe6",
          "customerReference" : "123456789",
          "registrationExpiration": 1612194997000,
          "linkReferences" : ["123456789", "49-LF-LF", "31612345678"],
          "created": 1612195375000,
          "lastUpdated" : 1612195375000,
          "registered" : null
      },
      {
          "id" : "812fd81d-8682-4da7-b981-cd0859bcb04a",
          "externalId" : "b1cc9f8a",
          "customerReference" : "123456789",
          "registrationExpiration": 1612194997000,
          "linkReferences" : ["LR-001"],
          "created": 1612195395000,
          "lastUpdated" : 1612195395000,
          "registered" : null
      }
   ],
   "page" : {
      "size": 10,
      "totalElements": 2,
      "totalPages": 1,
      "number": 0
   }
}

Cards

Action: Get Card

Request

Resource: /api/v1/card/{id}
Method: GET
Authentication: Required
Content-Type: application/json
Path Parameters:

Name	Type	Size	Format	Inclusion	Description
id	string		UUID Type 4	Required	The unique UUID assigned by the PSP to the card

Example

GET /api/v1/card/9bfb4cc4-6555-11eb-ae93-0242ac130002 HTTP/1.1
Host: api.psp.ccv.eu
user-agent: curl/7.74.0
accept: application/json

Response Success

Status Code: 200 OK
Content-Type: application/json
Body: An object of type Card Object

Example

{
    "id" : "9bfb4cc4-6555-11eb-ae93-0242ac130002",
    "maskedPan" : "4111XXXXXXXX1111",
    "created" : 1612270671000,
    "lastUpdated" : 1612270671000
}

Response Error: Card not found

Status Code: 404 Not Found
Content-Type: application/json
Body: A Error

{
  "type" : "input_error",
  "message" : "Card not found",
  "reference" : "718ee617",
  "field" : "id"
}

Response Error: Others

See Error Handling for other possible error responses.

Action: Remove Card

Remove a single payment card from a customer.

Request

Resource: /api/v1/card/{id}
Method: DELETE
Authentication: Required
Path Parameters:

Name	Type	Size	Format	Inclusion	Description
id	string		UUID Type 4	Required	The unique UUID assigned by the PSP to the card

Example

DELETE /api/v1/card/5b878db4-6556-11eb-ae93-0242ac130002 HTTP/1.1
Host: api.psp.ccv.eu
user-agent: curl/7.74.0

Response Success

Status Code: 204 No Content

Response Error: Others

See Error Handling for possible error responses.

Discover

EV Charging

Our solutions

CCV Terminal

SoftPOS

CCV Online Payments

Connect to the CCV Platform

Payment API

What's on this page

Online Payments / Payment Features / Customers & Loyalty

Customers

Use Case Loyalty

In-store functionality

Online functionality

How it works (when and how to use the API calls)

1. Pre-registration before linking

2. Retrieve link information to inform the customer

3. Remove the link

4. Remove the customer

5. Multiple cards, mobile phones, and or wearable devices

API Changes

Schemas

Customer Object

Link Reference Object

Paged Customers Object

Page Object

Card Object

Customers by id

Action: Add Customer

Request

Example

Response Success

Example

Response Error: Invalid data

Response Error: External Id Not Unique

Response Error: Others

Action: Get Customer

Request

Example

Response Success

Response Error: Customer not found

Response Error: Others

Action: Update Customer

Request

Example - Disable card linking

Example - Add a link reference

Example - Remove a link reference

Response Success

Response Error: Customer not found

Response Error: Others

Action: Remove Customer

Request

Example

Response Success

Response Error: Others

Action: Get All Cards

Request

Example

Response Success: Cards Found

Example

Response Success: No Cards Found

Response Error: Customer not found

Response Error: Others

Action: Remove All Cards

Request

Example

Response Success

Response Error: Customer not found

Response Error: Others

Customers by external id

Action: Get Customer

Request

Example

Response Success

Response Error: Customer not found

Response Error: Others

Action: Update Customer

Request

Example - Disable card linking

Example - Add a link reference