Search sessions by merchant reference

[
  {
    "session": {
      "id": "string",
      "amount": 1.1,
      "currencyId": "string",
      "merchantReference": "string",
      "merchantId": "string",
      "expiresAt": null,
      "customerId": "string",
      "payerLocation": "AFG",
      "redirectUrl": "string",
      "paymentAttributes": {},
      "fxCommit": {
        "quoteId": "string",
        "collectionCurrency": "AED",
        "collectionAmount": "string",
        "midRate": "string",
        "markupBps": 1,
        "allInRate": "string",
        "fee": "string",
        "expiresAt": "2024-01-15T09:30:00Z",
        "pricingModel": "SPOT_QUOTE"
      }
    },
    "payerId": "string",
    "payerDetails": {
      "emailAddress": "string",
      "location": "AFG",
      "fullName": "string",
      "phoneNumber": "string",
      "payerId": "string"
    },
    "activeTransaction": {
      "status": "string",
      "transactionId": "string",
      "message": "string",
      "authState": {
        "state": "string",
        "transitionedAt": "string",
        "transactionId": "string"
      },
      "merchantReference": "string",
      "sessionId": "string",
      "identifiers": {},
      "paymentAttributes": {},
      "paymentMethodId": "string",
      "processorName": "string",
      "processorReference": "string",
      "financialTransactionReference": "string",
      "currentAttemptId": "string",
      "batchPayoutId": "string",
      "collection": {
        "amount": "string",
        "currency": "string"
      },
      "fxMidRate": "string",
      "fxAllInRate": "string",
      "fxMarkupBps": 1,
      "fxFee": {
        "amount": "string",
        "currency": "string"
      }
    }
  }
]

Retrieves checkout sessions matching a merchant reference, most recent first. Each result has the same shape as Get Session, including the active transaction when a payment has been initiated.

Query parameters

merchantReferencestringRequired

Merchant reference to search for

merchantIdslist of stringsRequired

Comma-separated list of merchant IDs to search within

Response

Sessions retrieved successfully

sessionobject

payerIdstringformat: "uuid"

Unique identifier for the payer

payerDetailsobjectOptional

Payer details for pre-filling forms

activeTransactionobjectOptional

Transaction response containing status and details

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl -G https://api.payos.money/api/v1/checkout/session/search \
>	-d merchantReference=merchantReference \
>	-d merchantIds=string