CreateBeneficiaryRequest
public struct CreateBeneficiaryRequest : Encodable
Create beneficiary request model.
-
The unique identifier of this beneficiary in your own system.
Declaration
Swift
public var externalId: String
-
Whether the beneficiary can be used for local or international transactions.
Declaration
Swift
public var type: BeneficiaryType
-
Whether the beneficiary is an individual or a business.
Declaration
Swift
public var legalType: BeneficiaryLegalType
-
The business’ name. Required if
legalType
is.business
.Declaration
Swift
public var businessName: String?
-
The beneficiary’s first name.
Declaration
Swift
public var firstName: String
-
The beneficiary’s middle name.
Declaration
Swift
public var middleName: String?
-
The beneficiary’s second last name.
Declaration
Swift
public var secondLastName: String?
-
The beneficiary’s last name.
Declaration
Swift
public var lastName: String
-
Three-letter country code (ISO 3166-1 alpha-3). The keys can be mapped from
Country
if you want type safety.Declaration
Swift
public var country: String
-
The currency details what currency type is being used for the transaction, using the ISO-4217 format. The keys can be mapped from
Currency
if you want type safety.Declaration
Swift
public var currency: String
-
The bank account details need to be one of the structures. Required if
cashPickupLocationDetails
isnil
.Declaration
Swift
public var bankAccountDetails: BankAccountDetails?
-
The cash pickup location details. Required if
bankAccountDetails
isnil
.Declaration
Swift
public var cashPickupLocationDetails: CashPickupLocationDetails?
-
Beneficiary address model. Optional.
Declaration
Swift
public var address: OptionalAddress?
-
Beneficiary date of birth. Optional.
Declaration
Swift
public var dateOfBirth: String?
-
The beneficiary’s phone number. Optional.
Declaration
Swift
public var phoneNumber: String?
-
The beneficiary’s label. Optional.
Declaration
Swift
public var label: String?
-
init(externalId:
type: firstName: lastName: country: currency: middleName: secondLastName: bankAccountDetails: cashPickupLocationDetails: legalType: businessName: address: dateOfBirth: phoneNumber: label: ) Auxiliary constructor.
Declaration
Swift
public init(externalId: String, type: BeneficiaryType, firstName: String, lastName: String, country: String, currency: String, middleName: String? = nil, secondLastName: String? = nil, bankAccountDetails: BankAccountDetails? = nil, cashPickupLocationDetails: CashPickupLocationDetails? = nil, legalType: BeneficiaryLegalType = .individual, businessName: String? = nil, address: OptionalAddress? = nil, dateOfBirth: String? = nil, phoneNumber: String? = nil, label: String? = nil)
Parameters
externalId
The unique identifier of this beneficiary in your own system.
type
Whether the beneficiary can be used for local or international transactions.
firstName
The beneficiary’s first name.
lastName
The beneficiary’s last name.
country
Three-letter country code (ISO 3166-1 alpha-3). The keys can be mapped from
Country
if you want type safety.currency
The currency details what currency type is being used for the transaction, using the ISO-4217 format.
middleName
The beneficiary’s middle name. Optional.
secondLastName
The beneficiary’s second last name. Optional.
bankAccountDetails
The bank account details need to be one of the structures. Required if
cashPickupLocationDetails
isnil
.cashPickupLocationDetails
The cash pickup location details. Required if
bankAccountDetails
isnil
.legalType
Whether the beneficiary is an individual or a business.
businessName
The business’ name. Optional if
legalType
is not.business
.address
Beneficiary address model. Optional.
dateOfBirth
Beneficiary date of birth. Optional.
phoneNumber
The beneficiary’s phone number. Optional.
label
The beneficiary’s label. Optional.