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. One of provider_a, provider_b, provider_c, provider_d, provider_e. |
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. |
oauth_authorization_url | string | null | OAuth authorization URL. |
oauth_token_url | string | null | OAuth token URL. |
oauth_scopes | string | null | OAuth scopes. |
oauth_pkce_required | boolean | Whether OAuth PKCE is required. |
Endpoints
GET/api/v1/payment-providers
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": "string",
"is_active": true,
"supported_auth_methods": [
"api_key",
"oauth2"
]
}
],
"meta": {
"page": 1,
"limit": 20,
"total": 42,
"total_pages": 3,
"has_next": true,
"has_prev": false
}
}GET/api/v1/payment-providers/:provider_id
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": "string",
"is_active": true,
"supported_auth_methods": [
"api_key",
"oauth2"
],
"oauth_authorization_url": "https://example.com/webhooks/tokeflow",
"oauth_token_url": "https://example.com/webhooks/tokeflow",
"oauth_scopes": "string",
"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.