Indicative order field requirements for a corridor
curl --request GET \
--url https://sandbox.elementpay.net/api/v1/partner/order-requirements \
--header 'X-API-Key: <api-key>'import requests
url = "https://sandbox.elementpay.net/api/v1/partner/order-requirements"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://sandbox.elementpay.net/api/v1/partner/order-requirements', 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.elementpay.net/api/v1/partner/order-requirements",
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-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://sandbox.elementpay.net/api/v1/partner/order-requirements"
req, _ := http.NewRequest("GET", url, nil)
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://sandbox.elementpay.net/api/v1/partner/order-requirements")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.elementpay.net/api/v1/partner/order-requirements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Partner order requirements (indicative)",
"data": {
"context": {
"country": "KE",
"currency": "KES",
"order_type": "OnRamp",
"payment_method_type": "mobile_money"
},
"customer": [
"name",
"phone",
"dob",
"id_number",
"id_type"
],
"payment_method": [
"type",
"phone_number",
"network_id"
],
"order": [
"wallet_address",
"local_amount",
"asset"
]
}
}{
"status": "error",
"message": "Provide country for African corridors (e.g. KE) or currency for international bank (EUR/USD).",
"data": null
}{
"status": "error",
"message": "Corridor not supported on this environment.",
"data": {
"currency": "EUR",
"country": "FR"
}
}{
"status": "error",
"message": "Quote request failed",
"data": {
"upstream_http_status": 502
}
}Partner
Indicative order field requirements for a corridor
Returns partner-neutral field name hints before POST /partner/orders/quote.
GET
/
partner
/
order-requirements
Indicative order field requirements for a corridor
curl --request GET \
--url https://sandbox.elementpay.net/api/v1/partner/order-requirements \
--header 'X-API-Key: <api-key>'import requests
url = "https://sandbox.elementpay.net/api/v1/partner/order-requirements"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://sandbox.elementpay.net/api/v1/partner/order-requirements', 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.elementpay.net/api/v1/partner/order-requirements",
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-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://sandbox.elementpay.net/api/v1/partner/order-requirements"
req, _ := http.NewRequest("GET", url, nil)
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://sandbox.elementpay.net/api/v1/partner/order-requirements")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.elementpay.net/api/v1/partner/order-requirements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Partner order requirements (indicative)",
"data": {
"context": {
"country": "KE",
"currency": "KES",
"order_type": "OnRamp",
"payment_method_type": "mobile_money"
},
"customer": [
"name",
"phone",
"dob",
"id_number",
"id_type"
],
"payment_method": [
"type",
"phone_number",
"network_id"
],
"order": [
"wallet_address",
"local_amount",
"asset"
]
}
}{
"status": "error",
"message": "Provide country for African corridors (e.g. KE) or currency for international bank (EUR/USD).",
"data": null
}{
"status": "error",
"message": "Corridor not supported on this environment.",
"data": {
"currency": "EUR",
"country": "FR"
}
}{
"status": "error",
"message": "Quote request failed",
"data": {
"upstream_http_status": 502
}
}Returns partner-neutral field name hints before
POST /partner/orders/quote.
Call after GET /partner/corridors and GET /partner/payment-methods.
Query
country, currency, order_type (OnRamp or OffRamp).
When several payout rails exist, list them with GET /partner/payment-methods first, then pass payment_method_type (e.g. BankSepa) on this call. Single-rail international bank corridors (e.g. GH) may omit it.
Rails
mobile_moneyorbank— both requirenetwork_idon quote (from catalogproviders[].idorGET /partner/banksfor bank)- Optional
customer_type(retailorinstitution) on local fiat corridors
Binding check:
POST /partner/orders/quote.Authorizations
Partner API key. Sandbox keys start with is_test_; production keys start with is_live_. Keys are not interchangeable across environments. Send on every request. Never expose in browser or mobile clients.
Query Parameters
ISO country code.
Required string length:
2Fiat currency code.
Required string length:
3OnRamp or OffRamp.
Example:
"OffRamp"
retail or institution — affects required customer fields on local fiat rail corridors.
Narrows payment_method requirements: mobile_money | bank (rail) or international bank PaymentMethodType from payment-methods (e.g. BankLocal).