Skip to content

Giftcard Payments

Giftcard Payments can be used to send giftcard payments data for sales transactions involving gift cards as a payment method.

It streamlines the management of giftcard payment information and usage, ensuring accuracy and consistency in sales records.

Operations

Upload list of giftcard payments

Request

POST https://api.zoined.com/giftcardPayments?dryRun=false&separator=%3B&encoding=utf-8

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=false
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
giftcard_idstringrequired

Unique ID for the gift card.

Example:"A67gigMp"
giftcard_numberstringrequired

Gift card number

Example:"7TON39"
giftcard_statusstringrequired

Gift card status

Example:"Active"
giftcard_balancenumber

Gift card balance

Example:50
creation_datestringrequired

Gift card creation date (yyyy-mm-dd)

Example:"2016-01-01"
creation_timestring

Gift card creation time (HH:mm:ss)

Example:"15:00:00"
expiration_datestring

Gift card expiration date (yyyy-mm-dd)

Example:"2017-01-01"
expiration_timestring

Gift card expiration time (HH:mm:ss)

Example:"15:00:00"
sales_idstring

Sales Id

Example:"dbeba367"
organisation_idstringrequired

Organisation/Store ID

Example:"540"
department_idstring

Store department ID

Example:"5401"
register_idstring

Cash register ID

Example:"32"
salesperson_idstring

Sales person ID

Example:"5402101"
customer_idstring

Customer ID for identified customer

Example:"32"
payment_idstringrequired

Payment method ID

Example:"A65A"
payment_typestringrequired

Payment type

Example:"Activation"
payment_datestringrequired

Payment date (yyyy-mm-dd)

Example:"2016-05-15"
payment_timestringrequired

Payment time (HH:mm:ss)

Example:"15:00:00"
payment_valuenumberrequired

Payment amount

Example:20
payment_currencystring

Currency as ISO 4217 currency code. Required if multiple currencies are used.

Example:"EUR"
custom_field_1string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_2string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_3string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_4string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_5string

Field that can be used for custom dimensions

Example:"XYZ"
custom_metric_1number

Custom metric 1

Example:1
custom_metric_2number

Custom metric 2

Example:100
custom_metric_3number

Custom metric 3

Example:2.2
custom_metric_4number

Custom metric 4

Example:1.05
custom_metric_5number

Custom metric 5

Example:10000
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/giftcardPayments?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "giftcard_id": "A67gigMp",
    "giftcard_number": "7TON39",
    "giftcard_status": "Active",
    "giftcard_balance": 50,
    "creation_date": "2016-01-01",
    "creation_time": "15:00:00",
    "expiration_date": "2017-01-01",
    "expiration_time": "15:00:00",
    "sales_id": "dbeba367",
    "organisation_id": "540",
    "department_id": "5401",
    "register_id": "32",
    "salesperson_id": "5402101",
    "customer_id": "32",
    "payment_id": "A65A",
    "payment_type": "Activation",
    "payment_date": "2016-05-15",
    "payment_time": "15:00:00",
    "payment_value": 20,
    "payment_currency": "EUR",
    "custom_field_1": "XYZ",
    "custom_field_2": "XYZ",
    "custom_field_3": "XYZ",
    "custom_field_4": "XYZ",
    "custom_field_5": "XYZ",
    "custom_metric_1": 1,
    "custom_metric_2": 100,
    "custom_metric_3": 2.2,
    "custom_metric_4": 1.05,
    "custom_metric_5": 10000,
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
statusstringrequired

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}