KashierDevelopersKashier Developers
API reference and playgroundPayment sessions

Get payment session

curl -X GET "https://test-api.kashier.io/v3/payment/sessions/string/payment"
{  "message": "success",  "data": {    "sessionId": "67ada35e9d5266001295b153",    "status": "PENDING",    "createdAt": "2025-02-13 07:46:38.018000+00:00",    "updatedAt": "2025-02-13 09:57:23.780000+00:00",    "merchantId": "MID-XXXX-XXXX",    "merchantOrderId": "testOrder123",    "amount": "100.00",    "currency": "EGP",    "method": "card",    "orderId": "NA",    "paymentChannel": "ONLINE",    "rfsDate": "NA",    "lastTransactionType": "NA",    "issuerAuthorizationCode": "NA",    "metaData": {      "customKey": "customValue",      "displayNotes": {        "key": "value"      }    },    "customer": {      "email": "[email protected]",      "reference": "894321"    },    "history": [      {        "status": "OPENED",        "date": "2025-02-13 09:57:23.783000+00:00"      }    ]  }}

Retrieves the current state (and history) of a payment session.

Authorization

secretKey
Authorization<token>

Merchant secret key used to identify the merchant, obtained from Kashier's dashboard. Pass the raw secret key value in the Authorization header (NOT a "Bearer" token).

In: header

Path Parameters

sessionId*string

The payment session identifier returned when the session was created.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

GET
/v3/payment/sessions/{sessionId}/payment

Abandon a payment session PATCH

Marks a session as ABANDONED — the customer closed the checkout, or you decided the session is no longer wanted. Abandoning is the clean way to end a session you will not use, rather than leaving i…

Get all transactions GET

Retrieves a list of transaction records based on multiple optional filter parameters, such as currency, amount, status, channel, etc. The data can be paginated, sorted, and searched.