Monitor Session Status

SecurityBearer Authentication
Request
Request Body schema: application/json
required
session_id
required
string

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

transaction_id
string

The transaction identifier in Ratepay

partner_transaction_id
string

The transaction identifier on the merchant side

shop_buyer_id
string

The buyer identifier on the merchant side

session_status
required
string
Enum: "CREATED" "IN_PROGRESS" "COMPLETED" "ERROR" "EXPIRED" "CANCELED" "FRAUD_CANCELLATION_REQUESTED" "OTP_PENDING"
object (DeclineDto)
created_date
string

The date and time when the status was first created

updated_date
string

The date and time when the status was last updated

Responses
2xx

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

5xx

Handled as a failure, and will be retried later. It will be retried in intervals of 3, 6 and 9 seconds until giving up. If it cannot be delivered, the merchant is advised to use the session records API to fetch the latest status of the transaction.

4xx

Handled as a failure, and will be retried later. It will be retried in intervals of 3, 6 and 9 seconds until giving up. If it cannot be delivered, the merchant is advised to use the session records API to fetch the latest status of the transaction.

post/webhook-url
Request samples
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"
}