List available payment methods
Returns available payment methods for the authenticated application and request amount.
curl -X GET "https://api.example.com/api/v1/payment-methods?currency=example_string&amount=example_string" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)"
import requests
import json
url = "https://api.example.com/api/v1/payment-methods?currency=example_string&amount=example_string"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.example.com/api/v1/payment-methods?currency=example_string&amount=example_string", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.example.com/api/v1/payment-methods?currency=example_string&amount=example_string", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.example.com/api/v1/payment-methods?currency=example_string&amount=example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
response = http.request(request)
puts response.body
{
"paymentMethods": [
"card",
"apple_pay"
],
"warnings": [
"No active payment provider connections found"
]
}
{
"error": "Bad Request",
"message": [
"currency should not be empty"
],
"statusCode": 400
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
{
"error": "Error",
"message": "Service temporarily unavailable.",
"code": 502
}
{
"error": "Error",
"message": "Request timed out.",
"code": 504
}
GET
/api/v1/payment-methods
GET
Base URLstring
Target server for requests. Edit to use your own host.
Bearer Token (JWT)
Bearer Tokenstring
RequiredBearer token (JWT) - just enter the token, "Bearer" prefix will be added automatically
query
currencystring
RequiredISO currency code in uppercase, for example AUD or EUR.
Min length: 3 • Max length: 3 • Pattern: ^[A-Z]{3}$
query
amountstring
RequiredTransaction amount as a decimal string.
Pattern: ^\d+(\.\d+)?$
Request Preview
Response
Response will appear here after sending the request
Authentication
header
Authorizationstring
RequiredBearer token (JWT). Authentication token required.
Query Parameters
currencystring
RequiredISO currency code in uppercase, for example AUD or EUR.
amountstring
RequiredTransaction amount as a decimal string.
Responses
paymentMethodsstring[]
RequiredPayment methods currently available for the application.
warningsstring[]
Non-blocking warnings that explain availability constraints for some methods.
Was this page helpful?