Discovery
Payment Methods
Use the discovery endpoint to find available payment methods for your target market.
GET
/api/v1/methodsReturns a list of available payment methods with their requirements.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
country | string | Filter by country (BRA, PER, COL, CHL, MEX, ECU, ARG) |
currency | string | Filter by currency (BRL, PEN, COP, CLP, MXN, USD, USDT) |
payment_type | string | Filter 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
| Field | Type | Description |
|---|---|---|
method_code | string | Use this value in your payment requests |
name | string | Display name for the payment method |
description | string | Optional description |
provider | string | Internal provider name (for reference only) |
payment_type | string | Category: pix, card, bank_transfer, wallet, crypto |
country | string | ISO 3166-1 alpha-3 country code |
currency | string | Supported currency code |
flow_type | string | embedded (show QR/code) or redirect (redirect to provider) |
required_fields | array | Fields you must include in the customer object |
min_amount | number | Minimum transaction amount |
max_amount | number | Maximum transaction amount |
RequiredFieldInfo
| Field | Type | Description |
|---|---|---|
field | string | Field name to use in customer object |
type | string | Field type: text, email, phone, cpf, dni, rut, card, expiry, cvv |
label | string | Display label (use for forms) |
required | boolean | Whether 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)
| Code | Name | Type |
|---|---|---|
s-interio-mt-1 | PIX Brazil | pix |
s-interio-mt-7 | Bank Transfer Brazil | bank_transfer |
s-interio-mt-8 | Boleto Brazil | boleto |
s-interio-mt-9 | PicPay Brazil | wallet |
Peru (PER)
| Code | Name | Type |
|---|---|---|
s-interio-mt-3 | Tupay Peru | payin |
s-interio-mt-11 | Bank Transfer Peru | bank_transfer |
s-interio-mt-12 | CIP Peru | bank_transfer |
s-interio-mt-13 | Yape Peru | wallet |
Colombia (COL)
| Code | Name | Type |
|---|---|---|
s-interio-mt-14 | PSE Colombia | bank_transfer |
s-interio-mt-15 | Nequi Colombia | wallet |
s-interio-mt-16 | Efecty Colombia | cash |
s-interio-mt-17 | Transfiya Colombia | bank_transfer |
Chile (CHL)
| Code | Name | Type |
|---|---|---|
s-interio-mt-18 | Bank Transfer Chile | bank_transfer |
s-interio-mt-19 | Servipag Chile | cash |
Mexico (MEX)
| Code | Name | Type |
|---|---|---|
s-interio-mt-23 | SPEI Mexico | bank_transfer |
s-interio-mt-24 | OXXO Mexico | cash |
Global
| Code | Name | Type |
|---|---|---|
s-interio-mt-2 | Card Global | card |
s-interio-mt-4 | Crypto 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-1Returns the full PaymentMethodInfo object for the specified method code.