Order Status OpenAPI specification (version 1)

Download OpenAPI specification:Download

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.

Get order status

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.

SecurityBearer Authentication
Request
path Parameters
transaction-id
required
string

The transaction id of the order for which the order status is requested. (The Ratepay Payment API returns this when an order is created.)

Example: 12-3456789123456789
query Parameters
include
Array of strings

Comma separated list of strings. Each string identifies one block of information (e.g. basket information) that should be included in the response. If this parameter is missing, only basic order information are returned.
Allowed values are (use comma to request more than one):

  • payment_status
  • payment_method
  • dunning_status
  • basket
  • all = include all available data
Example: include=all
header Parameters
Content-Type
required
string
Example: application/json
Authorization
required
string

For each request, a valid access token must be provided in the Authorization header. See Authentication API for obtaining a valid token.

Responses
200

Is returned if order status information is returned for the given transaction_id

404

Is returned if transaction_id is unknown.

405

Is returned if the endpoint is called with a request method other than GET

406

Is returned if the request accept header does not specify JSON as an accepted content type for the response.

415

Is returned if the request does not contain content type headers or if the request content type is anything other than JSON.

500

Is returned in case of a technical server error at Ratepay. Try again later.

get/order/status/v2/transactions/{transaction-id}
Request samples 
Response samples 
application/json;charset=UTF-8
{
  • "general_order_information": {
    },
  • "basket": {
    },
  • "payment_information": {
    }
}