A beneficiary is a saved payee. You add the people and businesses a customer wants to pay, then reference them by beneficiaryId when you make a payment.

​
What you send

Send the payee’s bank details as a discriminated account object — set type to uk or iban and include that type’s fields. Which one you use depends on the account:
account.typeSend
uksortCode + accountNumber
ibaniban (and bic if you have it; bankName for SEPA)
You don’t always need the bic — when you send an iban, we fill the bic in for you where we can.

​
Adding a beneficiary needs confirmation

Creating a payee is a sensitive action, so it needs a step-up confirmation — the customer proves it’s really them with a passkey, a 2FA code, or a PIN (a program capability), sent as a confirmation object. See Add a beneficiary for the three ways to confirm.

​
A note on program differences

Some programs require a beneficiary address. If yours does, creating a beneficiary without an address returns a validation error. If you’re not sure whether this applies to your program, contact the team.

​
What you can do

Add a beneficiary

Create a payee and confirm it.

Manage beneficiaries

List, view, enable, and delete payees.

International beneficiary

Add a payee for cross-border payments.

Verify a payee

Check a name matches the account before you pay.