PayeeLocationService

public struct PayeeLocationService

Provides access to payee location operations

  • Returns a list of all payee locations for a plan.

    Declaration

    Swift

    public func payeeLocations(planId: String) async throws -> [PayeeLocation]

    Parameters

    planId

    The id of the plan (last_used can also be used to specify the last used plan)

    Return Value

    A list of payee locations

  • Returns a specific payee location.

    Declaration

    Swift

    public func payeeLocation(
    planId: String,
    payeeLocationId: String
) async throws -> PayeeLocation

    Parameters

    planId

    The id of the plan (last_used can also be used to specify the last used plan)
    payeeLocationId

    The id of the payee location

    Return Value

    A single payee location

  • Returns all locations for a payee.

    Declaration

    Swift

    public func locationsForPayee(
    planId: String,
    payeeId: String
) async throws -> [PayeeLocation]

    Parameters

    planId

    The id of the plan (last_used can also be used to specify the last used plan)
    payeeId

    The id of the payee

    Return Value

    A list of payee locations