Query parameters

• filters string

  Filter criteria in the format: field==value,field!=value Multiple filters can be separated by commas. Available fields: id, paymentMethodType, currency, description, ownerId

• sorts string

  Sort criteria as comma-separated field names. Available fields: id, paymentMethodType, currency, description, ownerId

• page integer

  Page number to retrieve (starts at 1). For example, if you have 100 records with 10 per page, page 2 gives you records 11 to 20.

  Minimum value is 1. Default value is 1.

• pageSize integer

  Number of records per page. For example, if you have 100 records with 10 per page, page 2 gives you records 11 to 20.

  Minimum value is 1, maximum value is 100. Default value is 10.

Responses

• 200 application/json

  A successful paginated response containing available payment methods

  Hide response attributes Show response attributes object

  • totalCount integer Required

    Total number of payment methods that match the filter criteria

  • page integer Required

    The current page number (starts at 1)

  • pageSize integer Required

    Number of items per page

  • totalPages integer Required

    Total number of pages available

  • hasNextPage boolean Required

    True if there are more pages of results available

  • hasPreviousPage boolean Required

    True if there are previous pages of results available

  • items array[object] Required

    Array of payment methods for the current page

    Hide items attributes Show items attributes object

    • id string Required

      The payment method ID. Physical terminals will be prefixed with pmt_trm_ and virtual terminals will be prefixed with pmt_vrt_.

    • type string Required

      Values are Physical or Virtual.

    • currency string Required

      Values are USD or CAD.

    • description string Required

      A human-readable name for the payment method

      Maximum length is 1000.

• 401 application/json

  Unauthorized response due to an invalid or missing API key.

  Hide response attributes Show response attributes object

  • code number

    Numeric error code. These are grouped into ranges for easier identification and troubleshooting.

    • 1000 - AuthenticationGenericError
    • 2000 - RequestValidationGenericError
    • 3000 - UnknownServerGenericError
    • 9000 - UnhandledGenericError

    Values are 1000, 2000, 3000, or 9000.

  • status string

    Execution status of the request sent to the payment gateway.

    • Completed - The request completed successfully.
    • Rejected - The request was rejected by the payment gateway. No action or side effects occurred. The transaction can safely be retried.
    • Interrupted - The request was interrupted, and the final status is unknown. Possible side effects may have occurred (e.g., a Sale (Token) that returns Interrupted might still charge the customer, even if an error is returned). Additional checks are required before retrying the transaction.
    • Unknown

    Values are Completed, Rejected, Interrupted, or Unknown.

  • message string

    Developer-facing error message.

  • traceId string

    Unique trace identifier for tracking and debugging this request.

  • timestamp string(date-time)

    The timestamp when the error occurred (UTC).

  • errorDetails array[object]

    Represents a validation error that occurred during the request.

    Hide errorDetails attributes Show errorDetails attributes object

    • code number

      Error code

    • field string

      The field with the error

    • message string

      Error message

    • details string

      Additional details about the error