A date, formatted as yyyy-MM-dd , when the records have been created
API requests
/2. Hosted Payment Page AP...
- Retrieve a session record according to the session ID
Retrieve a list of session records based on supplied date
Retrieve a session record...
OpenAPI definition (v0)
Download OpenAPI description
Languages
Servers
Integration environment
https://payment-integration.ratepay.com
Production environment
https://payment.ratepay.com
- Integration environmenthttps://payment-integration.ratepay.com/pps/api/v1/session-record
- Production environmenthttps://payment.ratepay.com/pps/api/v1/session-record
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://payment-integration.ratepay.com/pps/api/v1/session-record?createdDate=2019-08-24' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'List of session records returned successfully
The identifier of the interaction with the user within the scope of the Hosted Payment Page
The current status of the record.
* CREATED - the session has just been created by the merchant, but the buyer still didn't do anything.
* IN_PROGRESS - the session is being processed by Ratepay.
* COMPLETED - the transaction has been successfully completed.
* ERROR - some processing error has happened (please refer to the field decline_reasons).
* EXPIRED - the buyer didn't take any action within 30 minutes.
* CANCELED - the buyer clicked on the cancel button.
* FRAUD_CANCELLATION_REQUESTED - Ratepay advises for this transaction to be canceled by the merchant.
* OTP_PENDING - the buyer has been requested to validate their phone number, and Ratepay is still waiting for the verification.
Enum"CREATED""IN_PROGRESS""COMPLETED""ERROR""EXPIRED""CANCELED""FRAUD_CANCELLATION_REQUESTED""OTP_PENDING"
Response
application/json
[ { "session_id": "string", "transaction_id": "string", "partner_transaction_id": "string", "shop_buyer_id": "string", "session_status": "CREATED", "decline_reasons": { … }, "created_date": "string", "updated_date": "string" } ]
- Integration environmenthttps://payment-integration.ratepay.com/pps/api/v1/session-record/{sessionId}
- Production environmenthttps://payment.ratepay.com/pps/api/v1/session-record/{sessionId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://payment-integration.ratepay.com/pps/api/v1/session-record/{sessionId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Session record returned successfully
The identifier of the interaction with the user within the scope of the Hosted Payment Page
The current status of the record.
* CREATED - the session has just been created by the merchant, but the buyer still didn't do anything.
* IN_PROGRESS - the session is being processed by Ratepay.
* COMPLETED - the transaction has been successfully completed.
* ERROR - some processing error has happened (please refer to the field decline_reasons).
* EXPIRED - the buyer didn't take any action within 30 minutes.
* CANCELED - the buyer clicked on the cancel button.
* FRAUD_CANCELLATION_REQUESTED - Ratepay advises for this transaction to be canceled by the merchant.
* OTP_PENDING - the buyer has been requested to validate their phone number, and Ratepay is still waiting for the verification.
Enum"CREATED""IN_PROGRESS""COMPLETED""ERROR""EXPIRED""CANCELED""FRAUD_CANCELLATION_REQUESTED""OTP_PENDING"
Response
application/json
{ "session_id": "string", "transaction_id": "string", "partner_transaction_id": "string", "shop_buyer_id": "string", "session_status": "CREATED", "decline_reasons": { "category": "string", "reasons": [ … ] }, "created_date": "string", "updated_date": "string" }