{
  "opencollection": "1.0.0",
  "info": {
    "name": "3DS 3DS actions PaymentQueries API",
    "version": "3"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "PaymentQueries",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Query payments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://try.access.worldpay.com/paymentQueries/payments",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "An ISO 8601 date-time supplied as a string. Filters for payments that occurred after the specified date-time. Must be supplied alongside endDate."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "An ISO 8601 date-time supplied as a string. Filters for payments that occurred below the specified date-time. Must be supplied alongside startDate."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The maximum number of payments to be returned in the response (max 300)."
              },
              {
                "name": "currency",
                "value": "",
                "type": "query",
                "description": "The three digit currency code."
              },
              {
                "name": "minAmount",
                "value": "",
                "type": "query",
                "description": "This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:`250`)."
              },
              {
                "name": "maxAmount",
                "value": "",
                "type": "query",
                "description": "This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:`250`)."
              },
              {
                "name": "last4Digits",
                "value": "",
                "type": "query",
                "description": "The last four digits of the card number."
              },
              {
                "name": "entityReferences",
                "value": "",
                "type": "query",
                "description": "Your entity reference(s)."
              },
              {
                "name": "receivedEvents",
                "value": "",
                "type": "query",
                "description": "Name of the event."
              },
              {
                "name": "transactionReference",
                "value": "",
                "type": "query",
                "description": "A unique reference generated by you, used to identify a payment throughout its lifecycle. This shouldn't be used in conjunction with the above fields. Use it as a single parameter to query data."
              }
            ]
          },
          "docs": "Query payments within a specified date time range.\n\nThese payments can be filtered by currency, minAmount, maxAmount, last4Digits & receivedEvents.\n\nThe API returns data for payments processed after 25 June 2024. For payments processed before then use our [query for historical payments](/products/payment-queries/@v1/query-archive.md)."
        },
        {
          "info": {
            "name": "Retrieve a payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://try.access.worldpay.com/paymentQueries/payments/:paymentId",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "paymentId",
                "value": "payv0A4Hx2eY1-5P2_CpV7qy0",
                "type": "path",
                "description": "Unique identifier generated for each payment. Historic `paymentId` values in UUID format."
              }
            ]
          },
          "docs": "Retrieve a single payment by payment ID.\n\nThe API returns detailed data for payments processed after 25 June 2024. For payments processed before then use our [query for historical payments](/products/payment-queries/@v1/query-archive.md)."
        },
        {
          "info": {
            "name": "Query historical payments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://try.access.worldpay.com/paymentQueries/archivedPayments",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "transactionReference",
                "value": "",
                "type": "query",
                "description": "A unique reference generated by you, used to identify a payment throughout its lifecycle."
              },
              {
                "name": "entityReference",
                "value": "",
                "type": "query",
                "description": "A merchant entity."
              }
            ]
          },
          "docs": "Query payments processed before 25 June 2024.\n\nProvide a `transactionReference` and `entityReference` for a payment to find the matching payment in the archive."
        }
      ]
    }
  ],
  "bundled": true
}