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

Try it

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     "expiresAt": "2024-03-01T10:30:00.000Z",
9     "customerId": "550e8400-e29b-41d4-a716-446655440001",
10     "payerLocation": "ZAF",
11     "redirectUrl": "https://merchant.com/payment/callback"
12   },
13   "payerId": "550e8400-e29b-41d4-a716-446655440001",
14   "payerDetails": {
15     "emailAddress": "emailAddress",
16     "location": "AFG",
17     "fullName": "fullName",
18     "phoneNumber": "phoneNumber",
19     "payerId": "payerId"
20   },
21   "activeTransaction": {
22     "status": "pending",
23     "transactionId": "550e8400-e29b-41d4-a716-446655440006",
24     "message": "Transaction is being processed",
25     "authState": {
26       "state": "state",
27       "transitionedAt": "transitionedAt",
28       "transactionId": "transactionId"
29     },
30     "merchantReference": "ORDER-12345",
31     "sessionId": "550e8400-e29b-41d4-a716-446655440003",
32     "identifiers": {
33       "key": "value"
34     },
35     "paymentAttributes": {
36       "key": "value"
37     },
38     "processorReference": "processorReference",
39     "financialTransactionReference": "financialTransactionReference",
40     "currentAttemptId": "currentAttemptId"
41   }
42 }

Get details of a payment session

Query parameters

sessionIdstringRequired

The ID of the session to get

Response

Session details retrieved successfully

sessionobject

payerIdstring

Unique identifier for the payer

payerDetailsobject or null

Payer details for pre-filling forms

activeTransactionobject or null

Transaction response containing status and details

Query parameters

Response

Errors