Loading...
The Beneficiary API provides functionality for managing payment beneficiaries within the application. These endpoints allow users to save and retrieve bank account details for frequent recipients of transfers. Key features include: Saving validated bank accounts as beneficiaries Retrieving a user's list of saved beneficiaries Storing beneficiary details including account names, numbers, and bank information
Saves a validated bank account as a beneficiary for the authenticated user. This endpoint stores recipient details for future transfers, preventing the need for repeated account validation. Required Fields: accountName: Name of the account holder accountNumber: Account number of the beneficiary bankCode: Code of the beneficiary's bank nameEnquiryReference: Reference from account validation nickname (optional): Custom name for the beneficiary
Retrieves the list of all saved beneficiaries for the authenticated user. This endpoint provides access to previously saved recipient details for easy selection during transfers.