class

Manza::Resources::Beneficiaries

Inherits Manza::Resources::Base < Reference < Object

Saved transfer recipients. Each beneficiary embeds its bank accounts; the one flagged default is used when a transfer names only the beneficiary_id. There is no update or delete via the API.

Instance methods

create

POST /api/beneficiaries

Keys: beneficiary_type ("individual" | "business"; inferred from person_name / company_name when omitted), person_name, company_name, email, phone_number. Values must be strings. Shares a 10/minute limit with #create_external_account.

Source

create_external_account(beneficiary_id : String, **attributes) : Response

POST /api/beneficiaries/:beneficiary_id/external_accounts

Required: account_number. Optional: name, country_code, currency_code, account_type ("bank" only), bank_identifier (required in ZA, rejected in MA, where it is derived from the RIB).

Source

get(id : String) : Response

GET /api/beneficiaries/:id

Source

get_external_account(beneficiary_id : String, id : String) : Response

GET /api/beneficiaries/:beneficiary_id/external_accounts/:id

Source

list(limit : Int32 = MAX_PER_PAGE, cursor : String | Nil = nil) : Page

GET /api/beneficiaries

Source

list_external_accounts(beneficiary_id : String, limit : Int32 = MAX_PER_PAGE, cursor : String | Nil = nil) : Page

GET /api/beneficiaries/:beneficiary_id/external_accounts

Source