Register member at payment location - v2

curl --request POST \
  --url https://{host}/payment/v2/checkin/{paymentLocation} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "memberId": "<string>",
  "loyaltyCardId": "<string>",
  "phone": "<string>",
  "code": "<string>"
}
'

import requests

url = "https://{host}/payment/v2/checkin/{paymentLocation}"

payload = {
    "memberId": "<string>",
    "loyaltyCardId": "<string>",
    "phone": "<string>",
    "code": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    memberId: '<string>',
    loyaltyCardId: '<string>',
    phone: '<string>',
    code: '<string>'
  })
};

fetch('https://{host}/payment/v2/checkin/{paymentLocation}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/payment/v2/checkin/{paymentLocation}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'memberId' => '<string>',
    'loyaltyCardId' => '<string>',
    'phone' => '<string>',
    'code' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/payment/v2/checkin/{paymentLocation}"

	payload := strings.NewReader("{\n  \"memberId\": \"<string>\",\n  \"loyaltyCardId\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"code\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/payment/v2/checkin/{paymentLocation}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"memberId\": \"<string>\",\n  \"loyaltyCardId\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"code\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/payment/v2/checkin/{paymentLocation}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"memberId\": \"<string>\",\n  \"loyaltyCardId\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"code\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "memberId": "<string>",
  "paymentAmountLimit": 123,
  "paymentMethods": [
    {
      "id": "<string>",
      "type": "Bonus",
      "availableBalance": 123
    }
  ],
  "coupons": [
    {
      "couponId": "<string>",
      "campaignId": "<string>"
    }
  ],
  "isEmployee": true
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

POST

checkin

{paymentLocation}

curl --request POST \
  --url https://{host}/payment/v2/checkin/{paymentLocation} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "memberId": "<string>",
  "loyaltyCardId": "<string>",
  "phone": "<string>",
  "code": "<string>"
}
'

import requests

url = "https://{host}/payment/v2/checkin/{paymentLocation}"

payload = {
    "memberId": "<string>",
    "loyaltyCardId": "<string>",
    "phone": "<string>",
    "code": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    memberId: '<string>',
    loyaltyCardId: '<string>',
    phone: '<string>',
    code: '<string>'
  })
};

fetch('https://{host}/payment/v2/checkin/{paymentLocation}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/payment/v2/checkin/{paymentLocation}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'memberId' => '<string>',
    'loyaltyCardId' => '<string>',
    'phone' => '<string>',
    'code' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/payment/v2/checkin/{paymentLocation}"

	payload := strings.NewReader("{\n  \"memberId\": \"<string>\",\n  \"loyaltyCardId\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"code\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/payment/v2/checkin/{paymentLocation}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"memberId\": \"<string>\",\n  \"loyaltyCardId\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"code\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/payment/v2/checkin/{paymentLocation}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"memberId\": \"<string>\",\n  \"loyaltyCardId\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"code\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "memberId": "<string>",
  "paymentAmountLimit": 123,
  "paymentMethods": [
    {
      "id": "<string>",
      "type": "Bonus",
      "availableBalance": 123
    }
  ],
  "coupons": [
    {
      "couponId": "<string>",
      "campaignId": "<string>"
    }
  ],
  "isEmployee": true
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

paymentLocation

string

required

Unique identifier of POS in payment service

Maximum string length: 128

Body

The check in method used

memberId

string | null

The member identifier

Maximum string length: 36

loyaltyCardId

string | null

The loyalty card identifier

phone

string | null

The member phone number

code

string | null

THe generated check in code

Response

memberId

string | null

The id of member.

paymentAmountLimit

number<double>

The daily amount limit of payment.

paymentMethods

object[] | null

Available methods of payment.

Show child attributes

coupons

object[] | null

Available member coupons.

Show child attributes

isEmployee

boolean | null

Indicates whether the member is an employee. Populated only when the CheckInMember_IncludeIsEmployee feature flag is enabled.

Last modified on August 10, 2026

⌘I