cURL
curl --request POST \
--url https://sandbox.zapyd.com/cms/api/v1/kyc/payout/add-kyc-data \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-SIGNATURE: <api-key>' \
--header 'X-TIMESTAMP: <api-key>' \
--data '
{
"customer_id": "84737c7d-7b62-4204-80d6-80f6ecb3ceb4",
"tax_number": "ABCDE1234F"
}
'import requests
url = "https://sandbox.zapyd.com/cms/api/v1/kyc/payout/add-kyc-data"
payload = {
"customer_id": "84737c7d-7b62-4204-80d6-80f6ecb3ceb4",
"tax_number": "ABCDE1234F"
}
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: '84737c7d-7b62-4204-80d6-80f6ecb3ceb4', tax_number: 'ABCDE1234F'})
};
fetch('https://sandbox.zapyd.com/cms/api/v1/kyc/payout/add-kyc-data', 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.zapyd.com/cms/api/v1/kyc/payout/add-kyc-data",
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' => '84737c7d-7b62-4204-80d6-80f6ecb3ceb4',
'tax_number' => 'ABCDE1234F'
]),
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.zapyd.com/cms/api/v1/kyc/payout/add-kyc-data"
payload := strings.NewReader("{\n \"customer_id\": \"84737c7d-7b62-4204-80d6-80f6ecb3ceb4\",\n \"tax_number\": \"ABCDE1234F\"\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.zapyd.com/cms/api/v1/kyc/payout/add-kyc-data")
.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\": \"84737c7d-7b62-4204-80d6-80f6ecb3ceb4\",\n \"tax_number\": \"ABCDE1234F\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.zapyd.com/cms/api/v1/kyc/payout/add-kyc-data")
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\": \"84737c7d-7b62-4204-80d6-80f6ecb3ceb4\",\n \"tax_number\": \"ABCDE1234F\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Success",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"status": "PROCESSING",
"failure_reason": null
}
}{
"status": false,
"message": "Bad Request",
"data": null,
"errors": {
"pan": [
"PAN is already linked to another customer within this organization."
]
},
"err_code": "UNKNOWN_ERROR"
}{
"status": false,
"message": "Internal Server Error",
"data": null,
"errors": {},
"err_code": "SYS_INTERNAL_ERROR"
}Payout-only onboarding
Add Payout KYC
Creates the payout-only KYC profile for a beneficiary customer; tax_number is optional.
POST
/
kyc
/
payout
/
add-kyc-data
cURL
curl --request POST \
--url https://sandbox.zapyd.com/cms/api/v1/kyc/payout/add-kyc-data \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-SIGNATURE: <api-key>' \
--header 'X-TIMESTAMP: <api-key>' \
--data '
{
"customer_id": "84737c7d-7b62-4204-80d6-80f6ecb3ceb4",
"tax_number": "ABCDE1234F"
}
'import requests
url = "https://sandbox.zapyd.com/cms/api/v1/kyc/payout/add-kyc-data"
payload = {
"customer_id": "84737c7d-7b62-4204-80d6-80f6ecb3ceb4",
"tax_number": "ABCDE1234F"
}
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: '84737c7d-7b62-4204-80d6-80f6ecb3ceb4', tax_number: 'ABCDE1234F'})
};
fetch('https://sandbox.zapyd.com/cms/api/v1/kyc/payout/add-kyc-data', 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.zapyd.com/cms/api/v1/kyc/payout/add-kyc-data",
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' => '84737c7d-7b62-4204-80d6-80f6ecb3ceb4',
'tax_number' => 'ABCDE1234F'
]),
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.zapyd.com/cms/api/v1/kyc/payout/add-kyc-data"
payload := strings.NewReader("{\n \"customer_id\": \"84737c7d-7b62-4204-80d6-80f6ecb3ceb4\",\n \"tax_number\": \"ABCDE1234F\"\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.zapyd.com/cms/api/v1/kyc/payout/add-kyc-data")
.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\": \"84737c7d-7b62-4204-80d6-80f6ecb3ceb4\",\n \"tax_number\": \"ABCDE1234F\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.zapyd.com/cms/api/v1/kyc/payout/add-kyc-data")
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\": \"84737c7d-7b62-4204-80d6-80f6ecb3ceb4\",\n \"tax_number\": \"ABCDE1234F\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Success",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"status": "PROCESSING",
"failure_reason": null
}
}{
"status": false,
"message": "Bad Request",
"data": null,
"errors": {
"pan": [
"PAN is already linked to another customer within this organization."
]
},
"err_code": "UNKNOWN_ERROR"
}{
"status": false,
"message": "Internal Server Error",
"data": null,
"errors": {},
"err_code": "SYS_INTERNAL_ERROR"
}Add Payout KYC
Part of the payout-only onboarding flow. See the payout-only onboarding guide for the order of calls and the fields each country requires.
Authorizations
API Key for authentication
Current timestamp in seconds since epoch
HMAC SHA256 signature of the request encoded in Base64
Body
application/json
⌘I