A beneficiary is a saved recipient: a bank account or a mobile money wallet. Use beneficiaries as your address book.
A payout does not take a beneficiary id. When you pay a saved beneficiary, copy its details into
the payout’s beneficiary object. See Payouts.
Create a beneficiary
POST /v1/beneficiaries · needs the beneficiaries:write scope
bank_account or mobile_money.
The recipient’s details.
An alternative to accountName.
The currency this recipient is paid in.
The ben_ id. Use it in beneficiary URLs.
The screening status: pending, needs_review or blocked.
Set when the beneficiary has been archived.
Screening
Each new beneficiary gets a screening status in kycStatus.
Do not pay a beneficiary whose kycStatus is blocked.
List, get and archive
Archiving hides a beneficiary from the list. It does not affect payouts already sent.
Pay a saved beneficiary
Run a name check before you save a new beneficiary, and store the name the
bank returned.