---
title: "GET /getPaymentMethods"
method: GET
path: "/getPaymentMethods"
tags: ["GET"]
---

# GET /getPaymentMethods

`GET /getPaymentMethods`

Retrieve available payment methods for the specified currency and country.

## Query parameters

- `MerchantId` string, uuid, required — The 36 character GUID which identifies the supplier to the Reach system.
- `Country` string, required — An upper-case ISO 3166 alpha-2 country code.
- `Currency` string, required — An upper-case 3 character ISO 4217 currency code.
- `ViaAgent` boolean
- `Callback` string — JSONP Javascript function name.

## Response `200`

The payment methods available to this customer was successfully retrieved.

- object
  - `PaymentMethods` object[], required — An array containing information about the payment methods available to the specified Country and Currency (and possibly the ViaAgent flag)
    - `Id` string, required — The Reach canonical name of the payment method.
    - `Name` string, required — The industry accepted name of the payment method. For example: 'MasterCard'
    - `Local` boolean — If present and true, this payment method is considered local to the country specified in the request and may have better conversion if presented prominently to the shopper.
    - `Class` 'Card' | 'Offline' | 'Online', required — The class of the payment method will be one of the following:<br> **Card** - (ex: VISA, MC)<br> **Offline** - (ex: BOLETO, BANK)<br> **Online** - (ex: PAYPAL, EFT)
    - `Language` string, required — The associated language of translation for the payment method name in ISO 639-1 format (default English).
    - `Parameters` object — The Klarna-specific parameters used for On-Site Message platform.
      - `ClientId` string, uuid — On-Site Messaging Client Identifier.
      - `OnSiteJavaScriptUrl` string, uri — On-Site Messaging script url.
    - `Financing` boolean — If present and true, financing options (detailed below) are available if payment is made using this method.
    - `Issuers` object[] — An array of issuers that may be associated with this payment method. Typically, these identify banks or other institutions that issue payment products. If present, an issuer must be selected from this list to use this payment method.
      - `Id` string, required — The Reach canonical name of the issuer. For example: 'AhorroFamsa'
      - `Name` string, required — A human-readable name for the issuer. For example: 'Banco Ahorro Famsa'.
  - `Financing` object — If financing options are available for any of the payment methods returned, the options will be listed here.
    - `Instalments` object[] — The financing information associated with payment via instalments.
      - `Number` integer, required — The number of instalments in which the payment will be made.
      - `Rate` number, double, required — The rate by which the total amount, excluding financing, should be multiplied to determine the financing fees.

## Other responses

- `400` — If present, the getPaymentMethods 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.

---

[API](https://skmtc.net/withreach/apis/reach-checkout-api.md) · [All operations](https://skmtc.net/withreach/apis/reach-checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/withreach/reach-checkout-api/versions/f95f4b8dd180/schema)