Async

public class Async

Async bindings.

Beneficiary


                    
                    
                    createBeneficiary(token:accountUuid:beneficiaryData:)

Asynchronous

Creates a beneficiary for a user account.

Declaration

Swift

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

Parameters

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

Return Value

A Beneficiary object.


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


                    
                    
                    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 -> [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 array.


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


                    
                    
                    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 -> Bool

Parameters

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

Return Value

True if successful.

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


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


                    
                    
                    listCashPickupCities(token:query:)

Asynchronous

List cash pickup cities.

Declaration

Swift

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

Parameters

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

Return Value

A CashPickupCity array object.


                    
                    
                    listCashPickupLocations(token:query:)

Asynchronous

List cash pickup locations.

Declaration

Swift

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

Parameters

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

Return Value

A CashPickupLocations array object.


                    
                    
                    getCashPickupLocation(token:locationUuid:)

Asynchronous

Get cash pickup location.

Declaration

Swift

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

Parameters

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

Return Value

A CashPickupLocation object.

Payout Methods


                    
                    
                    createPayoutMethod(token:beneficiaryUuid:data:)

Asynchronous

Create a payout method.

Declaration

Swift

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

Parameters

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

Return Value

A PayoutMethod object.


                    
                    
                    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 -> [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 array.


                    
                    
                    getPayoutMethod(token:payoutMethodUuid:)

Asynchronous

Get a payout method.

Declaration

Swift

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

Parameters

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

Return Value

A Future object.


                    
                    
                    updatePayoutMethod(token:payoutMethodUuid:data:)

Asynchronous

Update a payout method.

Declaration

Swift

public func updatePayoutMethod(token: String,
                               payoutMethodUuid: String,
                               data: UpdatePayoutMethodRequest) async throws -> 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 object.


                    
                    
                    deletePayoutMethod(token:payoutMethodUuid:)

Asynchronous

Delete a payout method.

Declaration

Swift

public func deletePayoutMethod(token: String,
                               payoutMethodUuid: String) async throws -> Bool

Parameters

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

Return Value

A Future object.