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.


                    
                    
                    transferFunds(token:walletUuid:data:)

Asynchronous

Transfers funds to a beneficiary.

Declaration

Swift

public func transferFunds(token: String,
                          walletUuid: String,
                          data: TransferFundsRequest) async throws -> TransferFunds

Parameters

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

Return Value

A TransferFunds object.