AlRemittances

public final class AlRemittances

SDK Initialization object.

  • AlRemittances object instance.

    Declaration

    Swift

    public static let shared: AlRemittances
  • Futures object instance.

    Declaration

    Swift

    @available(iOS 13.0, *)
    public private(set) lazy var combine: Futures { get set }
  • Async object instance.

    Declaration

    Swift

    @available(iOS 13.0, *)
    public private(set) lazy var async: Async { get set }

Beneficiary

Global Payments

Beneficiary

  • Create a beneficiary for a user account.

    Declaration

    Swift

    func createBeneficiary(token: String,
                           accountUuid: String,
                           beneficiaryData: CreateBeneficiaryRequest,
                           completion: @escaping (Result<Beneficiary, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    accountUuid

    The user account uuid value.

    beneficiaryData

    A CreateBeneficiaryRequest data model.

    completion

    Called when the call was completed.

  • Get a beneficiary account for a user.

    Declaration

    Swift

    func getBeneficiary(token: String,
                        accountUuid: String,
                        beneficiaryUuid: String,
                        completion: @escaping (Result<Beneficiary, EventError>) -> Void)

    Parameters

    token

    The token to authenticate the SDK.

    accountUuid

    The user account uuid value.

    beneficiaryUuid

    The uuid of the beneficiary.

    completion

    Called when the call was completed.

  • Get all beneficiary accounts for a user.

    Declaration

    Swift

    func getBeneficiaries(token: String,
                          accountUuid: String,
                          limit: UInt? = nil,
                          offset: UInt? = nil,
                          type: String? = nil,
                          completion: @escaping (Result<[Beneficiary], EventError>) -> Void)

    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.

    completion

    Called when the call was completed.

  • Update a beneficiary account for a user.

    Declaration

    Swift

    func updateBeneficiary(token: String,
                           accountUuid: String,
                           beneficiaryUuid: String,
                           beneficiaryData: UpdateBeneficiaryRequest,
                           completion: @escaping (Result<Beneficiary, EventError>) -> Void)

    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.

    completion

    Called when the call was completed.

  • Delete a beneficiary account for a user.

    Declaration

    Swift

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

    Parameters

    token

    The token to authenticate the SDK.

    accountUuid

    The uuid of the account.

    beneficiaryUuid

    The uuid of the beneficiary.

    completion

    Called when the call was completed.

Global Payments