curl --request GET \
--url https://api.paywint.com/api/platform/cross-border/payee-rules \
--header 'X-Platform-ID: <x-platform-id>' \
--header 'X-Signature: <x-signature>'import requests
url = "https://api.paywint.com/api/platform/cross-border/payee-rules"
headers = {
"X-Platform-ID": "<x-platform-id>",
"X-Signature": "<x-signature>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Platform-ID': '<x-platform-id>', 'X-Signature': '<x-signature>'}
};
fetch('https://api.paywint.com/api/platform/cross-border/payee-rules', 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.paywint.com/api/platform/cross-border/payee-rules",
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-Platform-ID: <x-platform-id>",
"X-Signature: <x-signature>"
],
]);
$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.paywint.com/api/platform/cross-border/payee-rules"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Platform-ID", "<x-platform-id>")
req.Header.Add("X-Signature", "<x-signature>")
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.paywint.com/api/platform/cross-border/payee-rules")
.header("X-Platform-ID", "<x-platform-id>")
.header("X-Signature", "<x-signature>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywint.com/api/platform/cross-border/payee-rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Platform-ID"] = '<x-platform-id>'
request["X-Signature"] = '<x-signature>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed.",
"data": {
"country_code": "<string>",
"country_name": "<string>",
"mandatory_fields": [
{
"tag": "<string>",
"label": "<string>",
"data_type": "<string>",
"length": 123
}
],
"optional_fields": [
{
"tag": "<string>",
"label": "<string>",
"data_type": "<string>",
"length": 123
}
],
"account": {},
"documents_allowed": {},
"bank_identifier_type": "<string>"
},
"queryGeneratedTime": 1718006400
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Get Payee Rules (Mandatory Fields)
Returns the payee rules for a destination country (ISO2) and payout currency.
The response lists the mandatory and optional payee fields and the amount limits — the fields you need to collect for the payee.
curl --request GET \
--url https://api.paywint.com/api/platform/cross-border/payee-rules \
--header 'X-Platform-ID: <x-platform-id>' \
--header 'X-Signature: <x-signature>'import requests
url = "https://api.paywint.com/api/platform/cross-border/payee-rules"
headers = {
"X-Platform-ID": "<x-platform-id>",
"X-Signature": "<x-signature>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Platform-ID': '<x-platform-id>', 'X-Signature': '<x-signature>'}
};
fetch('https://api.paywint.com/api/platform/cross-border/payee-rules', 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.paywint.com/api/platform/cross-border/payee-rules",
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-Platform-ID: <x-platform-id>",
"X-Signature: <x-signature>"
],
]);
$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.paywint.com/api/platform/cross-border/payee-rules"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Platform-ID", "<x-platform-id>")
req.Header.Add("X-Signature", "<x-signature>")
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.paywint.com/api/platform/cross-border/payee-rules")
.header("X-Platform-ID", "<x-platform-id>")
.header("X-Signature", "<x-signature>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywint.com/api/platform/cross-border/payee-rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Platform-ID"] = '<x-platform-id>'
request["X-Signature"] = '<x-signature>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed.",
"data": {
"country_code": "<string>",
"country_name": "<string>",
"mandatory_fields": [
{
"tag": "<string>",
"label": "<string>",
"data_type": "<string>",
"length": 123
}
],
"optional_fields": [
{
"tag": "<string>",
"label": "<string>",
"data_type": "<string>",
"length": 123
}
],
"account": {},
"documents_allowed": {},
"bank_identifier_type": "<string>"
},
"queryGeneratedTime": 1718006400
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Headers
Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.
HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.
Query Parameters
Payee country ISO2, e.g. IN.
Payout currency ISO code, e.g. INR.
Response
Successful Response
Indicates whether the request was processed successfully.
true
A short, human-readable message describing the result of the request.
"Operation completed."
The main response payload, if applicable
Show child attributes
Show child attributes
The Unix timestamp (in seconds) indicating when the response was generated.
1718006400

