Beneficiaries
Register, manage, and verify payment recipients — bank accounts and digital wallets. A beneficiary needs to be created before a payment can be made, representing the individual or organisation being paid along with their bank details and payment method. Upon creation, a unique beneficiary ID is generated, which can be referenced when initiating a payment.
Endpoints
Enum Reference
BeneficiaryStatus
The lifecycle status of a beneficiary.
EntityType
The entity type of the beneficiary.
RelationType
The relationship between your account and the beneficiary.
AccountType
The type of beneficiary account.
WalletAccountType
The account type within the WorldFirst or Alipay wallet ecosystem.
WalletBrandName
Supported wallet brands for digital wallet beneficiaries.
BeneficiaryDepositType
The deposit category for a bank account beneficiary.
PaymentType
The payment rail used to send funds.
ValidationErrorType
The type of field-level validation error returned by the Validate a Beneficiary endpoint.
RestrictionType
The type of validation constraint defined in a beneficiary field template.
CardClientCode
The type of identity document associated with card-based beneficiary information.