Discovery

Payment Methods

Use the discovery endpoint to find available payment methods for your target market.

GET/api/v1/methods

Returns a list of available payment methods with their requirements.

Query Parameters

ParameterTypeDescription
countrystringFilter by country (BRA, PER, COL, CHL, MEX, ECU, ARG)
currencystringFilter by currency (BRL, PEN, COP, CLP, MXN, USD, USDT)
payment_typestringFilter by type (pix, card, bank_transfer, wallet, crypto)

Example Request

bash
curl -X GET "https://cashier.flowpayment.net/api/v1/methods?country=BRA" \
  -H "Content-Type: application/json"

Response

response.json
{
  "success": true,
  "methods": [
    {
      "method_code": "s-interio-mt-1",
      "name": "PIX Brazil",
      "description": "Instant payment via PIX",
      "provider": "sfp",
      "payment_type": "pix",
      "country": "BRA",
      "currency": "BRL",
      "flow_type": "embedded",
      "required_fields": [
        {
          "field": "name",
          "type": "text",
          "label": "Nome completo",
          "required": true
        },
        {
          "field": "email",
          "type": "email",
          "label": "Email",
          "required": true
        },
        {
          "field": "document",
          "type": "cpf",
          "label": "CPF",
          "required": true
        }
      ],
      "min_amount": 1.00,
      "max_amount": 50000.00
    }
  ],
  "total": 2
}

Response Fields

PaymentMethodInfo

FieldTypeDescription
method_codestringUse this value in your payment requests
namestringDisplay name for the payment method
descriptionstringOptional description
providerstringInternal provider name (for reference only)
payment_typestringCategory: pix, card, bank_transfer, wallet, crypto
countrystringISO 3166-1 alpha-3 country code
currencystringSupported currency code
flow_typestringembedded (show QR/code) or redirect (redirect to provider)
required_fieldsarrayFields you must include in the customer object
min_amountnumberMinimum transaction amount
max_amountnumberMaximum transaction amount

RequiredFieldInfo

FieldTypeDescription
fieldstringField name to use in customer object
typestringField type: text, email, phone, cpf, dni, rut, card, expiry, cvv
labelstringDisplay label (use for forms)
requiredbooleanWhether the field is required

Available Method Codes

Current active method codes (s-interio-mt-1 through s-interio-mt-30):

PIX
Card
Transfer
Wallet
Crypto

Brazil (BRA)

CodeNameType
s-interio-mt-1PIX Brazil pix
s-interio-mt-7Bank Transfer Brazil bank_transfer
s-interio-mt-8Boleto Brazil boleto
s-interio-mt-9PicPay Brazil wallet

Peru (PER)

CodeNameType
s-interio-mt-3Tupay Perupayin
s-interio-mt-11Bank Transfer Peru bank_transfer
s-interio-mt-12CIP Peru bank_transfer
s-interio-mt-13Yape Peru wallet

Colombia (COL)

CodeNameType
s-interio-mt-14PSE Colombia bank_transfer
s-interio-mt-15Nequi Colombia wallet
s-interio-mt-16Efecty Colombiacash
s-interio-mt-17Transfiya Colombia bank_transfer

Chile (CHL)

CodeNameType
s-interio-mt-18Bank Transfer Chile bank_transfer
s-interio-mt-19Servipag Chilecash

Mexico (MEX)

CodeNameType
s-interio-mt-23SPEI Mexico bank_transfer
s-interio-mt-24OXXO Mexicocash

Global

CodeNameType
s-interio-mt-2Card Global card
s-interio-mt-4Crypto USDT crypto
GET/api/v1/methods/{method_code}

Get details for a specific payment method.

bash
GET https://cashier.flowpayment.net/api/v1/methods/s-interio-mt-1

Returns the full PaymentMethodInfo object for the specified method code.