STstreampay
Payments

List Payments

Changed on

List all payments with pagination, filtering, and sorting options.

Payments can be filtered by invoice IDs, statuses, date ranges, or search terms.

get/api/v2/payments

Request

  • Base URL
    https://stream-app-service.streampay.sa
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Query parameters

invoice_idstring[] nullable

Filter by invoice IDs. Default is None.

statusesPaymentStatusEnum[] nullable

Filter by payment statuses. Default is None.

search_termstring nullable

Search term to filter payments. Default is None.

from_datestring date-time nullable

Filter payments from this date. Default is None.

to_datestring date-time nullable

Filter payments up to this date. Default is None.

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

sort_fieldstring nullable

Field to sort by, e.g., 'amount', 'scheduled_on'

sort_directionstring nullable

Sorting direction ('asc' or 'desc')

Response

Successful Response

Changes

  • 85261606a8eaRevision changes
    • info

      added the optional property // to the response with the status

  • 515eeea7d260Revision changes
    • warning

      added the new BNPL enum value to the // response property for the response status

    • warning

      added the new PARTIALLY_REFUNDED enum value to the // response property for the response status

    • warning

      added the new SPLIT_REMAINDER enum value to the // response property for the response status

    • info

      added the enum value PARTIALLY_REFUNDED to the property items/ of the query request parameter statuses

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status