PaymentListRequest

public struct PaymentListRequest : Codable

Request model to list Payments.

  • If you are providing our Payment service to your own business clients (merchants), then you should set the Id of your merchant.

    Declaration

    Swift

    public let merchantID: String?
  • The Id of the end-user. If you are providing this service directly to the end-users, then you can assign that Id to this parameter. If you are providing this service to businesses, then you should assign the Id of that merchant’s user.

    Declaration

    Swift

    public let merchantUserID: String?
  • Filters results that has been created after the startDate in ISO 8601 with fractional seconds.

    Declaration

    Swift

    public let startDate: Date?
  • Filter sresults that has been created before the endDate in ISO 8601 format with fractional seconds.

    Declaration

    Swift

    public let endDate: Date?
  • Filters results by paymentType.

    Note

    Enum: “Auto” “Domestic” “DomesticScheduled” “International” “InternationalScheduled”

    Declaration

    Swift

    public let paymentType: PaymentType?
  • Paging number for query results exceeding result count limit for a single response.

    Note

    Default: 1

    Declaration

    Swift

    public let page: Int?
  • Creates an instance from the specified parameters.

    Declaration

    Swift

    public init(merchantID: String?,
                merchantUserID: String?,
                startDate: Date?,
                endDate: Date?,
                paymentType: PaymentType?,
                page: Int?)

    Parameters

    merchantID

    If you are providing our Payment service to your own business clients (merchants), then you should set the Id of your merchant.

    merchantUserID

    The Id of the end-user.

    startDate

    Filters results that has been created after the startDate in ISO 8601 with fractional seconds.

    endDate

    Filters results that has been created before the endDate in ISO 8601 format with fractional seconds.

    paymentType

    Instance’s PaymentType, which provides to filter results by paymentType.

    page

    Paging number for query results exceeding result count limit for a single response.