/badge

get

https://checkout.rch.how/v2.22/badge

Retrieve location declaration information from Reach. For more information see Reach disclaimer and Terms of Service requirements.

Query Params

MerchantId

uuid

required

The 36 character GUID which identifies the supplier to the Reach system.

Locale

string

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.

Callback

string

The JSONP Javascript function to call.

Currency

string

If the consumer currency to be used is already known, the upper-case 3 character ISO 4217 currency code.

ConsumerIpAddress

This parameter can be specified if the request is being made on behalf of the consumer, not directly via the consumer's browser.

Theme

string

enum

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.

Allowed:

Responses

400

If present, the badge request structure was invalid and unable to be parsed.

404

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

503

There was a system problem and the request should be tried again.

Language

URL

Response

Choose an example:

application/json

200Either the text or image should be displayed and linked to the TermsOfServiceUrl.