Payment methods
Check API availability and confirm access in your target environment before integrating.
| Operation | Method and route | Availability |
|---|---|---|
| List payment methods | GET /v1/payment-methods | Merchant route confirmed |
Query the payment methods enabled and available for your merchant account to select a collection currency and payment network.
Requests, authentication, and errors follow the common merchant API conventions.
Confirm your account and environment can query payment methods; see API availability. Start with the integration quickstart for the collection workflow.
Payment Methods Object
Attributes
| Attribute | Type | Description |
|---|---|---|
ipp | array of objects | Currency/network combinations supported for IPP private payments; always an array, or [] when no combinations are available |
ipp[].currency | string | Collection currency: usdc, usdt |
ipp[].chain | integer | Payment network identifier (EIP-155 chain ID); for example, 56 identifies BNB Smart Chain mainnet |
erc20_transfer | array of objects | Currency/network combinations available for ERC20 transfer payments; always an array, or [] when none are available |
erc20_transfer[].currency | string | Collection currency: usdc, usdt |
erc20_transfer[].chain | integer | Payment network identifier (EIP-155 chain ID), with the same encoding as ipp[].chain |
Each entry is one available combination within its payment-method group. Do not independently combine currencies and networks from different entries, or assume a combination available in one group is available in the other. Combinations within a group are unique. Both ipp and erc20_transfer are present, including when one group is empty; when no payment methods are available, the result is {"ipp":[],"erc20_transfer":[]}.
Both groups use the same {currency, chain} entry shape. A nonempty erc20_transfer group lists the ERC20 transfer combinations enabled for your merchant account. The examples show an empty ERC20 transfer group and do not imply any particular account or network is enabled.
Object example
{
"ipp": [
{"currency": "usdc", "chain": 56},
{"currency": "usdc", "chain": 137},
{"currency": "usdt", "chain": 56}
],
"erc20_transfer": []
}
List available payment methods
GET /v1/payment-methods
Returns the current merchant's supported payment methods and currency/network combinations without pagination.
Attributes
No request parameters.
Request example
GET /v1/payment-methods
Authorization: Bearer inv_test_...
Response example
200 OK, with the Payment Methods object returned directly.
{
"ipp": [
{"currency": "usdc", "chain": 56},
{"currency": "usdc", "chain": 137},
{"currency": "usdt", "chain": 56}
],
"erc20_transfer": []
}