Retailers API Methods

Obtaining a List of Retailers

The Retailer API searches and retrieves a list of retailers for a given program.

Structure of API Calls:

GET ~/v1/retailers

GET ~/v1/retailers/partner_ref/{partner_transaction_reference}

Sample Request Parameters

URL: ~/v1/retailers

URL: ~/v1/retailers/partner_ref/1234

Headers

{
   x-gdn-timestamp:2020-06-18T06:07:44Z
   x-gdn-encryptiontype:1 
   x-gdn-messageid:61aa6e58-b442-4839-8432-948af2fad3c5 
   x-gdn-channeltype:1
   x-gdn-devicetype:2
   x-gdn-ipaddress:192.168.1.1
   x-gdn-programnumber:Bahu-BC2019
   x-gdn-signature:8674485661DF66A6A7F28CD23AC0D3464EAAB455409CB63D3A845446728CDFF4
}

Request Parameters Field Descriptions

Response Model

{
      "retailer_list": [
            {
                  "retailer_key": 0,
                  "short_name": "string",
                  "description": "string"
            }
      ],
      "partner_transaction_reference": "string",
      "gd_transaction_reference": "string",
      "gd_response_code": 0,      
      "gd_response_message": "string",  
      "gd_response_date": "2022-05-06T13:07:44.798Z"
}

Sample Response 1

<get_retailer_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://greendotcorp.com/WebServices/Corporate/GDFNReloadServices/">
<gd_response_code>0</gd_response_code>
<gd_response_date>2020-06-19T07:34:50.8240298Z</gd_response_date>
<gd_response_message>Success</gd_response_message>
<gd_transaction_reference>0883f7c0-c125-4985-baa4-e15ad290315f
</gd_transaction_reference>
<partner_transaction_reference></partner_transaction_reference>
<retailer_list>
<retailer>
<description>7-Eleven</description>
<retailer_key>2481</retailer_key>
<short_name>7ELVN</short_name>
</retailer>
<retailer>
<description>CVS</description>
<retailer_key>2433</retailer_key>
<short_name>CVS</short_name>
</retailer>
<retailer>
<description>Duane Reade</description>
<retailer_key>10796</retailer_key>
<short_name>DuaneReade</short_name>
</retailer>
<retailer>
<description>Rite Aid</description>
<retailer_key>2460</retailer_key>
<short_name>RIAID</short_name>
</retailer>
retailer>
<description>Walgreens</description>
<retailer_key>10794</retailer_key>
<short_name>Walgreens</short_name>
</retailer>
<retailer>
<description>Walmart</description>
<retailer_key>2812</retailer_key>
<short_name>Walmart</short_name>
</retailer>
</retailer_list>
</get_retailer_response>

Sample Response 2

<get_retailer_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://greendotcorp.com/WebServices/Corporate/GDFNReloadServices/">
<gd_response_code>0</gd_response_code>
<gd_response_date>2020-06-19T07:33:31.9310279Z</gd_response_date>
<gd_response_message>Success</gd_response_message>
<gd_transaction_reference>110892f9-3ad7-45a5-8c18-dda0cb1664d0
</gd_transaction_reference>
<partner_transaction_reference>1234</partner_transaction_reference>
<retailer_list>
<retailer>
<description>7-Eleven</description>
<retailer_key>2481</retailer_key>
<short_name>7ELVN</short_name>
</retailer>
<retailer>
<description>CVS</description>
<retailer_key>2433</retailer_key>
<short_name>CVS</short_name>
</retailer>
<retailer>
<description>Duane Reade</description>
<retailer_key>10796</retailer_key>
<short_name>DuaneReade</short_name>
</retailer>
<retailer>
<description>Rite Aid</description>
<retailer_key>2460</retailer_key>
<short_name>RIAID</short_name>
</retailer>
<retailer>
<description>Walgreens</description>
<retailer_key>10794</retailer_key>
<short_name>Walgreens</short_name>
</retailer>
<retailer>
<description>Walmart</description>
<retailer_key>2812</retailer_key>
<short_name>Walmart</short_name>
</retailer>
</retailer_list>
</get_retailer_response></get_retailer_response>

Response Field Descriptions