AlPayments

public final class AlPayments

SDK Initialization object.

  • AlPayments object instance.

    Declaration

    Swift

    public static let shared: AlPayments
  • Futures object instance.

    Declaration

    Swift

    public private(set) lazy var combine: Futures { get set }
  • Async object instance.

    Declaration

    Swift

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

Payment Methods

Wallets

CheckDeposits

Payment Methods

  • Creates a card.

    Declaration

    Swift

    func createCard(
        token: String,
        accountUuid: String,
        data: CardRequest,
        completion: @escaping (Result<(card: Card, validation: CardValidationResult), EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    accountUuid

    The account uuid.

    data

    The data needed for the request.

    completion

    Called when the call was completed.

  • Gets a card.

    Declaration

    Swift

    func getCard(
        token: String,
        accountUuid: String,
        paymentMethodUuid: String,
        completion: @escaping (Result<Card, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    accountUuid

    The account uuid.

    paymentMethodUuid

    The payment method uuid.

    completion

    Called when the call was completed.

  • Lists cards.

    Declaration

    Swift

    func listCards(
        token: String,
        accountUuid: String,
        query: CardsQuery? = nil,
        completion: @escaping (Result<[Card], EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    accountUuid

    The account uuid.

    query

    The query.

    completion

    Called when the call was completed.

  • Deletes a card.

    Declaration

    Swift

    func deleteCard(
        token: String,
        accountUuid: String,
        paymentMethodUuid: String,
        completion: @escaping (Result<Bool, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    accountUuid

    The account uuid.

    paymentMethodUuid

    The payment method uuid.

    completion

    Called when the call was completed.

  • Creates a bank account.

    Declaration

    Swift

    func createBankAccount(
        token: String,
        accountUuid: String,
        data: BankRequest,
        completion: @escaping (Result<Bank, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    accountUuid

    The account uuid.

    data

    The data needed for the request.

    completion

    Called when the call was completed.

  • Creates a plaid bank account.

    Declaration

    Swift

    func createPlaidBankAccount(
        token: String,
        accountUuid: String,
        data: PlaidBankRequest,
        completion: @escaping (Result<Bank, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    accountUuid

    The account uuid.

    data

    The data needed for the request.

    completion

    Called when the call was completed.

  • Activates a plaid bank account.

    Declaration

    Swift

    func activatePlaidBankAccount(
        token: String,
        accountUuid: String,
        paymentMethodUuid: String,
        completion: @escaping (Result<Bool, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    accountUuid

    The account uuid.

    paymentMethodUuid

    The payment method uuid.

    completion

    Called when the call was completed.

  • Gets a bank account.

    Declaration

    Swift

    func getBankAccount(
        token: String,
        accountUuid: String,
        paymentMethodUuid: String,
        completion: @escaping (Result<Bank, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    accountUuid

    The account uuid.

    paymentMethodUuid

    The payment method uuid.

    completion

    Called when the call was completed.

  • Lists bank accounts.

    Declaration

    Swift

    func listBankAccounts(
        token: String,
        accountUuid: String,
        query: BanksQuery? = nil,
        completion: @escaping (Result<[Bank], EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    accountUuid

    The account uuid.

    query

    The query.

    completion

    Called when the call was completed.

  • Deletes a bank account.

    Declaration

    Swift

    func deleteBankAccount(
        token: String,
        accountUuid: String,
        paymentMethodUuid: String,
        completion: @escaping (Result<Bool, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    accountUuid

    The account uuid.

    paymentMethodUuid

    The payment method uuid.

    completion

    Called when the call was completed.

  • Gets a wallet.

    Declaration

    Swift

    func getWallet(
        token: String,
        accountUuid: String,
        walletUuid: String,
        completion: @escaping (Result<Wallet, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    accountUuid

    The account uuid.

    walletUuid

    The wallet uuid.

    completion

    Called when the call was completed.

  • Lists wallets.

    Declaration

    Swift

    func listWallets(
        token: String,
        accountUuid: String,
        query: WalletsQuery? = nil,
        completion: @escaping (Result<[Wallet], EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    accountUuid

    The account uuid.

    query

    The query.

    completion

    Called when the call was completed.

  • Gets transaction details.

    Declaration

    Swift

    func getTransactionDetails(
        token: String,
        transactionUuid: String,
        completion: @escaping (Result<Transaction, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    transactionUuid

    The transaction uuid.

    completion

    Called when the call was completed.

  • Cancel transaction.

    Declaration

    Swift

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

    Parameters

    token

    The token to authenticate the SDK.

    transactionUuid

    The transaction uuid.

    completion

    Called when the call was completed.

  • Lists wallet transactions.

    Declaration

    Swift

    func listWalletTransactions(
        token: String,
        walletUuid: String,
        query: WalletTransactionsQuery? = nil,
        completion: @escaping (Result<[Transaction], EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    walletUuid

    The wallet uuid.

    query

    The query.

    completion

    Called when the call was completed.

  • Lists child transactions.

    Declaration

    Swift

    func listChildTransactions(
        token: String,
        transactionUuid: String,
        query: ChildTransactionsQuery? = nil,
        completion: @escaping (Result<[Transaction], EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    transactionUuid

    The wallet uuid.

    query

    The query.

    completion

    Called when the call was completed.

  • Gets a receipt.

    Declaration

    Swift

    func getReceipt(
        token: String,
        transactionUuid: String,
        completion: @escaping (Result<Receipt, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    transactionUuid

    The wallet uuid.

    completion

    Called when the call was completed.

  • Loads funds.

    Declaration

    Swift

    func loadFunds(
        token: String,
        walletUuid: String,
        data: LoadFundsRequest,
        completion: @escaping (Result<Transaction, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    walletUuid

    The wallet uuid.

    data

    The data needed for the request.

    completion

    Called when the call was completed.

  • Withdraws funds.

    Declaration

    Swift

    func withdrawFunds(
        token: String,
        walletUuid: String,
        data: WithdrawFundsRequest,
        completion: @escaping (Result<Transaction, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    walletUuid

    The wallet uuid.

    data

    The data needed for the request.

    completion

    Called when the call was completed.

  • Sends funds.

    Declaration

    Swift

    func sendFunds(
        token: String,
        walletUuid: String,
        data: SendFundsRequest,
        completion: @escaping (Result<Transaction, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    walletUuid

    The wallet uuid.

    data

    The data needed for the request.

    completion

    Called when the call was completed.

  • Transfer funds.

    Declaration

    Swift

    func transferFunds(
        token: String,
        walletUuid: String,
        data: TransferFundsRequest,
        completion: @escaping (Result<Transaction, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    walletUuid

    The wallet uuid.

    data

    The data needed for the request.

    completion

    Called when the call was completed.

Check deposit

  • Deposits a check.

    Declaration

    Swift

    func depositCheck(
        token: String,
        walletUuid: String,
        data: DepositCheckRequest,
        completion: @escaping (Result<Check, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK

    walletUuid

    The wallet identifier.

    data

    The data needed for the request.

    completion

    Called when the call was completed.

  • Gets a check.

    Declaration

    Swift

    func getCheck(
        token: String,
        walletUuid: String,
        checkUuid: String,
        completion: @escaping (Result<Check, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    walletUuid

    The wallet uuid.

    checkUuid

    The check identifier.

    completion

    Called when the call was completed.

  • Lists checks.

    Declaration

    Swift

    func listChecks(
        token: String,
        walletUuid: String,
        query: ChecksQuery? = nil,
        completion: @escaping (Result<[Check], EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    checkUuid

    The check identifier.

    query

    The query.

    completion

    Called when the call was completed.

  • Combine bindings.

    See more

    Declaration

    Swift

    public class Futures