Sign in

v1

latestOpenAPI 3.0.02026-07-262832203.2 KB
GET

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

get/badge

Query parameters

MerchantIdstring uuid required

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

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

Localestring

JSONP Javascript function name.

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.

Callbackstring

JSONP Javascript function name.

The JSONP Javascript function to call.

Currencystring

An upper-case 3 character ISO 4217 currency code.

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

string ipv4
OR
string ipv6

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

Theme'light' | 'dark'

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.

Response

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

Textstring required

The text to display.

Htmlstring required

The HTML snippet to display.

ImageUrlstring uri required

The image to display.

TermsOfServiceUrlstring uri required

The location that the text or image should link to.

MerchantOfRecordstring required

The name of the entity handling the payment.

MerchantOfRecordUrlstring uri required

The location of the Merchant of Record website.

MerchantNamestring required

As a convenience, the name of the supplier associated with the specified MerchantId.

FlagImageUrlstring required

The flag image associated with the Merchant of Record.