Get available payment providers for checkout
curl --request GET \
--url https://api.opencals.com/storefront/payment/providers \
--header 'X-Cart-Id: <x-cart-id>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.opencals.com/storefront/payment/providers"
headers = {
"X-Cart-Id": "<x-cart-id>",
"x-api-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Cart-Id': '<x-cart-id>', 'x-api-key': '<api-key>'}};
fetch('https://api.opencals.com/storefront/payment/providers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.opencals.com/storefront/payment/providers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Cart-Id: <x-cart-id>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.opencals.com/storefront/payment/providers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Cart-Id", "<x-cart-id>")
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.opencals.com/storefront/payment/providers")
.header("X-Cart-Id", "<x-cart-id>")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opencals.com/storefront/payment/providers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Cart-Id"] = '<x-cart-id>'
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"name": "stripe",
"displayName": "Stripe",
"checkoutMode": "internal",
"description": "Accept cards and wallets with Stripe",
"icon": "stripe",
"mode": "test"
}
]Payment
Get available payment providers for checkout
Returns the active, eligible payment providers configured for this store. When the cart is identified (X-Cart-Id header or cart_id cookie) the list is amount-aware: only providers that can charge the current total are returned, and when nothing is collectible (fully discounted, or below every method’s minimum) a single “no_payment_required” provider is returned.
GET
/
storefront
/
payment
/
providers
Get available payment providers for checkout
curl --request GET \
--url https://api.opencals.com/storefront/payment/providers \
--header 'X-Cart-Id: <x-cart-id>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.opencals.com/storefront/payment/providers"
headers = {
"X-Cart-Id": "<x-cart-id>",
"x-api-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Cart-Id': '<x-cart-id>', 'x-api-key': '<api-key>'}};
fetch('https://api.opencals.com/storefront/payment/providers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.opencals.com/storefront/payment/providers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Cart-Id: <x-cart-id>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.opencals.com/storefront/payment/providers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Cart-Id", "<x-cart-id>")
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.opencals.com/storefront/payment/providers")
.header("X-Cart-Id", "<x-cart-id>")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opencals.com/storefront/payment/providers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Cart-Id"] = '<x-cart-id>'
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"name": "stripe",
"displayName": "Stripe",
"checkoutMode": "internal",
"description": "Accept cards and wallets with Stripe",
"icon": "stripe",
"mode": "test"
}
]Authorizations
Storefront API key (sfk_...)
Headers
Response
200 - application/json
List of available payment providers
Provider identifier
Available options:
stripe, cash, bank_transfer, shopify, no_payment_required Example:
"stripe"
Display name for UI
Example:
"Stripe"
Checkout integration mode
Available options:
internal, redirect, manual, none Example:
"internal"
Human-readable description
Example:
"Accept cards and wallets with Stripe"
Icon identifier
Example:
"stripe"
Provider mode (test or live) - only for providers that support it
Available options:
test, live Example:
"test"
Last modified on September 7, 2026
Was this page helpful?