Add another Customer by its Receiving Code
customer:beneficiaries:writeAPI referansındaki uç nokta açıklamaları İngilizcedir.Adds the Customer that gave this Receiving Code as a Beneficiary. It is verified at once and is paid wherever that Customer receives, its balance or its Receiving Account, read again at every Payout, so its account details are never shown: account_hint carries the last four characters. Answers 201 with the new Beneficiary, or 200 with the one already there when this Customer linked that receiver before.
Requires the customer:beneficiaries:write permission. A Platform may call it for one of its End Customers with Apex-End-Customer.
ApiKeyYetkilendirmeBearer <API key>A Customer API key, created by a Customer admin in the Customer panel and shown once: Authorization: Bearer ak_live_… in production, ak_test_… elsewhere. A key holds a subset of its creator's permissions and may be limited to named IP addresses and an expiry date. Keys never manage people, other keys or approval rules, and never approve a Payout.
Apex-End-Customer?stringA Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers end_customer_not_found.
uuidThe Receiving Code the other Customer gave.
application/json- body
receiving_code*stringlength <= 32This receiver was linked before.
application/json- response
account_hint?stringaccount_hint is the last four characters of the account paid.
asset*stringasset is what the Beneficiary is paid in.
available*booleanavailable is false for a Beneficiary that is another Customer which cannot be paid now (neither a Receiving Account nor a balance it can be credited in, or it may not receive); it keeps its state, and a Payout to it is refused while it lasts.
country*stringcreated_at*stringdate-timedelivers_to?stringdelivers_to is, for another Customer, where a Payout to it would end now: balance (its balance on the platform; account_hint is then empty when it has no Receiving Account) or bank_account. Absent for other kinds and while it is unavailable.
"balance""bank_account"details*details are the account fields, as registered; empty for another Customer.
id*stringkind*stringkind is external (an outside party), own_account (the Customer's own account elsewhere) or customer (another Customer, added by its Receiving Code).
"external""own_account""customer"name*stringparty_type*string"individual""business"state*string"pending_verification""verified""blocked"updated_at*stringdate-timeverified_at?stringdate-timecurl -X POST 'http://localhost:3480/v1/beneficiaries/link' \ -H 'Content-Type: application/json' \ -d '{ "receiving_code": "RC-7KQ2-M9XD"}'{ "account_hint": "3000", "asset": "EUR", "available": true, "country": "DE", "created_at": "2026-11-12T08:02:11Z", "delivers_to": "balance", "details": { "iban": "DE89370400440532013000", "name": "Berlin Supplies GmbH" }, "id": "7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a", "kind": "external", "name": "Berlin Supplies GmbH", "party_type": "business", "state": "verified", "updated_at": "2026-11-12T08:15:00Z", "verified_at": "2026-11-12T08:15:00Z"}Register a Beneficiary POST
Registers a party the Customer will pay: `external` (an outside person or business) or `own_account` (the Customer's own account elsewhere, which needs `proof_reference`, a reference to the evidence that the account is the Customer's).
Get a Beneficiary GET
One of the Customer's Beneficiaries, as `GET /v1/beneficiaries` lists it.