SCscalev
Orders

Get orders by payment gateway reference IDs

Changed on

Requires the order:list scope. Retrieve orders using multiple payment gateway reference IDs. Values are trimmed and deduplicated before lookup. Supply between 1 and 25 nonblank IDs.

get/v3/orders/pg-reference-ids

Request

  • Base URL
    https://api.scalev.com
  • URL
    https://api.scalev.com/v3/orders/pg-reference-ids
  • Auth
    • HTTP bearer
    • or API key in header authorization

Query parameters

pg_reference_idsstring required

Comma-separated payment gateway reference IDs. Blank entries are ignored; surrounding whitespace is trimmed and duplicate IDs are ignored. The normalized list must contain between 1 and 25 nonblank IDs.

Response

Orders found

Example response

{
  "PG_REFERENCE_ID": {
    "order_id": "250101ABCDEFG"
  }
}

Changes

  • 251b881b98ebRevision changes
    • breaking

      for the query request parameter pg_reference_ids, the minLength was increased from 0 to 1

    • breaking

      added the pattern .*\S.* to the query request parameter pg_reference_ids

    • info

      added the non-success response with the status