Check eligibility for Click to Pay for Mastercard - Marqeta Docs

GET////

Use this endpoint to check if a provided BIN prefix is eligible for Click to Pay for Mastercard. For more information about this ecommerce checkout solution, see Click to Pay.

Header parameter

Fields	Description
req-sys-id string Required	Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. Allowable Values: 36 char max

URL query parameters

Fields	Description
bin_prefix string Required	Prefix of the bank identification number. Allowable Values: A six- to nine-digit number NOTE: It is preferable to use eight- or nine-digit BIN prefixes in production environments. Contact your Marqeta representative for the appropriate value to use.
include_asset boolean Optional	Returns a list of image assets for the Click to Pay logo if set to `true`. Allowable Values: `true`, `false`

Response body

Fields	Description
is_eligible boolean Conditionally returned	Indicates whether the `bin_prefix` is eligible for Click to Pay. - `true`: The `bin_prefix` is eligible for Click to Pay. - `false`: The `bin_prefix` is not eligible for Click to Pay. Allowable Values: `true`, `false`
image_assets array of objects Conditionally returned	List of image assets for the Click to Pay logo if `include_asset` is set to `true` in the request. Allowable Values: A valid array of `image_asset` objects
image_assets[].type string Conditionally returned	Type of media. Specified as Multipurpose Internet Mail Extension (MIME). Supported media types include: - application/pdf - image/png - image/svg+xml - text/plain - text/html Allowable Values: 32 char max
image_assets[].data string Conditionally returned	Media data content. Allowable Values: Base64-encoded media data
image_assets[].height string Conditionally returned	Height of non-SVG image asset. Specified in pixels. Allowable Values: 6 char max
image_assets[].width string Conditionally returned	Width of non-SVG image asset. Specified in pixels. Allowable Values: 6 char max

Sample response body

JSON

{
  "is_eligible": true,
  "image_assets": [
    {
      "media_content": {
        "type": "image/png",
        "data": "iVBORw0KGgoAAAANSUhEUgAAAMAAAADACAYAAABS3GwHAAAAAXNSR0IArs4c6... (truncated for readability)",
        "height": "192px",
        "width": "192px"
      }
    },
    {
      "media_content": {
        "type": "image/svg+xml",
        "data": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3... (truncated for readability)",
        "height": "192px",
        "width": "192px"
      }
    }
  ]
}