Update Beneficiary

curl --request PATCH \
  --url https://20b9-41-90-209-232.ngrok-free.app/v1/beneficiaries/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nickname": "Ada (supplier)",
  "email": "ada@example.com"
}
'

const url = 'https://20b9-41-90-209-232.ngrok-free.app/v1/beneficiaries/{id}';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({nickname: 'Ada (supplier)', email: 'ada@example.com'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://20b9-41-90-209-232.ngrok-free.app/v1/beneficiaries/{id}"

payload = {
    "nickname": "Ada (supplier)",
    "email": "ada@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://20b9-41-90-209-232.ngrok-free.app/v1/beneficiaries/{id}"

	payload := strings.NewReader("{\n  \"nickname\": \"Ada (supplier)\",\n  \"email\": \"ada@example.com\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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))

}

{
  "object": "beneficiary",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "person",
  "name": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "business_name": "<string>",
  "nickname": "<string>",
  "email": "<string>",
  "relationship": "<string>",
  "address": {
    "line_1": "<string>",
    "line_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "currency": "<string>",
  "country": "<string>",
  "method": "<string>",
  "scheme": "<string>",
  "scheme_label": "<string>",
  "settlement": "<string>",
  "holder_name": "<string>",
  "routing": {},
  "route_label": "<string>",
  "status": "<string>",
  "missing_fields": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "livemode": true,
  "environment": "live"
}

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "Invalid API key provided."
  }
}

PATCH

beneficiaries

{id}

Update Beneficiary

curl --request PATCH \
  --url https://20b9-41-90-209-232.ngrok-free.app/v1/beneficiaries/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nickname": "Ada (supplier)",
  "email": "ada@example.com"
}
'

const url = 'https://20b9-41-90-209-232.ngrok-free.app/v1/beneficiaries/{id}';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({nickname: 'Ada (supplier)', email: 'ada@example.com'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://20b9-41-90-209-232.ngrok-free.app/v1/beneficiaries/{id}"

payload = {
    "nickname": "Ada (supplier)",
    "email": "ada@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://20b9-41-90-209-232.ngrok-free.app/v1/beneficiaries/{id}"

	payload := strings.NewReader("{\n  \"nickname\": \"Ada (supplier)\",\n  \"email\": \"ada@example.com\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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))

}

{
  "object": "beneficiary",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "person",
  "name": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "business_name": "<string>",
  "nickname": "<string>",
  "email": "<string>",
  "relationship": "<string>",
  "address": {
    "line_1": "<string>",
    "line_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "currency": "<string>",
  "country": "<string>",
  "method": "<string>",
  "scheme": "<string>",
  "scheme_label": "<string>",
  "settlement": "<string>",
  "holder_name": "<string>",
  "routing": {},
  "route_label": "<string>",
  "status": "<string>",
  "missing_fields": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "livemode": true,
  "environment": "live"
}

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "Invalid API key provided."
  }
}

Authorizations

Authorization

string

header

required

Secret API key from Settings → Developers → API keys. Example: Authorization: Bearer sk_test_…

Path Parameters

string<uuid>

required

Beneficiary id.

Body

application/json

nickname

string

Display label for lists and the dashboard.

string<email>

Contact email.

relationship

string

Relationship code (see corridors catalog).

address

object

Postal address for the recipient when the corridor requires it.

Show child attributes

Response

Updated beneficiary

object

enum<string>

Object type discriminator.

Available options:

beneficiary

string<uuid>

Beneficiary id — pass as beneficiary_id on payouts.

kind

enum<string>

Recipient type.

Available options:

person,

business

name

string

Display name derived from person or business fields.

first_name

string

Given name when kind is person.

last_name

string

Family name when kind is person.

business_name

string

Legal name when kind is business.

nickname

string

Optional display label.

string

Contact email.

relationship

string

Relationship to your workspace.

address

object

Postal address for the recipient when the corridor requires it.

Show child attributes

currency

string

Currency the recipient is paid in.

country

string

Corridor country.

method

string

High-level rail family (bank, mobile_money, …).

scheme

string

Corridor scheme id.

scheme_label

string

Human-readable scheme name.

settlement

string

Typical settlement timing (e.g. Instant, Same day).

holder_name

string

Account holder name on the rail.

routing

object

Scheme-specific account identifiers (may be partially masked).

route_label

string

Short label for the destination account.

status

string

Lifecycle status (active, archived, …).

missing_fields

string[]

Fields still required before the beneficiary can be paid.

created_at

string<date-time>

When the beneficiary was created (UTC).

updated_at

string<date-time>

When the beneficiary was last updated (UTC).

archived_at

string<date-time>

When archived, if applicable.

livemode

boolean

true when created with a live key.

environment

enum<string>

Environment of the creating API key.

Available options:

live,

sandbox

Overview

Account

Balances

Transactions

Beneficiaries

Corridors

FX

Payouts

Swaps

Payins

Update Beneficiary

Authorizations

Path Parameters

Body

Response