AlRemittances Class Reference

shared
AlRemittances object instance.
Declaration
Swift

public static let shared: AlRemittances


                    
                    
                    combine

Futures object instance.

Declaration

Swift

public private(set) lazy var combine: Futures { get set }


                    
                    
                    async

Async object instance.

Declaration

Swift

public private(set) lazy var async: Async { get set }

Beneficiary


                    
                    
                    createBeneficiary(token:accountUuid:beneficiaryData:delegate:)

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.


                    
                    
                    listBeneficiaries(token:accountUuid:limit:offset:type:delegate:)

Lists beneficiary accounts for a user.

Declaration

Swift

public func listBeneficiaries(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.


                    
                    
                    getBeneficiary(token:accountUuid:beneficiaryUuid:delegate:)

Gets 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.


                    
                    
                    updateBeneficiary(token:accountUuid:beneficiaryUuid:beneficiaryData:delegate:)

Updates 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.


                    
                    
                    deleteBeneficiary(token:accountUuid:beneficiaryUuid:delegate:)

Deletes 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.

Global Payments


                    
                    
                    createQuote(token:walletUuid:data:delegate:)

Creates a remittance quote for a beneficiary.

Declaration

Swift

public func createQuote(token: String,
                        walletUuid: String,
                        data: CreateQuoteRequest,
                        delegate: GlobalPaymentsDelegate)

Parameters

`token`	The token to authenticate the SDK.
`walletUuid`	The unique uuid of a wallet.
`data`	A `CreateQuoteRequest` data model.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    createRemittance(token:walletUuid:data:delegate:)

Creates a remittance transaction to a beneficiary.

Declaration

Swift

public func createRemittance(token: String,
                             walletUuid: String,
                             data: CreateRemittanceRequest,
                             delegate: GlobalPaymentsDelegate)

Parameters

`token`	The token to authenticate the SDK.
`walletUuid`	The unique uuid of a wallet.
`data`	A `CreateRemittanceRequest` data model.
`delegate`	The delegate to receive SDK updates.

Cash Pickup


                    
                    
                    listCashPickupCities(token:query:delegate:)

List cash pickup cities.

Declaration

Swift

public func listCashPickupCities(token: String,
                                 query: CashPickupCitiesQuery,
                                 delegate: CashPickupDelegate)

Parameters

`token`	The token to authenticate the SDK.
`query`	The query to filter the retrieved cash pickup cities.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    listCashPickupLocations(token:query:delegate:)

List cash pickup locations.

Declaration

Swift

public func listCashPickupLocations(token: String,
                                    query: CashPickupLocationsQuery,
                                    delegate: CashPickupDelegate)

Parameters

`token`	The token to authenticate the SDK.
`query`	The query to filter the retrieved cash pickup locations.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    getCashPickupLocation(token:locationUuid:delegate:)

Get cash pickup location.

Declaration

Swift

public func getCashPickupLocation(token: String,
                                  locationUuid: String,
                                  delegate: CashPickupDelegate)

Parameters

`token`	The token to authenticate the SDK.
`locationUuid`	The unique uuid of a location.
`delegate`	The delegate to receive SDK updates.

Payout Methods


                    
                    
                    createPayoutMethod(token:beneficiaryUuid:data:delegate:)

Create a payout method.

Declaration

Swift

public func createPayoutMethod(token: String,
                               beneficiaryUuid: String,
                               data: CreatePayoutMethodRequest,
                               delegate: PayoutMethodsDelegate)

Parameters

`token`	The token to authenticate the SDK.
`beneficiaryUuid`	The uuid of the beneficiary.
`data`	A `CreatePayoutMethodRequest` data model.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    listPayoutMethods(token:beneficiaryUuid:limit:offset:delegate:)

List payout methods.

Declaration

Swift

public func listPayoutMethods(token: String,
                              beneficiaryUuid: String,
                              limit: UInt? = nil,
                              offset: UInt? = nil,
                              delegate: PayoutMethodsDelegate)

Parameters

`token`	The token to authenticate the SDK.
`beneficiaryUuid`	The uuid of the beneficiary.
`limit`	The number of items per page. Optional.
`offset`	Start after offset amount of records. Optional.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    getPayoutMethod(token:payoutMethodUuid:delegate:)

Get a payout method.

Declaration

Swift

public func getPayoutMethod(token: String,
                            payoutMethodUuid: String,
                            delegate: PayoutMethodsDelegate)

Parameters

`token`	The token to authenticate the SDK.
`payoutMethodUuid`	The uuid of the payout method.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    updatePayoutMethod(token:payoutMethodUuid:data:delegate:)

Update a payout method.

Declaration

Swift

public func updatePayoutMethod(token: String,
                               payoutMethodUuid: String,
                               data: UpdatePayoutMethodRequest,
                               delegate: PayoutMethodsDelegate)

Parameters

`token`	The token to authenticate the SDK.
`payoutMethodUuid`	The uuid of the payout method.
`data`	A `UpdatePayoutMethodRequest` data model.
`delegate`	The delegate to receive SDK updates.


                    
                    
                    deletePayoutMethod(token:payoutMethodUuid:delegate:)

Delete a payout method.

Declaration

Swift

public func deletePayoutMethod(token: String,
                               payoutMethodUuid: String,
                               delegate: PayoutMethodsDelegate)

Parameters

`token`	The token to authenticate the SDK.
`payoutMethodUuid`	The uuid of the payout method.
`delegate`	The delegate to receive SDK updates.

Async
Async bindings.
See more
Declaration
Swift

public class Async

Beneficiary


                    
                    
                    createBeneficiary(token:accountUuid:beneficiaryData:completion:)

Creates 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.


                    
                    
                    listBeneficiaries(token:accountUuid:limit:offset:type:completion:)

Lists beneficiary accounts for a user.

Declaration

Swift

func listBeneficiaries(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.


                    
                    
                    getBeneficiary(token:accountUuid:beneficiaryUuid:completion:)

Gets 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.


                    
                    
                    updateBeneficiary(token:accountUuid:beneficiaryUuid:beneficiaryData:completion:)

Updates 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.


                    
                    
                    deleteBeneficiary(token:accountUuid:beneficiaryUuid:completion:)

Deletes 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.

Global Payments


                    
                    
                    createQuote(token:walletUuid:data:completion:)

Creates a remittance quote for a beneficiary.

Declaration

Swift

func createQuote(token: String,
                 walletUuid: String,
                 data: CreateQuoteRequest,
                 completion: @escaping (Result<Quote, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`walletUuid`	The unique uuid of a wallet.
`data`	A `CreateQuoteRequest` data model.
`completion`	Called when the call was completed.


                    
                    
                    createRemittance(token:walletUuid:data:completion:)

Creates a remittance transaction to a beneficiary.

Declaration

Swift

func createRemittance(token: String,
                      walletUuid: String,
                      data: CreateRemittanceRequest,
                      completion: @escaping (Result<Remittance, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`walletUuid`	The unique uuid of a wallet.
`data`	A `CreateRemittanceRequest` data model.
`completion`	Called when the call was completed.


                    
                    
                    listCashPickupCities(token:query:completion:)

List cash pickup cities.

Declaration

Swift

func listCashPickupCities(token: String,
                          query: CashPickupCitiesQuery,
                          completion: @escaping (Result<[CashPickupCity], EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`query`	The query to filter the retrieved cash pickup cities.
`completion`	Called when the call was completed.


                    
                    
                    listCashPickupLocations(token:query:completion:)

List cash pickup locations.

Declaration

Swift

func listCashPickupLocations(token: String,
                             query: CashPickupLocationsQuery,
                             completion: @escaping (Result<[CashPickupLocation], EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`query`	The query to filter the retrieved cash pickup locations.
`completion`	Called when the call was completed.


                    
                    
                    getCashPickupLocation(token:locationUuid:completion:)

Get cash pickup location.

Declaration

Swift

func getCashPickupLocation(token: String,
                           locationUuid: String,
                           completion: @escaping (Result<CashPickupLocation, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`locationUuid`	The unique uuid of a location.
`completion`	Called when the call was completed.

Payout Methods


                    
                    
                    createPayoutMethod(token:beneficiaryUuid:data:completion:)

Create a payout method.

Declaration

Swift

func createPayoutMethod(token: String,
                        beneficiaryUuid: String,
                        data: CreatePayoutMethodRequest,
                        completion: @escaping (Result<PayoutMethod, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`beneficiaryUuid`	The uuid of the beneficiary.
`data`	A `CreatePayoutMethodRequest` data model.
`completion`	Called when the call was completed.


                    
                    
                    listPayoutMethods(token:beneficiaryUuid:limit:offset:completion:)

List payout methods.

Declaration

Swift

func listPayoutMethods(token: String,
                       beneficiaryUuid: String,
                       limit: UInt? = nil,
                       offset: UInt? = nil,
                       completion: @escaping (Result<[PayoutMethod], EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`beneficiaryUuid`	The uuid of the beneficiary.
`limit`	The number of items per page. Optional.
`offset`	Start after offset amount of records. Optional.
`completion`	Called when the call was completed.


                    
                    
                    getPayoutMethod(token:payoutMethodUuid:completion:)

Get a payout method.

Declaration

Swift

func getPayoutMethod(token: String,
                     payoutMethodUuid: String,
                     completion: @escaping (Result<PayoutMethod, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`payoutMethodUuid`	The uuid of the payout method.
`completion`	Called when the call was completed.


                    
                    
                    updatePayoutMethod(token:payoutMethodUuid:data:completion:)

Update a payout method.

Declaration

Swift

func updatePayoutMethod(token: String,
                        payoutMethodUuid: String,
                        data: UpdatePayoutMethodRequest,
                        completion: @escaping (Result<PayoutMethod, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`payoutMethodUuid`	The uuid of the payout method.
`data`	A `UpdatePayoutMethodRequest` data model.
`completion`	Called when the call was completed.


                    
                    
                    deletePayoutMethod(token:payoutMethodUuid:completion:)

Delete a payout method.

Declaration

Swift

func deletePayoutMethod(token: String,
                        payoutMethodUuid: String,
                        completion: @escaping (Result<Bool, EventError>) -> Void)

Parameters

`token`	The token to authenticate the SDK.
`payoutMethodUuid`	The uuid of the payout method.
`completion`	Called when the call was completed.

Futures
Combine bindings.
See more
Declaration
Swift

public class Futures