Skip to main content
GET
/
payments
/
methods
Get Payment Methods
curl --request GET \
  --url https://api.payviox.com/payments/methods
{
  "stripe_credit": {
    "countries": null,
    "currencies": null,
    "fees": {
      "static_fees": 0.30,
      "percent_fees": 0.029
    },
    "name": "Credit Card (Stripe)",
    "image": "https://cdn.payviox.com/images/stripe.png"
  },
  "nicepay_pix": {
    "countries": ["BR"],
    "currencies": ["BRL", "USD"],
    "fees": {
      "static_fees": 0,
      "percent_fees": 0.015
    },
    "name": "PIX (Nicepay)",
    "image": "https://cdn.payviox.com/images/pix.png"
  },
  "zen_usdt": {
    "countries": null,
    "currencies": ["USD"],
    "fees": {
      "static_fees": 0,
      "percent_fees": 0.01
    },
    "name": "USDT (Zen)",
    "image": "https://cdn.payviox.com/images/usdt.png"
  },
  "cryptocom_btc": {
    "countries": null,
    "currencies": ["USD"],
    "fees": {
      "static_fees": 0,
      "percent_fees": 0.01
    },
    "name": "Bitcoin (Crypto.com)",
    "image": "https://cdn.payviox.com/images/bitcoin.png"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.payviox.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Returns a list of all available payment methods configured for your business, filtered by country and currency restrictions.
This endpoint returns only active payment methods that match the specified filters.

​
Authentication

This endpoint requires API key authentication. See Authentication for details. 
Authorization: Bearer YOUR_API_KEY

​
Query Parameters

​
countries
string
Comma-separated list of ISO 3166-1 alpha-2 country codes to filter payment methods by availability.Example: US,GB,FRMaximum: 200 countries
​
currencies
string
Comma-separated list of three-letter ISO currency codes to filter payment methods.Example: USD,EUR,GBPMaximum: 200 currencies
​
is_company
boolean
Set to true to get payment methods for business customers with adjusted fees.Default: false

​
Response

Returns an object where each key is a payment method ID and the value contains the payment method details.
​
[payment_method_id]
object

​
Example Request

curl https://api.payviox.com/payments/methods?countries=US,GB&currencies=USD \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

{
  "stripe_credit": {
    "countries": null,
    "currencies": null,
    "fees": {
      "static_fees": 0.30,
      "percent_fees": 0.029
    },
    "name": "Credit Card (Stripe)",
    "image": "https://cdn.payviox.com/images/stripe.png"
  },
  "nicepay_pix": {
    "countries": ["BR"],
    "currencies": ["BRL", "USD"],
    "fees": {
      "static_fees": 0,
      "percent_fees": 0.015
    },
    "name": "PIX (Nicepay)",
    "image": "https://cdn.payviox.com/images/pix.png"
  },
  "zen_usdt": {
    "countries": null,
    "currencies": ["USD"],
    "fees": {
      "static_fees": 0,
      "percent_fees": 0.01
    },
    "name": "USDT (Zen)",
    "image": "https://cdn.payviox.com/images/usdt.png"
  },
  "cryptocom_btc": {
    "countries": null,
    "currencies": ["USD"],
    "fees": {
      "static_fees": 0,
      "percent_fees": 0.01
    },
    "name": "Bitcoin (Crypto.com)",
    "image": "https://cdn.payviox.com/images/bitcoin.png"
  }
}

​
Error Responses

Returned when the API key is missing or invalid.How to resolve: Ensure you are sending a valid API key in the Authorization: Bearer header. Both Public and Secret API keys are accepted.
{
  "error": "Unauthorized"
}

​
Understanding the Response

​
Global vs Regional Payment Methods

  • Global methods have null or empty arrays for countries and currencies
  • Regional methods specify which countries and currencies they support

​
Fee Structure

Fees are calculated as: 
Total Fee = static_fees + (amount × percent_fees)
Example: For a $100 payment with static_fees: 0.30 and percent_fees: 0.029: 
Total Fee = $0.30 + ($100 × 0.029) = $0.30 + $2.90 = $3.20

​
Company vs Individual Fees

When is_company=true, some payment methods may have adjusted fee structures for business customers.

​
Use Cases

Display Payment Options

Show available payment methods to your customers before they start checkout

Dynamic Pricing

Calculate and display fees for each payment method

Geographic Filtering

Show only payment methods available in customer’s country

Currency Support

Filter methods based on your transaction currency

​
Filtering Logic

  • If no countries parameter is provided, all payment methods are returned
  • If countries are specified, only methods available in those countries are returned
  • Methods with null countries are always included (global availability)
  • If no currencies parameter is provided, all payment methods are returned
  • If currencies are specified, only methods supporting those currencies are returned
  • Methods with null currencies are always included (all currencies supported)
  • Only payment methods that are active in your business configuration are returned
  • Methods must also have an active provider configuration

​
Best Practices

Cache Responsibly: Payment methods and fees can change. Cache the response for a short period (recommended: 5-15 minutes) and refresh regularly.
Show Relevant Methods: Always filter by the customer’s country and your transaction currency to show only relevant payment options.

​
Next Steps

Create Session

Create a payment session with a specific payment method

Configure Methods

Enable or configure payment methods in your dashboard