List payment methods
GET /capabilities/payment-methods - Read buy-side payment method categories for the active environment.
0Gate is the primary public integration path for hosted payment, ramp, and swap experiences. Keep secret-key operations on your server and hand only browser-safe values to the widget.
Endpoint
| Field | Value |
|---|---|
| Method | GET |
| Path | /v1/capabilities/payment-methods |
| Area | Capabilities |
| Operation id | listPaymentMethods |
| Auth boundary | Secret key from your server. |
Use it for
Read the buy-side (on_ramp) payment method categories available for a given fiat currency in the active environment. Use it to render the pay-in options a user can choose and to validate a chosen method on your server before creating a session.
Use this endpoint only for discovery. It is read-only and never moves money, locks a quote, or creates a session.
Production rules
- Keep secret keys on your server. This endpoint requires an
sk_*key; a publishablepk_*key can only call embed-bootstrap. - Supply a
currency(or acountry_codethat resolves to one). With neither, the list is empty. - This list is returned in full —
has_moreis alwaysfalse. Filter with the query params rather than paging. - Branch on the machine-readable
idand theX-Request-Idheader, not on the displayname. - Treat examples and placeholder values as fake data only.
Request
This is a GET with no body. Provide a currency directly, or a country whose default fiat resolves to one.
| Parameter | In | Required | Type | Use it for |
|---|---|---|---|---|
currency | query | No* | string (ISO 4217) | The fiat to list pay-in methods for, for example EUR. Takes precedence over country_code. |
country_code | query | No* | string (ISO 3166 alpha-2) | Resolve the fiat from this region's default currency when currency is omitted. |
One of currency or country_code is needed
*If neither resolves to a supported fiat, the response is 200 with an empty data array — it is not an error.
Response
Returns the shared list envelope. Each element of data is a payment_method object.
| Field | Type | Description |
|---|---|---|
object | string | Always list. |
data | array | The matching payment_method objects (see below). |
has_more | boolean | Always false. Capability lists are returned in full, not paged. |
url | string | Static path of this resource. Does not echo query params. |
Payment method object
| Field | Type | Description |
|---|---|---|
object | string | Always payment_method. |
id | string | Stable slug for the method category. Use this as the canonical id. |
name | string | Display name for the method. |
currency | string | The fiat (ISO 4217) this method was resolved for. |
side | string | Always on_ramp for this endpoint. |
icon_url | string | null | Icon URL for the method, or null. |
fees | object | Fee descriptor for the method; an empty object when none apply. |
Examples
curl 'https://gate-api.0bit.app/v1/capabilities/payment-methods?currency=EUR' \
-H "Authorization: Bearer sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"{
"object": "list",
"data": [
{
"object": "payment_method",
"id": "bank_transfer",
"name": "Bank Transfer",
"currency": "EUR",
"side": "on_ramp",
"icon_url": null,
"fees": {}
}
],
"has_more": false,
"url": "/v1/capabilities/payment-methods"
}Errors
All errors use the unified envelope and carry an X-Request-Id response header. Branch on code/type/statusCode, not on the free-form message.
{
"type": "unauthorized",
"code": "unauthorized",
"message": "Example auth error using fake data.",
"request_id": "req_test_000000000123",
"doc_url": null,
"statusCode": 401
}| Status | type | When it happens |
|---|---|---|
401 | unauthorized | Missing or invalid secret key. |
429 | rate_limited | Request throttled. Back off and retry. |
5xx | server_error | Transient server or upstream failure. Retry with backoff. |
No resolvable currency is not an error
When neither currency nor country_code resolves to a supported fiat, the response is 200 with an empty data array. Branch on the array length.
Related pages
List payout methods
Read sell-side payout method categories.
List supported currencies
Read the supported fiat currencies.
Preview quotes
Preview indicative quotes for every applicable method.
Errors
Handle the unified error envelope, request ids, and retries.
Public boundary
This reference covers partner-scoped capability discovery. Internal operations, administrative routes, settlement venues and providers, and unsupported availability claims are outside the public API contract.