curl --request POST \
--url https://api-sandbox.endl.io/api/v0/recipients/{userId} \
--header 'API-KEY: <api-key>' \
--header 'Api-Version: <api-version>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "BUSINESS",
"businessName": "DEU Labs",
"currency": "VND",
"currencySymbol": "₫",
"currencyId": 110,
"countryId": 241,
"payoutRail": "BANK_TRANSFER",
"relationshipToCustomer": "SUPPLIER",
"providerBankId": "VIETCOMBANK",
"bankAccountNumber": "0032995678",
"email": "support@technolabs.com",
"phone": "84909876543",
"recipientAddress": {
"addressLine1": "12 Nguyen Hue",
"city": "Ho Chi Minh City",
"country": "Vietnam",
"countryId": 241
}
}
'import requests
url = "https://api-sandbox.endl.io/api/v0/recipients/{userId}"
payload = {
"type": "BUSINESS",
"businessName": "DEU Labs",
"currency": "VND",
"currencySymbol": "₫",
"currencyId": 110,
"countryId": 241,
"payoutRail": "BANK_TRANSFER",
"relationshipToCustomer": "SUPPLIER",
"providerBankId": "VIETCOMBANK",
"bankAccountNumber": "0032995678",
"email": "support@technolabs.com",
"phone": "84909876543",
"recipientAddress": {
"addressLine1": "12 Nguyen Hue",
"city": "Ho Chi Minh City",
"country": "Vietnam",
"countryId": 241
}
}
headers = {
"Api-Version": "<api-version>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Api-Version': '<api-version>',
'API-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
type: 'BUSINESS',
businessName: 'DEU Labs',
currency: 'VND',
currencySymbol: '₫',
currencyId: 110,
countryId: 241,
payoutRail: 'BANK_TRANSFER',
relationshipToCustomer: 'SUPPLIER',
providerBankId: 'VIETCOMBANK',
bankAccountNumber: '0032995678',
email: 'support@technolabs.com',
phone: '84909876543',
recipientAddress: {
addressLine1: '12 Nguyen Hue',
city: 'Ho Chi Minh City',
country: 'Vietnam',
countryId: 241
}
})
};
fetch('https://api-sandbox.endl.io/api/v0/recipients/{userId}', 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-sandbox.endl.io/api/v0/recipients/{userId}",
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([
'type' => 'BUSINESS',
'businessName' => 'DEU Labs',
'currency' => 'VND',
'currencySymbol' => '₫',
'currencyId' => 110,
'countryId' => 241,
'payoutRail' => 'BANK_TRANSFER',
'relationshipToCustomer' => 'SUPPLIER',
'providerBankId' => 'VIETCOMBANK',
'bankAccountNumber' => '0032995678',
'email' => 'support@technolabs.com',
'phone' => '84909876543',
'recipientAddress' => [
'addressLine1' => '12 Nguyen Hue',
'city' => 'Ho Chi Minh City',
'country' => 'Vietnam',
'countryId' => 241
]
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Api-Version: <api-version>",
"Content-Type: application/json"
],
]);
$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://api-sandbox.endl.io/api/v0/recipients/{userId}"
payload := strings.NewReader("{\n \"type\": \"BUSINESS\",\n \"businessName\": \"DEU Labs\",\n \"currency\": \"VND\",\n \"currencySymbol\": \"₫\",\n \"currencyId\": 110,\n \"countryId\": 241,\n \"payoutRail\": \"BANK_TRANSFER\",\n \"relationshipToCustomer\": \"SUPPLIER\",\n \"providerBankId\": \"VIETCOMBANK\",\n \"bankAccountNumber\": \"0032995678\",\n \"email\": \"support@technolabs.com\",\n \"phone\": \"84909876543\",\n \"recipientAddress\": {\n \"addressLine1\": \"12 Nguyen Hue\",\n \"city\": \"Ho Chi Minh City\",\n \"country\": \"Vietnam\",\n \"countryId\": 241\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Api-Version", "<api-version>")
req.Header.Add("API-KEY", "<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://api-sandbox.endl.io/api/v0/recipients/{userId}")
.header("Api-Version", "<api-version>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"BUSINESS\",\n \"businessName\": \"DEU Labs\",\n \"currency\": \"VND\",\n \"currencySymbol\": \"₫\",\n \"currencyId\": 110,\n \"countryId\": 241,\n \"payoutRail\": \"BANK_TRANSFER\",\n \"relationshipToCustomer\": \"SUPPLIER\",\n \"providerBankId\": \"VIETCOMBANK\",\n \"bankAccountNumber\": \"0032995678\",\n \"email\": \"support@technolabs.com\",\n \"phone\": \"84909876543\",\n \"recipientAddress\": {\n \"addressLine1\": \"12 Nguyen Hue\",\n \"city\": \"Ho Chi Minh City\",\n \"country\": \"Vietnam\",\n \"countryId\": 241\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.endl.io/api/v0/recipients/{userId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Api-Version"] = '<api-version>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"BUSINESS\",\n \"businessName\": \"DEU Labs\",\n \"currency\": \"VND\",\n \"currencySymbol\": \"₫\",\n \"currencyId\": 110,\n \"countryId\": 241,\n \"payoutRail\": \"BANK_TRANSFER\",\n \"relationshipToCustomer\": \"SUPPLIER\",\n \"providerBankId\": \"VIETCOMBANK\",\n \"bankAccountNumber\": \"0032995678\",\n \"email\": \"support@technolabs.com\",\n \"phone\": \"84909876543\",\n \"recipientAddress\": {\n \"addressLine1\": \"12 Nguyen Hue\",\n \"city\": \"Ho Chi Minh City\",\n \"country\": \"Vietnam\",\n \"countryId\": 241\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "rec_7Hq2LmN9xVb4TzK1pR8s",
"userId": "cus_4Fz9QeT2mXb7LpR1sKd8",
"type": "INDIVIDUAL",
"firstName": "Van An",
"lastName": "Nguyen",
"email": "an.nguyen@example.com",
"phone": "+84901234567",
"dateOfBirth": "1990-12-05",
"bankName": "VIETCOMBANK",
"bankAccountNumber": "0071000123456",
"providerBankId": "VIETCOMBANK",
"recipientAddress": {
"addressLine1": "12 Le Loi",
"addressLine2": null,
"city": "Ho Chi Minh City",
"state": "Ho Chi Minh",
"country": "Vietnam",
"postalCode": "700000",
"countryTwoLetter": "VN",
"countryThreeLetter": "VNM",
"countryId": 241,
"region": null
},
"institutionalAddress": {
"addressLine1": null,
"addressLine2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"countryTwoLetter": null,
"countryThreeLetter": null,
"countryId": null,
"region": null
},
"currency": "VND",
"currencySymbol": "₫",
"currencyId": 110,
"payoutRail": "BANK_TRANSFER",
"relationshipToCustomer": "FRIEND",
"addedToAccountsProvider": false,
"flag": "Vietnam",
"invoiceMandatory": false,
"isNewKyc": false,
"deleted": false,
"createdOn": "2026-10-22T09:15:32.481Z",
"updatedOn": "2026-10-22T09:15:32.481Z"
}{
"code": 400,
"message": "Recipient param validations failed!",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "ERRREC_1001",
"message": "First name is required",
"field": "firstName"
}
]
}{
"data": null,
"code": 401,
"message": "Authentication Failed!",
"status": "Error",
"errors": [
{
"code": "401",
"message": "Authentication Failed!",
"field": "Authentication Failed!"
}
]
}{
"data": null,
"code": 403,
"message": "API key does not have the required permission",
"status": "Error",
"errors": [
{
"code": "403",
"message": "API key does not have the required permission",
"field": "API key does not have the required permission"
}
]
}{
"code": 404,
"message": "Resource not found",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "NOT_FOUND",
"message": "Resource not found",
"field": null
}
]
}{
"code": 409,
"message": "The request conflicts with the current state of the resource",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "CONFLICT",
"message": "The request conflicts with the current state of the resource",
"field": null
}
]
}{
"data": null,
"code": 429,
"message": "Rate limit exceeded, please retry later",
"status": "Error",
"errors": [
{
"code": "429",
"message": "Rate limit exceeded, please retry later",
"field": "Rate limit exceeded, please retry later"
}
]
}{
"code": 500,
"message": "Unexpected error",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "INTERNAL_ERROR",
"message": "Unexpected error",
"field": null
}
]
}{
"data": null,
"code": 502,
"message": "Upstream service error",
"status": "Error",
"errors": null
}{
"code": 503,
"message": "Credentials could not be verified right now",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "DIRECTORY_UNAVAILABLE",
"message": "Credentials could not be verified right now",
"field": null
}
]
}Add recipient
Creates a recipient the customer can pay out to. Requires the recipients permission.
Required fields vary by corridor — call Get recipient fields first and build the body from its answer. Six fields are required on every add: type, currency, currencySymbol, currencyId, payoutRail and relationshipToCustomer. A seventh is the name: firstName + lastName for INDIVIDUAL, businessName for BUSINESS.
The payout rail decides which verification the customer needs:
payoutRail | Customer must have completed |
|---|---|
AED_LOCAL | Lorum onboarding |
CRYPTO | Sumsub KYC |
Paywho-settled rails — BANK_TRANSFER, ALIPAY, CHINA_UNIONPAY_CARD_TRANSFERS, HUMO_UZCARD, CASH_PICKUP, … | Sumsub KYC |
SWIFT | Keyrails onboarding |
Everything else — ACH, FEDWIRE, SEPA, FPS, CHAPS, … | Bridge KYC |
This is why a customer can add a recipient on one rail and get a 403 on another.
Send countryId in two places. Inside recipientAddress it is saved on the recipient.
At the top level it is used to check the payout rail and, if you leave out
recipientAddress.countryTwoLetter or countryThreeLetter, to fill them in; it is not saved.
The example below is a VND bank recipient on the BANK_TRANSFER rail. Its values come from the reference APIs: countryId from List countries (241 is Vietnam), currencyId from List currencies (110 is VND), and providerBankId from the code of an option on the bankId field in Get recipient fields.
See the Recipients guide for verification timing, the rules that refuse a recipient, and why there is no update.
curl --request POST \
--url https://api-sandbox.endl.io/api/v0/recipients/{userId} \
--header 'API-KEY: <api-key>' \
--header 'Api-Version: <api-version>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "BUSINESS",
"businessName": "DEU Labs",
"currency": "VND",
"currencySymbol": "₫",
"currencyId": 110,
"countryId": 241,
"payoutRail": "BANK_TRANSFER",
"relationshipToCustomer": "SUPPLIER",
"providerBankId": "VIETCOMBANK",
"bankAccountNumber": "0032995678",
"email": "support@technolabs.com",
"phone": "84909876543",
"recipientAddress": {
"addressLine1": "12 Nguyen Hue",
"city": "Ho Chi Minh City",
"country": "Vietnam",
"countryId": 241
}
}
'import requests
url = "https://api-sandbox.endl.io/api/v0/recipients/{userId}"
payload = {
"type": "BUSINESS",
"businessName": "DEU Labs",
"currency": "VND",
"currencySymbol": "₫",
"currencyId": 110,
"countryId": 241,
"payoutRail": "BANK_TRANSFER",
"relationshipToCustomer": "SUPPLIER",
"providerBankId": "VIETCOMBANK",
"bankAccountNumber": "0032995678",
"email": "support@technolabs.com",
"phone": "84909876543",
"recipientAddress": {
"addressLine1": "12 Nguyen Hue",
"city": "Ho Chi Minh City",
"country": "Vietnam",
"countryId": 241
}
}
headers = {
"Api-Version": "<api-version>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Api-Version': '<api-version>',
'API-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
type: 'BUSINESS',
businessName: 'DEU Labs',
currency: 'VND',
currencySymbol: '₫',
currencyId: 110,
countryId: 241,
payoutRail: 'BANK_TRANSFER',
relationshipToCustomer: 'SUPPLIER',
providerBankId: 'VIETCOMBANK',
bankAccountNumber: '0032995678',
email: 'support@technolabs.com',
phone: '84909876543',
recipientAddress: {
addressLine1: '12 Nguyen Hue',
city: 'Ho Chi Minh City',
country: 'Vietnam',
countryId: 241
}
})
};
fetch('https://api-sandbox.endl.io/api/v0/recipients/{userId}', 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-sandbox.endl.io/api/v0/recipients/{userId}",
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([
'type' => 'BUSINESS',
'businessName' => 'DEU Labs',
'currency' => 'VND',
'currencySymbol' => '₫',
'currencyId' => 110,
'countryId' => 241,
'payoutRail' => 'BANK_TRANSFER',
'relationshipToCustomer' => 'SUPPLIER',
'providerBankId' => 'VIETCOMBANK',
'bankAccountNumber' => '0032995678',
'email' => 'support@technolabs.com',
'phone' => '84909876543',
'recipientAddress' => [
'addressLine1' => '12 Nguyen Hue',
'city' => 'Ho Chi Minh City',
'country' => 'Vietnam',
'countryId' => 241
]
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Api-Version: <api-version>",
"Content-Type: application/json"
],
]);
$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://api-sandbox.endl.io/api/v0/recipients/{userId}"
payload := strings.NewReader("{\n \"type\": \"BUSINESS\",\n \"businessName\": \"DEU Labs\",\n \"currency\": \"VND\",\n \"currencySymbol\": \"₫\",\n \"currencyId\": 110,\n \"countryId\": 241,\n \"payoutRail\": \"BANK_TRANSFER\",\n \"relationshipToCustomer\": \"SUPPLIER\",\n \"providerBankId\": \"VIETCOMBANK\",\n \"bankAccountNumber\": \"0032995678\",\n \"email\": \"support@technolabs.com\",\n \"phone\": \"84909876543\",\n \"recipientAddress\": {\n \"addressLine1\": \"12 Nguyen Hue\",\n \"city\": \"Ho Chi Minh City\",\n \"country\": \"Vietnam\",\n \"countryId\": 241\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Api-Version", "<api-version>")
req.Header.Add("API-KEY", "<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://api-sandbox.endl.io/api/v0/recipients/{userId}")
.header("Api-Version", "<api-version>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"BUSINESS\",\n \"businessName\": \"DEU Labs\",\n \"currency\": \"VND\",\n \"currencySymbol\": \"₫\",\n \"currencyId\": 110,\n \"countryId\": 241,\n \"payoutRail\": \"BANK_TRANSFER\",\n \"relationshipToCustomer\": \"SUPPLIER\",\n \"providerBankId\": \"VIETCOMBANK\",\n \"bankAccountNumber\": \"0032995678\",\n \"email\": \"support@technolabs.com\",\n \"phone\": \"84909876543\",\n \"recipientAddress\": {\n \"addressLine1\": \"12 Nguyen Hue\",\n \"city\": \"Ho Chi Minh City\",\n \"country\": \"Vietnam\",\n \"countryId\": 241\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.endl.io/api/v0/recipients/{userId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Api-Version"] = '<api-version>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"BUSINESS\",\n \"businessName\": \"DEU Labs\",\n \"currency\": \"VND\",\n \"currencySymbol\": \"₫\",\n \"currencyId\": 110,\n \"countryId\": 241,\n \"payoutRail\": \"BANK_TRANSFER\",\n \"relationshipToCustomer\": \"SUPPLIER\",\n \"providerBankId\": \"VIETCOMBANK\",\n \"bankAccountNumber\": \"0032995678\",\n \"email\": \"support@technolabs.com\",\n \"phone\": \"84909876543\",\n \"recipientAddress\": {\n \"addressLine1\": \"12 Nguyen Hue\",\n \"city\": \"Ho Chi Minh City\",\n \"country\": \"Vietnam\",\n \"countryId\": 241\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "rec_7Hq2LmN9xVb4TzK1pR8s",
"userId": "cus_4Fz9QeT2mXb7LpR1sKd8",
"type": "INDIVIDUAL",
"firstName": "Van An",
"lastName": "Nguyen",
"email": "an.nguyen@example.com",
"phone": "+84901234567",
"dateOfBirth": "1990-12-05",
"bankName": "VIETCOMBANK",
"bankAccountNumber": "0071000123456",
"providerBankId": "VIETCOMBANK",
"recipientAddress": {
"addressLine1": "12 Le Loi",
"addressLine2": null,
"city": "Ho Chi Minh City",
"state": "Ho Chi Minh",
"country": "Vietnam",
"postalCode": "700000",
"countryTwoLetter": "VN",
"countryThreeLetter": "VNM",
"countryId": 241,
"region": null
},
"institutionalAddress": {
"addressLine1": null,
"addressLine2": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"countryTwoLetter": null,
"countryThreeLetter": null,
"countryId": null,
"region": null
},
"currency": "VND",
"currencySymbol": "₫",
"currencyId": 110,
"payoutRail": "BANK_TRANSFER",
"relationshipToCustomer": "FRIEND",
"addedToAccountsProvider": false,
"flag": "Vietnam",
"invoiceMandatory": false,
"isNewKyc": false,
"deleted": false,
"createdOn": "2026-10-22T09:15:32.481Z",
"updatedOn": "2026-10-22T09:15:32.481Z"
}{
"code": 400,
"message": "Recipient param validations failed!",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "ERRREC_1001",
"message": "First name is required",
"field": "firstName"
}
]
}{
"data": null,
"code": 401,
"message": "Authentication Failed!",
"status": "Error",
"errors": [
{
"code": "401",
"message": "Authentication Failed!",
"field": "Authentication Failed!"
}
]
}{
"data": null,
"code": 403,
"message": "API key does not have the required permission",
"status": "Error",
"errors": [
{
"code": "403",
"message": "API key does not have the required permission",
"field": "API key does not have the required permission"
}
]
}{
"code": 404,
"message": "Resource not found",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "NOT_FOUND",
"message": "Resource not found",
"field": null
}
]
}{
"code": 409,
"message": "The request conflicts with the current state of the resource",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "CONFLICT",
"message": "The request conflicts with the current state of the resource",
"field": null
}
]
}{
"data": null,
"code": 429,
"message": "Rate limit exceeded, please retry later",
"status": "Error",
"errors": [
{
"code": "429",
"message": "Rate limit exceeded, please retry later",
"field": "Rate limit exceeded, please retry later"
}
]
}{
"code": 500,
"message": "Unexpected error",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "INTERNAL_ERROR",
"message": "Unexpected error",
"field": null
}
]
}{
"data": null,
"code": 502,
"message": "Upstream service error",
"status": "Error",
"errors": null
}{
"code": 503,
"message": "Credentials could not be verified right now",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "DIRECTORY_UNAVAILABLE",
"message": "Credentials could not be verified right now",
"field": null
}
]
}Authorizations
Your partner API key.
Headers
The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.
^\d{4}-\d{2}\.\d+$Path Parameters
The customer the recipient belongs to. Must be a cus_… reference id — a UUID is rejected with 400.
Body
BUSINESS or INDIVIDUAL.
BUSINESS, INDIVIDUAL ISO 4217 — the currency the recipient is paid in.
The symbol for that currency.
Endl's numeric id for the currency, from List currencies.
The rail used to reach the recipient. Decides which verification the customer needs — see above.
How the recipient relates to the customer — SUPPLIER, EMPLOYEE, SELF, SPOUSE, SUBSIDIARY_COMPANY, and others.
Recipient's first name. Required when type is INDIVIDUAL.
Recipient's last name. Required when type is INDIVIDUAL.
Recipient's legal name. Required when type is BUSINESS.
Endl's numeric id for the recipient's country, from List countries. Not saved — the saved country is recipientAddress.countryId. It narrows the payout-rail check to that country (without it, the check accepts any country's rails), and fills in recipientAddress.countryTwoLetter / countryThreeLetter when either is missing — in which case it is required for every rail except AED and CRYPTO.
Recipient's email address.
The recipient's address. Send countryId here as well as at the top level — this one is the country saved on the recipient. Send both ISO codes, or leave either out and it is filled from the top-level countryId. Any key not listed here is rejected with 400.
Show child attributes
Show child attributes
Address of the receiving bank. Same properties as recipientAddress. Required for GBP, with a valid UK postcode. Also used as the beneficiary bank address on AED payouts. Not specific to business recipients.
Show child attributes
Show child attributes
Receiving bank name.
Receiving account number.
IFSC — for Indian rails.
SWIFT / BIC — for SWIFT.
IBAN — for SEPA.
Sort code — for UK rails.
Routing number — for US rails.
Set to us for a US bank recipient, which must then also carry accountType.
For a US bank recipient (bankType: "us"): checking or savings.
checking, savings Destination wallet address — for CRYPTO, with walletChain.
Network of walletAddress — for CRYPTO.
The receiving bank's code. Take it from the options of the bankId field in Get recipient fields and send the option's code. Required wherever that endpoint marks bankId as REQUIRED. Top level only, never inside recipientAddress.
Recipient's phone number. Digits only, up to 15. No +, spaces or dashes.
Individual's date of birth, DD-MM-YYYY (for example 25-01-1994).
Recipient's ID number. Get recipient fields calls this field governmentIdNumber.
Type of governmentId, from the field's options.
Branch code.
Branch name. Required for TWD.
Recipient's nationality, from the field's options.
M or F.
Recipient's occupation, from the field's options.
First name in local script. CNY requires Han characters.
Last name in local script.
Address in local script. Top level, not inside recipientAddress.
BUSINESS only. Legal name in local script.
BUSINESS only. From the field's options.
BUSINESS only. From the field's options.
Response
The created recipient, including its rec_ id and providerBankId. Unwrapped — no code, message or data wrapper.
A recipient, unwrapped. Keys with no value are left out, except inside the two address objects. alias is never returned.
rec_… reference id.
cus_… id of the owning customer.
INDIVIDUAL or BUSINESS.
INDIVIDUAL, BUSINESS First name. For a BUSINESS recipient this holds the business name.
Contact detail.
Contact detail.
Contact detail.
Returned as YYYY-MM-DD (sent as DD-MM-YYYY on Add recipient).
Individual identity detail, where the corridor needs it.
Individual identity detail, where the corridor needs it.
Individual identity detail, where the corridor needs it.
Individual identity detail, where the corridor needs it.
Individual identity detail, where the corridor needs it.
Business detail.
Business detail.
Bank detail for the rail.
Bank detail for the rail.
Bank detail for the rail.
Bank detail for the rail.
Bank detail for the rail.
Bank detail for the rail.
Bank detail for the rail.
Bank detail for the rail.
Bank detail for the rail.
Bank detail for the rail.
Bank detail for the rail — the receiving bank's code, as sent on Add recipient.
Payout wallet, for CRYPTO recipients.
Payout wallet chain, for CRYPTO recipients.
The recipient's address. Always present; inner fields may be null.
Show child attributes
Show child attributes
The bank's address, same fields. Always present; inner fields may be null.
Show child attributes
Show child attributes
Payout currency.
Payout currency symbol.
Payout currency id.
Payout rail, e.g. ACH, SEPA, BANK_TRANSFER, CRYPTO.
Relationship to the customer, e.g. FRIEND, SUPPLIER.
Default memo sent with wires.
Registered with the payout provider.
Provider status: PENDING, ACTIVE, OPEN, CLOSED, FROZEN, EDD, DORMANT (plus _L2F variants). Only ACTIVE can be paid.
ISO 8601 time of the last provider status change.
Provider-side id. Opaque.
Country name of the payout currency, for display.
true when a transfer to this recipient must carry an invoice.
Internal. Do not branch on it.
Always false in a list.
ISO 8601 timestamp.
ISO 8601 timestamp.