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

Headers
X-Signaturestring

In order to make sure that the request did come from Ratepay, you can use this header to validate its authenticity. For more details, please refer to this page

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

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"
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 'Content-Type: application/json' \
  -H 'X-Signature: string' \
  -d '{
    "session_id": "string",
    "transaction_id": "string",
    "partner_transaction_id": "string",
    "shop_buyer_id": "string",
    "session_status": "CREATED",
    "decline_reasons": {
      "category": "string",
      "reasons": [
        "string"
      ],
      "invalid_fields": [
        {
          "json_path": "string",
          "message": "string"
        }
      ]
    },
    "created_date": "string",
    "updated_date": "string"
  }'

Responses

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