Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Barcode

Create a barcode for cash deposit or payment

Creates a barcode number or barcode link for a cash deposit or cash payment transaction.

post/v2/Barcode

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

Request body

gd_retailer_keyinteger

Retailer for which the barcode is being generated. The barcode number might be different based on the retailer. GD will provide the list of RetailerKeys to the consumer of the API

gd_barcode_type0 | 1 | 2 | 3 | 4

1-BarcodeLink, 2-BarcodeForPrint, 3-BarcodeForView, 4-MultiUseBarcode

gd_barcode_payment_type0 | 1 | 2 | 3

0-None, 1-Deposit, 2-Payment, 3-Debit

amountnumber double

Amount for which the barcode is being generated

amount_match_type0 | 1 | 2

0-No constraint, barcode can be consumed without constraint on amount. 1-Partial consumption, barcode must be consumed less than or equal to the amount specified in amount parameter(Not currently supported). 2-Full consumption, barcode must be consumed with exact amount specified in amount parameter. By default, amount_match_type is 0.

partner_transaction_referencestring

Transaction Reference for the current transaction (eg send money request, etc). This is the reference generated/maintained by Partner. GD will use it for audit purposes.

sender_customer_refstring

Identifier/Reference which the partner generates for the source (/sender) of this transaction. Eg., If A is trying to send money to B, this is an identifier/ reference of A's account.

sender_first_namestring

First Name of the sender

sender_last_namestring

Last Name of the sender

sender_emailstring

Email address of the sender

sender_phonestring

phone number of the sender

sender_addressstring

address of the sender

sender_zipcodestring

Zip code of the sender

recipient_customer_refstring

Identifier/Reference which the partner generates for the target (/receiver) of this transaction. Eg., If A is trying to send money to B, this is an identifier/ reference of B's account.

recipient_first_namestring

First Name of the target account

recipient_last_namestring

Last Name of the target account

recipient_emailstring

Email address of the recipient

recipient_phonestring

phone number of the recipient

recipient_addressstring

address of the recipient

recipient_zipcodestring

Zip code of the recipient

notification_channel_type0 | 1 | 2 | 3 | 4 | 5 | 6 | 7

0 - none, 1 - SMS, 2 - Email

extensioninfosobject

Extension Infos

Response

OK

gd_barcode_linkstring

Complete Barcode link for Barcode link code

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_barcode_type0 | 1 | 2 | 3 | 4

barcode type. 1-BarcodeLink, 2-BarcodeForPrint, 3-BarcodeForView, 4-MultiUseBarcode

gd_barcode_payment_type0 | 1 | 2 | 3

0-None, 1-Deposit, 2-Payment, 3-Debit

gd_retailer_namestring

Retailer against which the barcode is generated

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