Create Beneficiary
curl --request POST \
--url https://api.example.com/v1/beneficiaries \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"country": "<string>",
"currency": "<string>",
"details": {},
"name": "<string>",
"payout_schema_id": "<string>",
"is_external": true,
"nickname": "<string>",
"purpose_code": "<string>"
}
'import requests
url = "https://api.example.com/v1/beneficiaries"
payload = {
"country": "<string>",
"currency": "<string>",
"details": {},
"name": "<string>",
"payout_schema_id": "<string>",
"is_external": True,
"nickname": "<string>",
"purpose_code": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Idempotency-Key': '<idempotency-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
country: '<string>',
currency: '<string>',
details: {},
name: '<string>',
payout_schema_id: '<string>',
is_external: true,
nickname: '<string>',
purpose_code: '<string>'
})
};
fetch('https://api.example.com/v1/beneficiaries', 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.example.com/v1/beneficiaries",
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([
'country' => '<string>',
'currency' => '<string>',
'details' => [
],
'name' => '<string>',
'payout_schema_id' => '<string>',
'is_external' => true,
'nickname' => '<string>',
'purpose_code' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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://api.example.com/v1/beneficiaries"
payload := strings.NewReader("{\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"details\": {},\n \"name\": \"<string>\",\n \"payout_schema_id\": \"<string>\",\n \"is_external\": true,\n \"nickname\": \"<string>\",\n \"purpose_code\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-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.example.com/v1/beneficiaries")
.header("Idempotency-Key", "<idempotency-key>")
.header("Content-Type", "application/json")
.body("{\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"details\": {},\n \"name\": \"<string>\",\n \"payout_schema_id\": \"<string>\",\n \"is_external\": true,\n \"nickname\": \"<string>\",\n \"purpose_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/beneficiaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"details\": {},\n \"name\": \"<string>\",\n \"payout_schema_id\": \"<string>\",\n \"is_external\": true,\n \"nickname\": \"<string>\",\n \"purpose_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2023-11-07T05:31:56Z",
"failure_code": "<string>",
"failure_detail": "<string>",
"id": "<string>",
"next_reconcile_at": "2023-11-07T05:31:56Z",
"resource_id": "<string>",
"resource_type": "<string>",
"submission_uncertain": true,
"updated_at": "2023-11-07T05:31:56Z",
"upstream_reference": "<string>",
"action_required": {
"expires_at": "2023-11-07T05:31:56Z",
"poll_after_ms": 1,
"url": "<string>"
}
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}Beneficiaries
Create Beneficiary
POST
/
v1
/
beneficiaries
Create Beneficiary
curl --request POST \
--url https://api.example.com/v1/beneficiaries \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"country": "<string>",
"currency": "<string>",
"details": {},
"name": "<string>",
"payout_schema_id": "<string>",
"is_external": true,
"nickname": "<string>",
"purpose_code": "<string>"
}
'import requests
url = "https://api.example.com/v1/beneficiaries"
payload = {
"country": "<string>",
"currency": "<string>",
"details": {},
"name": "<string>",
"payout_schema_id": "<string>",
"is_external": True,
"nickname": "<string>",
"purpose_code": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Idempotency-Key': '<idempotency-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
country: '<string>',
currency: '<string>',
details: {},
name: '<string>',
payout_schema_id: '<string>',
is_external: true,
nickname: '<string>',
purpose_code: '<string>'
})
};
fetch('https://api.example.com/v1/beneficiaries', 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.example.com/v1/beneficiaries",
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([
'country' => '<string>',
'currency' => '<string>',
'details' => [
],
'name' => '<string>',
'payout_schema_id' => '<string>',
'is_external' => true,
'nickname' => '<string>',
'purpose_code' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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://api.example.com/v1/beneficiaries"
payload := strings.NewReader("{\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"details\": {},\n \"name\": \"<string>\",\n \"payout_schema_id\": \"<string>\",\n \"is_external\": true,\n \"nickname\": \"<string>\",\n \"purpose_code\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-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.example.com/v1/beneficiaries")
.header("Idempotency-Key", "<idempotency-key>")
.header("Content-Type", "application/json")
.body("{\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"details\": {},\n \"name\": \"<string>\",\n \"payout_schema_id\": \"<string>\",\n \"is_external\": true,\n \"nickname\": \"<string>\",\n \"purpose_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/beneficiaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"details\": {},\n \"name\": \"<string>\",\n \"payout_schema_id\": \"<string>\",\n \"is_external\": true,\n \"nickname\": \"<string>\",\n \"purpose_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2023-11-07T05:31:56Z",
"failure_code": "<string>",
"failure_detail": "<string>",
"id": "<string>",
"next_reconcile_at": "2023-11-07T05:31:56Z",
"resource_id": "<string>",
"resource_type": "<string>",
"submission_uncertain": true,
"updated_at": "2023-11-07T05:31:56Z",
"upstream_reference": "<string>",
"action_required": {
"expires_at": "2023-11-07T05:31:56Z",
"poll_after_ms": 1,
"url": "<string>"
}
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}Headers
Unique key for one canonical mutation request.
Required string length:
16 - 200Body
application/json
Required string length:
2Required string length:
3Required string length:
1 - 200Required string length:
1 - 100Maximum string length:
80Maximum string length:
80Response
Successful Response
Available options:
beneficiary_create, card_close, card_create, card_freeze, card_unfreeze, mandate_create, mandate_revoke, mandate_suspend, mandate_transfer, transfer, transfer_grant_revoke Available options:
requires_action, accepted, submitting, submitted, succeeded, failed, indeterminate, cancelled A hosted provider hand-off: open url, optionally before expires_at, optionally polling for the outcome after poll_after_ms milliseconds.
card_reveal, grant_approval, and connect actions always carry expires_at, and grant_approval actions a positive poll_after_ms; a null expires_at occurs only on kyc_session, and a null poll_after_ms means no polling applies.
Show child attributes
Show child attributes
⌘I