AlRemittances
public final class AlRemittances
SDK Initialization object.
-
AlRemittances
object instance.Declaration
Swift
public static let shared: AlRemittances
-
Create a beneficiary for a user account.
Declaration
Swift
public func createBeneficiary(token: String, accountUuid: String, beneficiaryData: CreateBeneficiaryRequest, delegate: BeneficiaryDelegate)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
beneficiaryData
A
CreateBeneficiaryRequest
data model.delegate
The delegate to receive SDK updates.
-
Get a beneficiary account for a user.
Declaration
Swift
public func getBeneficiary(token: String, accountUuid: String, beneficiaryUuid: String, delegate: BeneficiaryDelegate)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
beneficiaryUuid
The uuid of the beneficiary.
delegate
The delegate to receive SDK updates.
-
Get all beneficiary accounts for a user.
Declaration
Swift
public func getBeneficiaries(token: String, accountUuid: String, limit: UInt? = nil, offset: UInt? = nil, type: String? = nil, delegate: BeneficiaryDelegate)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
limit
The number of items per page. Optional.
offset
Start after offset amount of records. Optional.
type
The beneficiaries type. Can be expressed by
BeneficiaryType
cases. Optional.delegate
The delegate to receive SDK updates.
-
Update a beneficiary account for a user.
Declaration
Swift
public func updateBeneficiary(token: String, accountUuid: String, beneficiaryUuid: String, beneficiaryData: UpdateBeneficiaryRequest, delegate: BeneficiaryDelegate)
Parameters
token
The token to authenticate the SDK.
accountUuid
The uuid of the account.
beneficiaryUuid
The uuid of the beneficiary.
beneficiaryData
A
UpdateBeneficiaryRequest
data model with the data updated.delegate
The delegate to receive SDK updates.
-
Delete a beneficiary account for a user.
Declaration
Swift
public func deleteBeneficiary(token: String, accountUuid: String, beneficiaryUuid: String, delegate: BeneficiaryDelegate)
Parameters
token
The token to authenticate the SDK.
accountUuid
The uuid of the account.
beneficiaryUuid
The uuid of the beneficiary.
delegate
The delegate to receive SDK updates.
-
Create a remittance quote for a beneficiary.
Declaration
Swift
public func createQuote(token: String, walletUuid: String, quoteData: CreateQuoteRequest, delegate: GlobalPaymentsDelegate)
Parameters
token
The token to authenticate the SDK.
walletUuid
The unique uuid of a wallet.
quoteData
A
CreateQuoteRequest
data model.delegate
The delegate to receive SDK updates.
-
Issue a remittance transaction to a beneficiary.
Declaration
Swift
public func issueRemittance(token: String, walletUuid: String, remittanceData: IssueRemittanceRequest, delegate: GlobalPaymentsDelegate)
Parameters
token
The token to authenticate the SDK.
walletUuid
The unique uuid of a wallet.
remittanceData
A
IssueRemittanceRequest
data model.delegate
The delegate to receive SDK updates.
-
Async bindings.
See moreDeclaration
Swift
class Async
-
Create a beneficiary for a user account.
Declaration
Swift
func createBeneficiary(token: String, accountUuid: String, beneficiaryData: CreateBeneficiaryRequest, completion: @escaping (Result<Beneficiary, EventError>) -> Void)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
beneficiaryData
A
CreateBeneficiaryRequest
data model.completion
Called when the call was completed.
-
Get a beneficiary account for a user.
Declaration
Swift
func getBeneficiary(token: String, accountUuid: String, beneficiaryUuid: String, completion: @escaping (Result<Beneficiary, EventError>) -> Void)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
beneficiaryUuid
The uuid of the beneficiary.
completion
Called when the call was completed.
-
Get all beneficiary accounts for a user.
Declaration
Swift
func getBeneficiaries(token: String, accountUuid: String, limit: UInt? = nil, offset: UInt? = nil, type: String? = nil, completion: @escaping (Result<[Beneficiary], EventError>) -> Void)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
limit
The number of items per page. Optional.
offset
Start after offset amount of records. Optional.
type
The beneficiaries type. Can be expressed by
BeneficiaryType
cases. Optional.completion
Called when the call was completed.
-
Update a beneficiary account for a user.
Declaration
Swift
func updateBeneficiary(token: String, accountUuid: String, beneficiaryUuid: String, beneficiaryData: UpdateBeneficiaryRequest, completion: @escaping (Result<Beneficiary, EventError>) -> Void)
Parameters
token
The token to authenticate the SDK.
accountUuid
The uuid of the account.
beneficiaryUuid
The uuid of the beneficiary.
beneficiaryData
A
UpdateBeneficiaryRequest
data model with the data updated.completion
Called when the call was completed.
-
Delete a beneficiary account for a user.
Declaration
Swift
func deleteBeneficiary(token: String, accountUuid: String, beneficiaryUuid: String, completion: @escaping (Result<Bool, EventError>) -> Void)
Parameters
token
The token to authenticate the SDK.
accountUuid
The uuid of the account.
beneficiaryUuid
The uuid of the beneficiary.
completion
Called when the call was completed.
-
Create a remittance quote for a beneficiary.
Declaration
Swift
func createQuote(token: String, walletUuid: String, quoteData: CreateQuoteRequest, completion: @escaping (Result<Quote, EventError>) -> Void)
Parameters
token
The token to authenticate the SDK.
walletUuid
The unique uuid of a wallet.
quoteData
A
CreateQuoteRequest
data model.completion
Called when the call was completed.
-
Issue a remittance transaction to a beneficiary.
Declaration
Swift
func issueRemittance(token: String, walletUuid: String, remittanceData: IssueRemittanceRequest, completion: @escaping (Result<Remittance, EventError>) -> Void)
Parameters
token
The token to authenticate the SDK.
walletUuid
The unique uuid of a wallet.
remittanceData
A
IssueRemittanceRequest
data model.completion
Called when the call was completed.
-
Combine bindings.
See moreDeclaration
Swift
class Futures