Skip to content
API requests
/
/Webhook format

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

Webhook format

Operations

Monitor Session Status

Request

Security
Bearer Authentication
Bodyapplication/jsonrequired
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

curl -i -X POST \
  https://payment-integration.ratepay.com/webhook-url \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "session_id": "string",
    "transaction_id": "string",
    "partner_transaction_id": "string",
    "shop_buyer_id": "string",
    "session_status": "CREATED",
    "decline_reasons": {
      "category": "string",
      "reasons": [
        "string"
      ]
    },
    "created_date": "string",
    "updated_date": "string"
  }'

Responses

Handled as success case - therefore, will not be retried.