---
title: "List all retailers"
method: GET
path: "/v2/retailers"
tags: ["Retailer"]
---

# List all retailers

`GET /v2/retailers`

## Request

- Base URL: `https://partners.dev.nextestate.com/GDCPartners/API`
- URL: `https://partners.dev.nextestate.com/GDCPartners/API/v2/retailers`
- 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`

Retrieves the list of retailers for the program.

## Headers

- `x-gdn-programnumber` string, required
- `x-gdn-channeltype` string, required
- `x-gdn-longitude` string
- `x-gdn-latitude` string
- `x-gdn-devicetype` string, required
- `x-gdn-deviceid` string
- `x-gdn-messageid` string, required
- `x-gdn-sessionid` string
- `x-gdn-encryptiontype` string, required
- `x-gdn-signature` string, required
- `x-gdn-ipaddress` string, required
- `x-gdn-timestamp` string, required

## Response `200`

OK

- GetRetailerDetailResponse
  - `retailer_list` RetailerDetail[]: Retailer List for the given program number
    - `dictionary_entry` object: dictionary entry
    - `retailer_key` integer: Greendot retailer key
    - `short_name` string: short name for retailer
    - `description` string: retailer description
  - `partner_transaction_reference` string: partner_transaction_reference TransactionReference of the partner if the partner passes this information
  - `gd_transaction_reference` string: gd_transaction_reference Unique reference for this transaction generated by Gd
  - `gd_response_code` integer: gd_response_code
  - `gd_response_message` string: gd_response_message Custom text describing the success or failure of the API.
  - `gd_response_date` string, date-time: gd_response_date Response date time in UTC

---

[API](https://skmtc.dev/greendot/apis/cash-deposits-and-payments.md) - [All operations](https://skmtc.dev/greendot/apis/cash-deposits-and-payments/llms.txt) - [OpenAPI document](https://skmtc.dev/greendot/apis/cash-deposits-and-payments/revisions/9908e094c93e?raw)