Skip to content
API requests
/
2. Hosted Payment Page AP...
/
/
Retrieve a list of sessio...

OpenAPI definition (v0)

Download OpenAPI description
hpp_api.json
hpp_api.yaml
Languages
Servers
Integration environment

https://payment-integration.ratepay.com/

Production environment

https://payment.ratepay.com/

Session management API

Operations

Session Records API

Operations

Retrieve a list of session records based on supplied date

Request

Security
Bearer Authentication
Query
createdDatestring(date)required

A date, formatted as yyyy-MM-dd , when the records have been created

curl -i -X GET \
  'https://payment-integration.ratepay.com/pps/api/v1/session-record?createdDate=2019-08-24' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of session records returned successfully

Body*/*Array [
session_idstringrequired

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_statusstringrequired
Enum"CREATED""IN_PROGRESS""COMPLETED""ERROR""EXPIRED""CANCELED""FRAUD_CANCELLATION_REQUESTED""OTP_PENDING"
decline_reasonsobject(DeclineDto)
created_datestring

The date and time when the status was first created

updated_datestring

The date and time when the status was last updated

]
Response
No content

Retrieve a session record according to the session ID

Request

Security
Bearer Authentication
Path
sessionIdstringrequired

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

curl -i -X GET \
  'https://payment-integration.ratepay.com/pps/api/v1/session-record/{sessionId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Session record returned successfully

Body*/*
session_idstringrequired

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_statusstringrequired
Enum"CREATED""IN_PROGRESS""COMPLETED""ERROR""EXPIRED""CANCELED""FRAUD_CANCELLATION_REQUESTED""OTP_PENDING"
decline_reasonsobject(DeclineDto)
created_datestring

The date and time when the status was first created

updated_datestring

The date and time when the status was last updated

Response
No content

Webhook format

Operations