AlPayments

public final class AlPayments : Sendable

SDK Initialization object.

shared
AlPayments object instance.
Declaration
Swift

public static let shared: AlPayments

Payment Methods


                    
                    
                    createCard(token:accountUuid:data:)

Asynchronous

Creates a card.

Declaration

Swift

public func createCard(
    token: String,
    accountUuid: String,
    data: CardRequest
) async throws(ALEventError) -> Card

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The account uuid.
`data`	The data needed for the request.

Return Value

A Card.


                    
                    
                    getCard(token:accountUuid:paymentMethodUuid:)

Asynchronous

Gets a card.

Declaration

Swift

public func getCard(
    token: String,
    accountUuid: String,
    paymentMethodUuid: String
) async throws(ALEventError) -> Card

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The account uuid.
`paymentMethodUuid`	The payment method uuid.

Return Value

A Card.


                    
                    
                    listCards(token:accountUuid:query:)

Asynchronous

Lists cards.

Declaration

Swift

public func listCards(
    token: String,
    accountUuid: String,
    query: CardsQuery? = nil
) async throws(ALEventError) -> [Card]

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The account uuid.
`query`	The query.

Return Value

A Card list.


                    
                    
                    updateCard(token:paymentMethodUuid:data:)

Asynchronous

Updates a card.

Declaration

Swift

public func updateCard(
    token: String,
    paymentMethodUuid: String,
    data: CardUpdateRequest
) async throws(ALEventError) -> Card

Parameters

`token`	The token to authenticate the SDK.
`paymentMethodUuid`	The payment method uuid.
`data`	The data needed for the request.

Return Value

A Card.


                    
                    
                    deleteCard(token:accountUuid:paymentMethodUuid:)

Asynchronous

Deletes a card.

Declaration

Swift

public func deleteCard(
    token: String,
    accountUuid: String,
    paymentMethodUuid: String
) async throws(ALEventError)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The account uuid.
`paymentMethodUuid`	The payment method uuid.


                    
                    
                    createBankAccount(token:accountUuid:data:)

Asynchronous

Creates a bank account.

Declaration

Swift

public func createBankAccount(
    token: String,
    accountUuid: String,
    data: BankRequest
) async throws(ALEventError) -> Bank

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The account uuid.
`data`	The data needed for the request.

Return Value

A Bank.


                    
                    
                    createPlaidBankAccount(token:accountUuid:data:)

Asynchronous

Creates a plaid bank account.

Declaration

Swift

public func createPlaidBankAccount(
    token: String,
    accountUuid: String,
    data: PlaidBankRequest
) async throws(ALEventError) -> Bank

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The account uuid.
`data`	The data needed for the request.

Return Value

A Bank.


                    
                    
                    activatePlaidBankAccount(token:accountUuid:paymentMethodUuid:)

Asynchronous

Activates a plaid bank account.

Declaration

Swift

public func activatePlaidBankAccount(
    token: String,
    accountUuid: String,
    paymentMethodUuid: String
) async throws(ALEventError)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The account uuid.
`paymentMethodUuid`	The payment method uuid.


                    
                    
                    getBankAccount(token:accountUuid:paymentMethodUuid:)

Asynchronous

Gets a bank account.

Declaration

Swift

public func getBankAccount(
    token: String,
    accountUuid: String,
    paymentMethodUuid: String
) async throws(ALEventError) -> Bank

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The account uuid.
`paymentMethodUuid`	The payment method uuid.

Return Value

A Bank.


                    
                    
                    listBankAccounts(token:accountUuid:query:)

Asynchronous

Lists bank accounts.

Declaration

Swift

public func listBankAccounts(
    token: String,
    accountUuid: String,
    query: BanksQuery? = nil
) async throws(ALEventError) -> [Bank]

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The account uuid.
`query`	The query.

Return Value

A Bank list.


                    
                    
                    deleteBankAccount(token:accountUuid:paymentMethodUuid:)

Asynchronous

Deletes a bank account.

Declaration

Swift

public func deleteBankAccount(
    token: String,
    accountUuid: String,
    paymentMethodUuid: String
) async throws(ALEventError)

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The account uuid.
`paymentMethodUuid`	The payment method uuid.

Wallets


                    
                    
                    getWallet(token:accountUuid:walletUuid:)

Asynchronous

Gets a wallet.

Declaration

Swift

public func getWallet(
    token: String,
    accountUuid: String,
    walletUuid: String
) async throws(ALEventError) -> Wallet

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The account uuid.
`walletUuid`	The wallet uuid.

Return Value

A Wallet.


                    
                    
                    listWallets(token:accountUuid:query:)

Asynchronous

Lists wallets.

Declaration

Swift

public func listWallets(
    token: String,
    accountUuid: String,
    query: WalletsQuery? = nil
) async throws(ALEventError) -> [Wallet]

Parameters

`token`	The token to authenticate the SDK.
`accountUuid`	The account uuid.
`query`	The query.

Return Value

A Wallet list.


                    
                    
                    getTransactionDetails(token:transactionUuid:)

Asynchronous

Gets transaction details.

Declaration

Swift

public func getTransactionDetails(
    token: String,
    transactionUuid: String
) async throws(ALEventError) -> Transaction

Parameters

`token`	The token to authenticate the SDK.
`transactionUuid`	The transaction uuid.

Return Value

A Transaction.


                    
                    
                    cancelTransaction(token:transactionUuid:)

Asynchronous

Cancel transaction.

Declaration

Swift

public func cancelTransaction(
    token: String,
    transactionUuid: String
) async throws(ALEventError)

