Skip to content
Developer
/Transaction Status API/
/Operations

Transaction Status OpenAPI specification (version 1)

The Transaction 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 Transaction 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.

Download OpenAPI description
operations.json
operations.yaml
Languages
Servers
Production environment

http://api.ratepay.com/

Get Transaction Status

Request

This endpoint allows you to get transaction information. The request can be configured to only return the data that is necessary for your specific use case.

Security
Bearer Authentication
Path
transaction-idstringrequired

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

Example: 12-3456789123456789
Headers
Content-Typestringrequired
Example: application/json
Authorizationstringrequired

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

curl -i -X GET \
  http://api.ratepay.com/transaction/status/v2/transactions/12-3456789123456789 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json'

Responses

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

Bodyapplication/json;charset=UTF-8
ratepay_transaction_idstring

The transaction id as specified in the URL

Example: "12-3456789123456789"
partner_transaction_idstring

The transaction ID generated by the partner. This ID can be displayed in the settlement files.

Example: "test-shop-transaction-id"
createdstring(date-time)

Timestamp of the Payment Request for this transaction (ISO 8601, YYYY-MM-DDThh:mm:ss.ffffff+hh:mm).

Example: "2020-03-10T18:06:52.438+01:00"
shop_buyer_idstring

The buyer id as transmitted by the shop to the Ratepay Payment API. Is null if the shop does not provide this information in the checkout process.

Example: "test-shop-buyer-id"
currencystring

The currency of the current transaction, e.g. EUR (ISO 4217 alphabetic currency code, 3 chars). All currency fields in the response hold values of this currency.

Example: "EUR"
shop_basketsArray of objects(BasketInformationDto)

One basket for each shop contained in the transaction. The definition of multiple shops is only relevant for marketplace integrations.

payment_informationobject(PaymentInformationDto)

Provides details about payment_method, payment_status, dunning_status

Response
application/json;charset=UTF-8
{
  "ratepay_transaction_id": "12-3456789123456789",
  "partner_transaction_id": "test-shop-transaction-id",
  "created": "2020-03-10T18:06:52.438+01:00",
  "shop_buyer_id": "test-shop-buyer-id",
  "currency": "EUR",
  "shop_baskets": [
    { … }
  ],
  "payment_information": {
    "maximum_processing_offset_in_hours": 0,
    "payment_method": { … },
    "payment_status": { … },
    "dunning_status": [ … ]
  }
}