# Order Status OpenAPI specification

The Order Status API enables merchants to provide their customers and service agents with Ratepay's                       payment details at any customer contact point. This allows the merchant to remain the face to                       customers while gaining additional supplier services.  The Order Status API is built around RESTful principles. It is HTTPS-based and uses JSON as the                       request and response format. It delivers standard HTTP response types.

Version: version 1

## Servers

Production environment
```
http://api.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

[Order Status OpenAPI specification](https://docs.ratepay.com/_bundle/docs/developer/transaction_status/payment_api_1_8/operations.yaml)

## Other

### Get order status

 - [GET /order/status/v2/transactions/{transaction-id}](https://docs.ratepay.com/docs/developer/transaction_status/payment_api_1_8/operations/other/getorderstatus.md): This endpoint allows you to get order information for one transaction. The request can be configured to only return the data that is necessary for your specific use case.

### Get order correspondence

 - [GET /api/order/{transaction_id}/correspondences/invoices/{correspondence_id}/{format}](https://docs.ratepay.com/docs/developer/transaction_status/payment_api_1_8/operations/other/getordercorrespondence.md): This endpoint allows you to get correspondence Source of informationAll parameters needed for the request can be obtained via webhooks. This is a service that is only available for registered merchants. The service informs the merchant when a new transaction has been made and further information such as invoices are available for retrieval. How to activate this service can be found at the following link: Subscription webhooks Receivable information and its formatAs you can see, the successful response does not contain information in form of a JSON structure. All the information that can be received is received in form of an invoice file. You can choose whether to receive the invoices as pdf, html or via e-mail depending on your request. This information to access the different formats is contained in the payload of the webhook.