Get a payment method
curl --request GET \
--url https://sandbox-api.platform.chipper.ai/v1/capabilities/{country}/{method} \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox-api.platform.chipper.ai/v1/capabilities/{country}/{method}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox-api.platform.chipper.ai/v1/capabilities/{country}/{method}', 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://sandbox-api.platform.chipper.ai/v1/capabilities/{country}/{method}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://sandbox-api.platform.chipper.ai/v1/capabilities/{country}/{method}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox-api.platform.chipper.ai/v1/capabilities/{country}/{method}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.platform.chipper.ai/v1/capabilities/{country}/{method}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"method": {
"code": "gh_mtn",
"name": "MTN Mobile Money",
"type": "mobile_money",
"status": "operational",
"limits": {
"min": 1,
"max": 50000,
"currency": "GHS"
},
"estimatedSettlement": "0-5 minutes",
"fields": [
{
"key": "accountNumber",
"label": "Phone Number",
"type": "text",
"placeholder": "+233XXXXXXXXX",
"description": "<string>",
"group": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>"
}
]
}
]
}
}{
"error": "unauthorized",
"message": "Invalid API key",
"requestId": "req_q7vei435zifs51ia0lqr"
}{
"error": "not_found",
"message": "Method gh_mtn for country GH not found",
"requestId": "req_q7vei435zifs51ia0lqr"
}Capabilities
Get a payment method
One method with its live status, limits, settlement estimate, and the input fields it needs. Check this before creating a recipient or payout on a rail to catch limit or outage problems up front.
GET
/
v1
/
capabilities
/
{country}
/
{method}
Get a payment method
curl --request GET \
--url https://sandbox-api.platform.chipper.ai/v1/capabilities/{country}/{method} \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox-api.platform.chipper.ai/v1/capabilities/{country}/{method}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox-api.platform.chipper.ai/v1/capabilities/{country}/{method}', 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://sandbox-api.platform.chipper.ai/v1/capabilities/{country}/{method}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://sandbox-api.platform.chipper.ai/v1/capabilities/{country}/{method}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox-api.platform.chipper.ai/v1/capabilities/{country}/{method}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.platform.chipper.ai/v1/capabilities/{country}/{method}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"method": {
"code": "gh_mtn",
"name": "MTN Mobile Money",
"type": "mobile_money",
"status": "operational",
"limits": {
"min": 1,
"max": 50000,
"currency": "GHS"
},
"estimatedSettlement": "0-5 minutes",
"fields": [
{
"key": "accountNumber",
"label": "Phone Number",
"type": "text",
"placeholder": "+233XXXXXXXXX",
"description": "<string>",
"group": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>"
}
]
}
]
}
}{
"error": "unauthorized",
"message": "Invalid API key",
"requestId": "req_q7vei435zifs51ia0lqr"
}{
"error": "not_found",
"message": "Method gh_mtn for country GH not found",
"requestId": "req_q7vei435zifs51ia0lqr"
}Authorizations
Your API key: sk_test_… (sandbox) or sk_live_… (production).
Path Parameters
ISO 3166-1 alpha-2 country code, case-insensitive.
Example:
"GH"
Method code.
Example:
"gh_mtn"
Response
The method.
Show child attributes
Show child attributes
⌘I