GRgreendot
Barcode

Retrieve a barcode

Retrieves barcode details by barcode number and retailer key.

get/v1/Barcode/{gd_barcode_id}/Retailer/{gd_retailer_key}

Request

  • Base URL
    https://partners.dev.nextestate.com/GDCPartners/API
  • URL
    https://partners.dev.nextestate.com/GDCPartners/API/v1/Barcode/{gd_barcode_id}/Retailer/{gd_retailer_key}
  • Auth
    none declared. Required headers: x-gdn-programnumber, x-gdn-channeltype, x-gdn-devicetype, x-gdn-messageid, x-gdn-encryptiontype, x-gdn-signature, x-gdn-ipaddress, x-gdn-timestamp

Path parameters

gd_barcode_idstring required

Barcode number which has been generated as part of Barcode Generation API ( v1/Barcode )

gd_retailer_keyinteger required

Retailer key associated to program number

Headers

x-gdn-programnumberstring required

Program Number

x-gdn-channeltypestring required

Channel Type

x-gdn-longitudestring

Longitude

x-gdn-latitudestring

Latitude

x-gdn-devicetypestring required

Device Type

x-gdn-deviceidstring

Device ID

x-gdn-messageidstring required

Message ID

x-gdn-sessionidstring

Session Id

x-gdn-encryptiontypestring required

Encryption Type

x-gdn-signaturestring required

Signature hash

x-gdn-ipaddressstring required

Client IP Address

x-gdn-timestampstring required

UTC Timestamp

Response

OK

gd_barcode_idstring

Barcode number or Barcode link code based on the type of barcode generated

gd_barcode_id_expirationstring date-time

Expiration datetime of the barcode or barcode link based on the type selected

gd_retailer_keyinteger

Retailer selected for generating the barcode

gd_retailer_namestring

Retailer Name as per GD system

gd_barcode_change_datestring date-time

Last Change DateTime of the barcode

sender_customer_refstring

It is echo of sender_customer_ref field which is received as part of input.

gd_barcode_statusinteger

1 = New,2 = Pending,3 = Consumed,4 = Voided,5 = Expired,6 = Cancelled,7 = Declined

amountnumber double

Amount if it is associated with the barcode at the time of generation or if the barcode is consumed

partner_transaction_referencestring

partner_transaction_reference TransactionReference of the partner if the partner passes this information

gd_transaction_referencestring

gd_transaction_reference Unique reference for this transaction generated by Gd

gd_response_codeinteger

gd_response_code

gd_response_messagestring

gd_response_message Custom text describing the success or failure of the API.

gd_response_datestring date-time

gd_response_date Response date time in UTC

Changes

No recorded changes to this operation across all 1 revision of this API.