v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Barcode

Void a barcode

Void a barcode by barcode number.

post/v1/Barcode/{gd_barcode_id}/status/{gd_barcode_status}

Path parameters

gd_barcode_idstring required

Barcode number which has been generated as part of Barcode Generation API

gd_barcode_statusstring required

Only 5(Expired) and 6(Cancelled) are allowed, use 5 to expire current barcode and create a new barcode for customer. Use 6 to cancel the barcode when customer payments are complete, and barcode is no longer required.

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_statusinteger

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

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