v1

latestOpenAPI 3.1.02026-07-26270268.6 KB

Fetch all or Search Transactions or Orders

get/pgw//api/v1/direct/order

Query parameters

FromDatestring date

Start Date (YYYY-MM-DD)

ToDatestring date

End Date (YYYY-MM-DD)

Skipinteger

Takeinteger

DetailedStatusesstring

Detailed Status of the transaction

Statusstring

Transaction Status

Response

200

totalCountinteger

totalAmountinteger

responseCodestring

detailedResponseCodestring

Example response

{
  "orders": [
    {
      "orderId": "80ff8b91-cace-4a94-508e-08daefc7eac1",
      "amount": 20,
      "totalAmount": 20,
      "settleAmount": 20,
      "currency": "SAR",
      "settleCurrency": "SAR",
      "language": "EN",
      "detailedStatus": "Paid",
      "status": "Success",
      "merchantId": "e80ece7e-fb2a-4c0b-de94-08d8a29a107b",
      "merchantPublicKey": "a087f4ca-9890-407b-9c2f-7630836cc020",
      "parentOrderId": "6b4e256a-eeb5-49c4-5080-08daefc7eac1",
      "tokenId": "09cae8c5-7f1b-45a7-1814-08dae3240197",
      "initiatedBy": "Internet",
      "paymentOperation": "Pay",
      "isTokenPayment": true,
      "orderSource": "GeideaGateway",
      "multiCurrency": {
        "authCurrency": "SAR",
        "authAmount": 20,
        "settleCurrency": "SAR",
        "settleAmount": 20
      },
      "isTest": true,
      "gatewayDecision": "ContinueToPayer",
      "createdDate": "2023-01-10T15:55:31.1823205",
      "createdBy": "PGW",
      "updatedDate": "2023-01-10T15:55:31.8454835",
      "updatedBy": "PGW"
    }
  ],
  "totalCount": 5,
  "responseCode": "000",
  "detailedResponseCode": "000"
}