AlRemittances Class Reference

shared
AlRemittances object instance.
Declaration
Swift

public static let shared: AlRemittances

Beneficiary


                    
                    
                    createBeneficiary(token:accountUuid:data:)

Asynchronous

Create a beneficiary for a user account.

Declaration

Swift

public func createBeneficiary(
    token: String,
    accountUuid: String,
    data: CreateBeneficiaryRequest
) async throws(ALEventError) -> Beneficiary

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`data`	A `CreateBeneficiaryRequest` data model.

Return Value

A Beneficiary.


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

Asynchronous

Lists beneficiary accounts for a user.

Declaration

Swift

public func listBeneficiaries(
    token: String,
    accountUuid: String,
    limit: UInt? = nil,
    offset: UInt? = nil,
    type: String? = nil
) async throws(ALEventError) -> [Beneficiary]

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.

Return Value

A Beneficiary list.


                    
                    
                    getBeneficiary(token:accountUuid:beneficiaryUuid:)

Asynchronous

Gets a beneficiary account for a user.

Declaration

Swift

public func getBeneficiary(
    token: String,
    accountUuid: String,
    beneficiaryUuid: String
) async throws(ALEventError) -> Beneficiary

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The user account uuid value.
`beneficiaryUuid`	The uuid of the beneficiary.

Return Value

A Beneficiary.


                    
                    
                    updateBeneficiary(token:accountUuid:beneficiaryUuid:beneficiaryData:)

Asynchronous

Updates a beneficiary account for a user.

Declaration

Swift

public func updateBeneficiary(
    token: String,
    accountUuid: String,
    beneficiaryUuid: String,
    beneficiaryData: UpdateBeneficiaryRequest
) async throws(ALEventError) -> Beneficiary

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.

Return Value

A Beneficiary.


                    
                    
                    deleteBeneficiary(token:accountUuid:beneficiaryUuid:)

Asynchronous

Deletes a beneficiary account for a user.

Declaration

Swift

public func deleteBeneficiary(
    token: String,
    accountUuid: String,
    beneficiaryUuid: String
) async throws(ALEventError)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The uuid of the account.
`beneficiaryUuid`	The uuid of the beneficiary.

Global Payments


                    
                    
                    createQuote(token:walletUuid:data:)

Asynchronous

Creates a remittance quote for a beneficiary.

Declaration

Swift

public func createQuote(
    token: String,
    walletUuid: String,
    data: CreateQuoteRequest
) async throws(ALEventError) -> Quote

Parameters

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

Return Value

A Quote.


                    
                    
                    createRemittance(token:walletUuid:data:)

Asynchronous

Creates a remittance transaction to a beneficiary.

Declaration

Swift

public func createRemittance(
    token: String,
    walletUuid: String,
    data: CreateRemittanceRequest
) async throws(ALEventError) -> Remittance

Parameters

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

Return Value

A Remittance.

Cash Pickup


                    
                    
                    listCashPickupCities(token:query:)

Asynchronous

List cash pickup cities.

Declaration

Swift

public func listCashPickupCities(
    token: String,
    query: CashPickupCitiesQuery
) async throws(ALEventError) -> [CashPickupCity]

Parameters

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

Return Value

A CashPickupCity list.


                    
                    
                    listCashPickupLocations(token:query:)

Asynchronous

List cash pickup locations.

Declaration

Swift

public func listCashPickupLocations(
    token: String,
    query: CashPickupLocationsQuery
) async throws(ALEventError) -> [CashPickupLocation]

Parameters

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

Return Value

A CashPickupLocation list.


                    
                    
                    getCashPickupLocation(token:locationUuid:)

Asynchronous

Get cash pickup location.

Declaration

Swift

public func getCashPickupLocation(
    token: String,
    locationUuid: String
) async throws(ALEventError) -> CashPickupLocation

Parameters

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

Return Value

A CashPickupLocation.

Payout Methods


                    
                    
                    createPayoutMethod(token:beneficiaryUuid:data:)

Asynchronous

Create a payout method.

Declaration

Swift

public func createPayoutMethod(
    token: String,
    beneficiaryUuid: String,
    data: CreatePayoutMethodRequest
) async throws(ALEventError) -> PayoutMethod

Parameters

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

Return Value

A PayoutMethod.


                    
                    
                    listPayoutMethods(token:beneficiaryUuid:limit:offset:)

Asynchronous

List payout methods.

Declaration

Swift

public func listPayoutMethods(
    token: String,
    beneficiaryUuid: String,
    limit: UInt? = nil,
    offset: UInt? = nil
) async throws(ALEventError) -> [PayoutMethod]

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.

Return Value

A PayoutMethod list.


                    
                    
                    getPayoutMethod(token:payoutMethodUuid:)

Asynchronous

Get a payout method.

Declaration

Swift

public func getPayoutMethod(
    token: String,
    payoutMethodUuid: String
) async throws(ALEventError) -> PayoutMethod

Parameters

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

Return Value

A PayoutMethod.


                    
                    
                    updatePayoutMethod(token:payoutMethodUuid:data:)

Asynchronous

Update a payout method.

Declaration

Swift

public func updatePayoutMethod(
    token: String,
    payoutMethodUuid: String,
    data: UpdatePayoutMethodRequest
) async throws(ALEventError) -> PayoutMethod

Parameters

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

Return Value

A PayoutMethod.


                    
                    
                    deletePayoutMethod(token:payoutMethodUuid:)

Asynchronous

Delete a payout method.

Declaration

Swift

public func deletePayoutMethod(
    token: String,
    payoutMethodUuid: String
) async throws(ALEventError)

Parameters

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