# OpenAPI definition

Version: v0

## Servers

Integration environment
```
https://payment-integration.ratepay.com
```

Production environment
```
https://payment.ratepay.com
```

## Security

### Bearer Authentication

For each request, a valid access token must be provided in the Authorization header. See [Authentication API](/docs/developer/authentication/authentication/) for obtaining a valid token.

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[OpenAPI definition](https://docs.ratepay.com/_bundle/apis/hpp/openapi/hpp_api.yaml)

## Session management API

### Creates a new session

 - [POST /pps/api/v1/session](https://docs.ratepay.com/apis/hpp/openapi/hpp_api/session-management-api/createsession.md)

## Session Records API

### Retrieve a list of session records based on supplied date

 - [GET /pps/api/v1/session-record](https://docs.ratepay.com/apis/hpp/openapi/hpp_api/session-records-api/getsessionrecordsbydate.md)

### Retrieve a session record according to the session ID

 - [GET /pps/api/v1/session-record/{sessionId}](https://docs.ratepay.com/apis/hpp/openapi/hpp_api/session-records-api/getsessionrecord.md)

## Webhook format

### Monitor Session Status

 - [POST /webhook-url](https://docs.ratepay.com/apis/hpp/openapi/hpp_api/webhook-format/webhook.md)