Parameters

`token`	The token to authenticate the SDK.
`transactionUuid`	The transaction uuid.


                    
                    
                    listTransactions(token:query:)

Asynchronous

Lists transactions.

Declaration

Swift

public func listTransactions(
    token: String,
    query: TransactionsQuery? = nil
) async throws(ALEventError) -> [Transaction]

Parameters

`token`	The token to authenticate the SDK.
`query`	The query.

Return Value

A Transaction list.


                    
                    
                    listChildTransactions(token:transactionUuid:query:)

Asynchronous

Lists child transactions.

Declaration

Swift

public func listChildTransactions(
    token: String,
    transactionUuid: String,
    query: ChildTransactionsQuery? = nil
) async throws(ALEventError) -> [Transaction]

Parameters

`token`	The token to authenticate the SDK.
`transactionUuid`	The wallet uuid.
`query`	The query.

Return Value

A Transaction list.


                    
                    
                    getReceipt(token:transactionUuid:)

Asynchronous

Gets a receipt.

Declaration

Swift

public func getReceipt(
    token: String,
    transactionUuid: String
) async throws(ALEventError) -> Receipt

Parameters

`token`	The token to authenticate the SDK.
`transactionUuid`	The wallet uuid.

Return Value

A Receipt.


                    
                    
                    loadFunds(token:walletUuid:data:)

Asynchronous

Loads funds.

Declaration

Swift

public func loadFunds(
    token: String,
    walletUuid: String,
    data: LoadFundsRequest
) async throws(ALEventError) -> Transaction

Parameters

`token`	The token to authenticate the SDK.
`walletUuid`	The wallet uuid.
`data`	The data needed for the request.

Return Value

A Transaction.


                    
                    
                    withdrawFunds(token:walletUuid:data:)

Asynchronous

Withdraws funds.

Declaration

Swift

public func withdrawFunds(
    token: String,
    walletUuid: String,
    data: WithdrawFundsRequest
) async throws(ALEventError) -> Transaction

Parameters

`token`	The token to authenticate the SDK.
`walletUuid`	The wallet uuid.
`data`	The data needed for the request.

Return Value

A Transaction.


                    
                    
                    sendFunds(token:walletUuid:data:)

Asynchronous

Send funds.

Declaration

Swift

public func sendFunds(
    token: String,
    walletUuid: String,
    data: SendFundsRequest
) async throws(ALEventError) -> Transaction

Parameters

`token`	The token to authenticate the SDK.
`walletUuid`	The wallet uuid.
`data`	The data needed for the request.

Return Value

A Transaction.


                    
                    
                    transferFunds(token:walletUuid:data:)

Asynchronous

Send funds.

Declaration

Swift

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

Parameters

`token`	The token to authenticate the SDK.
`walletUuid`	The wallet uuid.
`data`	The data needed for the request.

Return Value

A Transaction.


                    
                    
                    getWalletStatement(token:walletUuid:query:)

Asynchronous

Get wallet statement.

Declaration

Swift

public func getWalletStatement(
    token: String,
    walletUuid: String,
    query: WalletStatementQuery
) async throws(ALEventError) -> WalletStatementResponse

Parameters

`token`	The token to authenticate the SDK.
`transactionUuid`	The wallet uuid.
`query`	The query.

Return Value

A WalletStatementResponse.

CheckDeposits


                    
                    
                    depositCheck(token:walletUuid:data:)

Asynchronous

Deposits a check.

Declaration

Swift

public func depositCheck(
    token: String,
    walletUuid: String,
    data: DepositCheckRequest
) async throws(ALEventError) -> Check

Parameters

`token`	The token to authenticate the SDK
`walletUuid`	The wallet identifier.
`data`	The data needed for the request.

Return Value

A Check.


                    
                    
                    getCheck(token:walletUuid:checkUuid:)

Asynchronous

Gets a check.

Declaration

Swift

public func getCheck(
    token: String,
    walletUuid: String,
    checkUuid: String
) async throws(ALEventError) -> Check

Parameters

`token`	The token to authenticate the SDK
`walletUuid`	The wallet identifier.
`checkUuid`	The check identifier.

Return Value

A Check.


                    
                    
                    listChecks(token:walletUuid:query:)

Asynchronous

Lists checks.

Declaration

Swift

public func listChecks(
    token: String,
    walletUuid: String,
    query: ChecksQuery? = nil
) async throws(ALEventError) -> [Check]

Parameters

`token`	The token to authenticate the SDK
`walletUuid`	The wallet identifier.
`query`	The query.

Return Value

A Check list.


                    
                    
                    listCashLoadingLocations(token:query:)

Asynchronous

Lists cash loading locations.

Declaration

Swift

public func listCashLoadingLocations(
    token: String,
    query: CashLoadingLocationsQuery? = nil
) async throws(ALEventError) -> [CashLoadingLocation]

Parameters

`token`	The token to authenticate the SDK
`query`	The query.

Return Value

A CashLoadingLocation list.


                    
                    
                    generateCashLoadingBarcode(token:data:)

Asynchronous

Generates cash loading barcode.

Declaration

Swift

public func generateCashLoadingBarcode(
    token: String,
    data: CashLoadingBarcodeRequest
) async throws(ALEventError) -> CashLoadingBarcode?

Parameters

`token`	The token to authenticate the SDK
`data`	The data needed for the request.

Return Value

A CashLoadingBarcode.

UserInterface
UI.
See more
Declaration
Swift

final class UserInterface : Sendable
userInterface
UI object instance.
Declaration
Swift

static let userInterface: UserInterface