---
updatedAt: 2026-02-12T23:02:04.000Z
agentTools:
  projectIndex: https://docs.withreach.com/llms.txt
---

# /badge

Retrieve location declaration information from Reach. For more information see [Reach disclaimer and Terms of Service requirements](https://docs.withreach.com/docs/reach-disclaimer-and-terms-of-service-requirements).


# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "2.22",
    "title": "Reach Checkout API",
    "contact": {
      "email": "support@withreach.com"
    },
    "description": "June 2022 <br>withreach.com<br>docs.withreach.com<br><br> Reach's Checkout API provides suppliers the ability to execute and manage payment processing for consumer orders while retaining control over the shopper experience and limiting PCI DSS exposure. Creating payment orders, refunding payments, and querying available foreign exchange rates and payment methods are all provided by this JSON-based API.\n"
  },
  "servers": [
    {
      "description": "Reach Sandbox",
      "url": "https://checkout.rch.how/v2.22"
    },
    {
      "description": "Reach Dev",
      "url": "https://checkout.rch.red/v2.22"
    }
  ],
  "paths": {
    "/badge": {
      "get": {
        "operationId": "badge",
        "description": "Retrieve location declaration information from Reach. For more information see [Reach disclaimer and Terms of Service requirements](https://docs.withreach.com/docs/reach-disclaimer-and-terms-of-service-requirements).\n",
        "parameters": [
          {
            "name": "MerchantId",
            "in": "query",
            "description": "The 36 character GUID which identifies the supplier to the Reach system.\n",
            "required": true,
            "schema": {
              "description": "The 36 character GUID which identifies the supplier to the Reach system.\n",
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "Locale",
            "in": "query",
            "description": "The specified Locale code to translate the badge. If no Locale is specified, we will default to English (US). For Locale options, please see information here: https://docs.withreach.com/docs/request-format.\n",
            "required": false,
            "schema": {
              "description": "JSONP Javascript function name.",
              "type": "string"
            }
          },
          {
            "name": "Callback",
            "in": "query",
            "description": "The JSONP Javascript function to call.",
            "schema": {
              "description": "JSONP Javascript function name.",
              "type": "string"
            }
          },
          {
            "name": "Currency",
            "in": "query",
            "description": "If the consumer currency to be used is already known, the upper-case 3 character ISO 4217 currency code.\n",
            "schema": {
              "description": "An upper-case 3 character ISO 4217 currency code.",
              "type": "string",
              "pattern": "^[A-Z]{3}$"
            }
          },
          {
            "name": "ConsumerIpAddress",
            "in": "query",
            "description": "This parameter can be specified if the request is being made on behalf of the consumer, not directly via the consumer's browser.\n",
            "schema": {
              "description": "A valid IP address, v4 or v6.",
              "oneOf": [
                {
                  "type": "string",
                  "format": "ipv4"
                },
                {
                  "type": "string",
                  "format": "ipv6"
                }
              ]
            }
          },
          {
            "name": "Theme",
            "in": "query",
            "description": "The logo and html returned by badge will be themed based on this  parameter’s value. This parameter can be set to **light** or **dark**.  Defaults to the light theme.\n",
            "schema": {
              "type": "string",
              "enum": [
                "light",
                "dark"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Either the text or image should be displayed and linked to the  TermsOfServiceUrl.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "Text": {
                      "description": "The text to display.",
                      "type": "string"
                    },
                    "Html": {
                      "description": "The HTML snippet to display.",
                      "type": "string"
                    },
                    "ImageUrl": {
                      "description": "The image to display.",
                      "type": "string",
                      "format": "uri"
                    },
                    "TermsOfServiceUrl": {
                      "description": "The location that the text or image should link to.",
                      "type": "string",
                      "format": "uri"
                    },
                    "MerchantOfRecord": {
                      "description": "The name of the entity handling the payment.",
                      "type": "string"
                    },
                    "MerchantOfRecordUrl": {
                      "description": "The location of the Merchant of Record website.",
                      "type": "string",
                      "format": "uri"
                    },
                    "MerchantName": {
                      "description": "As a convenience, the name of the supplier associated with the specified MerchantId.\n",
                      "type": "string"
                    },
                    "FlagImageUrl": {
                      "description": "The flag image associated with the Merchant of Record.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "Text",
                    "Html",
                    "ImageUrl",
                    "TermsOfServiceUrl",
                    "MerchantOfRecord",
                    "MerchantOfRecordUrl",
                    "MerchantName",
                    "FlagImageUrl"
                  ]
                }
              }
            }
          },
          "400": {
            "description": "If present, the badge request structure was invalid and unable to be parsed.\n"
          },
          "404": {
            "description": "If present, a value of the request was unable to be found. For example, if the MerchantId provided could not be found in the given environment\n"
          },
          "503": {
            "description": "There was a system problem and the request should be tried again.\n"
          }
        },
        "tags": [
          "GET"
        ]
      }
    }
  },
  "tags": [
    {
      "name": "GET"
    }
  ],
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  },
  "x-samples-enabled": false
}
```