Headers & Common Fields

Barcodes and Store Locations Headers

Header Information

FieldRequired?Description
x-gdn-timestampYesTimestamp in http headeris using the pattern[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss][timezone] that preserves timezone information andcomplies with ISO 8601.The time zone componentis an offset from UTC (forexample, +01:00,-07:00).The time zone componentuses ‘Z’ (which stands forzero offset) to representUTC. Timestamp stringwithout time zonecomponent is assumed tobe UTC. Examples of thetimestamp string are202005-22T03:07:53Z
x-gdn-signatureYesSignature of the message(see API Authenticationsection below
x-gdn-encryptiontypeYes0-none, 1-Digital Signature
x-gdn-sessionidNoSession id of thetransaction (for future use,will be empty)
x-gdn-messageidYesUnique id of the transaction
x-gdn-channeltypeYes1-mobile, 2–web, 0-other
x-gdn-deviceidNoDevice id of the clientmaking the API call (forfuture use)
x-gdn-devicetypeYes0-other, 1-mobile, 2-desktop
x-gdn-ipaddressYesIP Address of the clientmaking the API call
x-gdn-latitudeNoLatitude of the clientdevice/browser making theAPI call
x-gdn-longitudeNoLongitude of the clientdevice/browser making theAPI call
x-gdn-programnumberYesProgram number assignedby Green Dot
x-gdn-ext-programnumberNoExt ProgramNumberassigned by Green Dot

Barcodes and Store Locations Common Response Fields

These fields are common in all the API responses and the consumer should expect a valid value for this fields.

ParameterDatatypeDescription
partner_transaction_referenceStringTransactionReference of the partner if the partner passes this information
gd_transaction_referenceStringUnique reference for this transaction generated by Gd
gd_response_codeIntRefer to Response CodesSection
gd_response_messageStringCustom text describing the success or failure of the API.
gd_response_dateDateTimeResponse date time in UTC