Payment providers

The catalog of payment providers Tokeflow can orchestrate — what each one supports, so you can decide which connectors to enable for a merchant.

This is the read-only catalog of payment providers Tokeflow knows how to orchestrate. Each entry describes what a provider supports — payment methods, countries, currencies, and capabilities such as tokenization or 3-D Secure — so you can decide which ones to connect for a given merchant.

A provider becomes usable only once a merchant has a connector for it, holding that merchant's credentials. The catalog tells you what is possible; Connectors tells you what is actually wired up. Tokeflow orchestrates these providers — it does not process or settle funds itself.

The payment provider object

One entry in the provider catalog.

Field	Type	Description
`id`	string	Provider ID.
`slug`	string	Provider slug identifier — the value you send as `provider_slug` when creating a connector. One of `provider_a`, `provider_b`, `provider_c`, `provider_d`, `provider_e`. See Supported providers.
`display_name`	string	Display name.
`logo`	string \| null	Logo URL.
`is_active`	boolean	Whether the provider is active.
`supported_auth_methods`	array \| null	Supported authentication methods.
`default_supported_card_brands`	array	Card brands this provider can process. A connector may narrow its `config.card_brands` to a subset of these, never beyond them; the checkout form offers exactly this set when the connector sets no override.
`supported_currencies`	array \| null	Currencies this provider can settle, sorted. `null` means the provider enforces its own currencies and no set is declared here — offer every ISO 4217 code rather than none. `null` and `[]` mean opposite things.
`installment_config`	object	Installment range per payment method, e.g. `{ "credit_card": { "min": 1, "max": 12 } }`. A method absent here takes no installments. A connector opts in or out within these bounds through `config.installments_enabled` — see Connector config.
`oauth_authorization_url`	string \| null	OAuth authorization URL. Detail endpoint only.
`oauth_token_url`	string \| null	OAuth token URL. Detail endpoint only.
`oauth_scopes`	string \| null	OAuth scopes. Detail endpoint only.
`oauth_pkce_required`	boolean	Whether OAuth PKCE is required. Detail endpoint only.

Supported providers

The catalog returned by GET /payment-providers is the source of truth for what your organization can connect today, and it is enabled per organization. The public list of supported providers is not published in this reference: it changes as new connectors go live, and not every provider is available to every organization or market. To find out whether a specific provider, country or currency is supported — or to request one — contact the Tokeflow team, and it will be enabled for your organization when available.

Two things to check in the catalog before you build on a provider:

Stored-credential charges. The one-click flow needs a provider that can charge a saved card later. Not every provider can; when the instrument's credential lives on a connector whose provider cannot, a credential_on_file charge is refused with 400. Ask the Tokeflow team which of your providers support it.
Payer data requirements. Some providers require the payer's IP (payer_ip, or the IP of the payer's Bridge SDK session) and a complete customer — name, tax document, email, phone and a billing address with postal code and street number — on card charges. Sending them on every charge keeps routing free to pick any connector.

Endpoints

GET`/api/v1/payment-providers`

OrgMerchant

Auth: Organization key (with merchant_id) or Merchant key.

List all active PSPs available to connect (slug, display_name, logo, supported_auth_methods).

Query parameters

Field	Type	Required	Description
`page`	number	No	Page number (1-indexed). Default `1`, min `1`.
`limit`	number	No	Number of items per page. Default `20`, min `1`, max `100`.

Example request

curl -G https://api.tokeflow.com/api/v1/payment-providers \
  -H "Authorization: Bearer sk_live_mer_…" \
  --data-urlencode "page=1" \
  --data-urlencode "limit=20"

Example response — 200

{
  "data": [
    {
      "id": "obj_1a2b3c4d",
      "slug": "provider_a",
      "display_name": "Provider A",
      "logo": "https://cdn.example.com/providers/provider_a.svg",
      "is_active": true,
      "supported_auth_methods": [
        "api_key",
        "oauth2"
      ],
      "default_supported_card_brands": ["visa", "mastercard", "amex"],
      "supported_currencies": null,
      "installment_config": { "credit_card": { "min": 1, "max": 12 } }
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 42,
    "total_pages": 3,
    "has_next": true,
    "has_prev": false
  }
}

GET`/api/v1/payment-providers/:provider_id`

OrgMerchant

Auth: Organization key (with merchant_id) or Merchant key.

Retrieve a single PSP's details including supported auth methods and OAuth configuration flags.

Path parameters

Field	Type	Required	Description
`provider_id`	string	Yes	Payment provider ID

Example request

curl https://api.tokeflow.com/api/v1/payment-providers/123 \
  -H "Authorization: Bearer sk_live_mer_…"

Example response — 200

{
  "id": "obj_1a2b3c4d",
  "slug": "provider_a",
  "display_name": "Provider A",
  "logo": "https://cdn.example.com/providers/provider_a.svg",
  "is_active": true,
  "supported_auth_methods": [
    "api_key",
    "oauth2"
  ],
  "default_supported_card_brands": ["visa", "mastercard", "amex"],
  "supported_currencies": null,
  "installment_config": { "credit_card": { "min": 1, "max": 12 } },
  "oauth_authorization_url": "https://provider.example.com/oauth/authorize",
  "oauth_token_url": "https://provider.example.com/oauth/token",
  "oauth_scopes": "payments:write",
  "oauth_pkce_required": true
}

Errors

Errors use the standard envelope. The most common cases here:

HTTP	`type`	Typical cause
`400`	`validation_error`	Missing required field, or an operation the current state does not allow.
`401`	`authentication_error`	Missing or invalid API key.
`403`	`authorization_error`	The key lacks the required scope.
`404`	`not_found_error`	The resource does not exist or is not owned by this entity.
`429`	`rate_limit_error`	Rate limit exceeded — back off exponentially.

See Errors for the full catalog.

Payment providers

The payment provider object

Supported providers

Endpoints

GET/api/v1/payment-providers

GET/api/v1/payment-providers/:provider_id

Errors

Related

On this page

GET`/api/v1/payment-providers`

GET`/api/v1/payment-providers/:provider_id`