Get session details

GET

https://api.payos.money/api/v1/checkout/session

GET

/api/v1/checkout/session

1 curl -G https://api.payos.money/api/v1/checkout/session \
2      -d sessionId=550e8400-e29b-41d4-a716-446655440003

1 {
2   "session": {
3     "id": "550e8400-e29b-41d4-a716-446655440003",
4     "amount": 10000,
5     "currencyId": "ZAR",
6     "merchantReference": "ORDER-12345",
7     "merchantId": "550e8400-e29b-41d4-a716-446655440000",
8     "customerId": "550e8400-e29b-41d4-a716-446655440001",
9     "payerLocation": "ZAF",
10     "redirectUrl": "https://merchant.com/payment/callback"
11   },
12   "payerId": "550e8400-e29b-41d4-a716-446655440001",
13   "activeTransaction": {
14     "status": "pending",
15     "transactionId": "550e8400-e29b-41d4-a716-446655440006",
16     "message": "Transaction is being processed",
17     "merchantReference": "ORDER-12345",
18     "sessionId": "550e8400-e29b-41d4-a716-446655440003"
19   }
20 }

Get details of a payment session

Query parameters

sessionIdstringRequired

The ID of the session to get

Response

Session details retrieved successfully

sessionobject

payerIdstringformat: "uuid"

Unique identifier for the payer

payerDetailsobject

Payer details for pre-filling forms

activeTransactionobject

Transaction response containing status and details

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error