cURL
curl --request POST \
--url https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remittance-beneficiary-kyc \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-SIGNATURE: <api-key>' \
--header 'X-TIMESTAMP: <api-key>' \
--data '
{
"customer_id": "638d9a52-9427-460e-99ba-948d46ce349c",
"tax_number": "HCDPS3890E"
}
'import requests
url = "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remittance-beneficiary-kyc"
payload = {
"customer_id": "638d9a52-9427-460e-99ba-948d46ce349c",
"tax_number": "HCDPS3890E"
}
headers = {
"X-API-KEY": "<api-key>",
"X-TIMESTAMP": "<api-key>",
"X-SIGNATURE": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-KEY': '<api-key>',
'X-TIMESTAMP': '<api-key>',
'X-SIGNATURE': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({customer_id: '638d9a52-9427-460e-99ba-948d46ce349c', tax_number: 'HCDPS3890E'})
};
fetch('https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remittance-beneficiary-kyc', 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.dollarpe.xyz/cms/api/v1/kyc/remittance-beneficiary-kyc",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'customer_id' => '638d9a52-9427-460e-99ba-948d46ce349c',
'tax_number' => 'HCDPS3890E'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>",
"X-SIGNATURE: <api-key>",
"X-TIMESTAMP: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remittance-beneficiary-kyc"
payload := strings.NewReader("{\n \"customer_id\": \"638d9a52-9427-460e-99ba-948d46ce349c\",\n \"tax_number\": \"HCDPS3890E\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("X-TIMESTAMP", "<api-key>")
req.Header.Add("X-SIGNATURE", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remittance-beneficiary-kyc")
.header("X-API-KEY", "<api-key>")
.header("X-TIMESTAMP", "<api-key>")
.header("X-SIGNATURE", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": \"638d9a52-9427-460e-99ba-948d46ce349c\",\n \"tax_number\": \"HCDPS3890E\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remittance-beneficiary-kyc")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["X-TIMESTAMP"] = '<api-key>'
request["X-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": \"638d9a52-9427-460e-99ba-948d46ce349c\",\n \"tax_number\": \"HCDPS3890E\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Success",
"data": {
"id": "ea6899a3-abb9-4418-8878-e23f5021e38f",
"customer_id": "638d9a52-9427-460e-99ba-948d46ce349c"
}
}{
"status": false,
"message": "Bad Request",
"error": {
"tax_number": [
"This field is required."
]
}
}{
"status": false,
"message": "Internal Server Error"
}KYC
Add KYC Data
Completes the PAN-only KYC required for the beneficiary (receiving customer) of a remittance payout.
POST
/
kyc
/
remittance-beneficiary-kyc
cURL
curl --request POST \
--url https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remittance-beneficiary-kyc \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-SIGNATURE: <api-key>' \
--header 'X-TIMESTAMP: <api-key>' \
--data '
{
"customer_id": "638d9a52-9427-460e-99ba-948d46ce349c",
"tax_number": "HCDPS3890E"
}
'import requests
url = "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remittance-beneficiary-kyc"
payload = {
"customer_id": "638d9a52-9427-460e-99ba-948d46ce349c",
"tax_number": "HCDPS3890E"
}
headers = {
"X-API-KEY": "<api-key>",
"X-TIMESTAMP": "<api-key>",
"X-SIGNATURE": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-KEY': '<api-key>',
'X-TIMESTAMP': '<api-key>',
'X-SIGNATURE': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({customer_id: '638d9a52-9427-460e-99ba-948d46ce349c', tax_number: 'HCDPS3890E'})
};
fetch('https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remittance-beneficiary-kyc', 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.dollarpe.xyz/cms/api/v1/kyc/remittance-beneficiary-kyc",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'customer_id' => '638d9a52-9427-460e-99ba-948d46ce349c',
'tax_number' => 'HCDPS3890E'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>",
"X-SIGNATURE: <api-key>",
"X-TIMESTAMP: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remittance-beneficiary-kyc"
payload := strings.NewReader("{\n \"customer_id\": \"638d9a52-9427-460e-99ba-948d46ce349c\",\n \"tax_number\": \"HCDPS3890E\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("X-TIMESTAMP", "<api-key>")
req.Header.Add("X-SIGNATURE", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remittance-beneficiary-kyc")
.header("X-API-KEY", "<api-key>")
.header("X-TIMESTAMP", "<api-key>")
.header("X-SIGNATURE", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": \"638d9a52-9427-460e-99ba-948d46ce349c\",\n \"tax_number\": \"HCDPS3890E\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remittance-beneficiary-kyc")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["X-TIMESTAMP"] = '<api-key>'
request["X-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": \"638d9a52-9427-460e-99ba-948d46ce349c\",\n \"tax_number\": \"HCDPS3890E\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Success",
"data": {
"id": "ea6899a3-abb9-4418-8878-e23f5021e38f",
"customer_id": "638d9a52-9427-460e-99ba-948d46ce349c"
}
}{
"status": false,
"message": "Bad Request",
"error": {
"tax_number": [
"This field is required."
]
}
}{
"status": false,
"message": "Internal Server Error"
}Remittance Beneficiary KYC
Error Codes and Messages
| API Status Code | Response | Reason |
|---|---|---|
| 400 | Bad Request | customer_id or tax_number is missing |
| 400 | Bad Request | tax_number format is invalid |
| 500 | Internal Server Error | Internal Server Error |
Authorizations
API Key for authentication
Current timestamp in seconds since epoch
HMAC SHA256 signature of the request encoded in Base64
Body
application/json
⌘I

