Sign in

v1

latestOpenAPI 3.0.12026-08-0643087.3 KB
Session Records API

Retrieve a session record according to the session ID

get/pps/api/v1/session-record/{sessionId}

Path parameters

sessionIdstring required

The session ID, as returned from the request to create sessions

Response

Session record returned successfully

session_idstring required

The identifier of the interaction with the user within the scope of the Hosted Payment Page

transaction_idstring

The transaction identifier in Ratepay

partner_transaction_idstring

The transaction identifier on the merchant side

shop_buyer_idstring

The buyer identifier on the merchant side

session_status'CREATED' | 'IN_PROGRESS' | 'COMPLETED' | 'ERROR' | 'EXPIRED' | 'CANCELED' | 'FRAUD_CANCELLATION_REQUESTED' | 'OTP_PENDING' required

The current status of the record. <br> * CREATED - the session has just been created by the merchant, but the buyer still didn't do anything. <br> * IN_PROGRESS - the session is being processed by Ratepay.<br> * COMPLETED - the transaction has been successfully completed.<br> * ERROR - some processing error has happened (please refer to the field decline_reasons).<br> * EXPIRED - the buyer didn't take any action within 30 minutes. <br> * CANCELED - the buyer clicked on the cancel button. <br> * FRAUD_CANCELLATION_REQUESTED - Ratepay advises for this transaction to be canceled by the merchant. <br> * OTP_PENDING - the buyer has been requested to validate their phone number, and Ratepay is still waiting for the verification. <br>

created_datestring

The date and time when the status was first created

updated_datestring

The date and time when the status was last updated