PayoutMethod.md

TransferZero::PayoutMethod

Properties

Name	Type	Description	Notes
type	String	Contains the currency to send the money to, and the type of the money movement Commonly used payout types are: - `NGN::Bank` - for Nigerian bank account payments. - `GHS::Bank` - for Ghanaian bank account payments. - `GHS::Mobile` - for Ghanaian mobile money payments. - `GHS::Cash` - for Ghanaian cash remittance payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `XOF::Mobile` - for mobile money payments to West-Africa. - `XOF::Bank` - for Senegalese bank account payments. - `XOF::Cash` - for Senegalese cash remittance payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank and FP accounts transfers in GBP. - `ZAR::Bank` - for South Africa bank account payments. - `USD::Bank` - for USD account payments. *** Currently for Egypt, Nigeria and United States only and in Beta phase *** - `USD::Cash` - for USD cash remittance payments. *** Currently for Nigeria only and in Beta phase *** - `KES::Bank` - for Kenyan bank account payments. - `KES::Mobile` - for Kenyan mobile money payments. - `XAF::Mobile` - for mobile money payments to Central African (CEMAC) countries. *** Currently in Beta phase *** - `XAF::Bank` - for Cameroon bank account payments. - `GNF::Mobile` - for mobile money payments to Guinea. - `BRL::Bank` - for Brazilian bank account payments. - `NZD::Bank` - for New Zealand bank account payments. - `INR::Bank` - for Indian bank account payments. - `BWP::Bank` - for Botswana bank account payments. - `ZMW::Bank` - for Zambian bank account payments. - `CAD::Bank` - for Canadian bank account payments. - `UGX::Bank` - for Ugandan bank account payments. - `EGP::Bank` - for Egyptian bank account payments. - `EGP::Cash` - for Egyptian cash payments. You can also send funds to the internal balance using `CCY::Balance`, where `CCY` is the appropriate currency. See Collection from senders for more info on how to collect money into internal balance	[optional]
details	PayoutMethodDetails		[optional]
metadata	Object	Metadata of payout method. You can store any kind of information in this field.	[optional]
id	String		[optional]
errors	Hash<String, Array<ValidationErrorDescription>>	The fields that have some problems and don't pass validation	[optional]
fields	Hash<String, FieldDescription>	The fields needed for payments with this payment method with details on validation requirements	[optional]

Code Sample

require 'TransferZero'

instance = TransferZero::PayoutMethod.new(type: NGN::Bank,
                                 details: null,
                                 metadata: {},
                                 id: null,
                                 errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]},
                                 fields: {"email":{"type":"input","validations":{"inclusion":{"in":{"NI":"National Id","PP":"Passport"},"allow_blank":true}}}})