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

curl
JavaScript
Java
Python

Response samples

application/json;charset=UTF-8

{"general_order_information": {"transaction_id": "12-3456789123456789",
"shop_order_id": "test-shop-order-id",
"order_creation_date": "2020-03-10T18:06:52.438+01:00",
"shop_buyer_id": "test-shop-buyer-id",
"currency": "EUR"
},
"basket": {"initial_order_amount_gross": 170,
"current_order_amount_gross": 145,
"last_updated": "2020-03-12T18:06:52.438+01:00",
"current_items": [{"shop_id": "external-shop-id",
"shop_items": {"open_items": [{"unit_price_gross": 48,
"tax_rate": 19,
"discount": 0,
"quantity": 3,
"description": "basket-item",
"additional_description": "cooles basket-item",
"identification_number": "identifiy-me",
"unique_identification_number": "12345"
}
],
"shipped_items": [{"unit_price_gross": 48,
"tax_rate": 19,
"discount": 0,
"quantity": 3,
"description": "basket-item",
"additional_description": "cooles basket-item",
"identification_number": "identifiy-me",
"unique_identification_number": "12345"
}
],
"returned_items": [{"unit_price_gross": 48,
"tax_rate": 19,
"discount": 0,
"quantity": 3,
"description": "basket-item",
"additional_description": "cooles basket-item",
"identification_number": "identifiy-me",
"unique_identification_number": "12345"
}
],
"cancelled_items": [{"unit_price_gross": 48,
"tax_rate": 19,
"discount": 0,
"quantity": 3,
"description": "basket-item",
"additional_description": "cooles basket-item",
"identification_number": "identifiy-me",
"unique_identification_number": "12345"
}
]
}
}
],
"current_special_items": {"open_items": [{"type": "SHIPPING",
"price_gross": 1,
"tax_rate": 19,
"description": "basket-item",
"additional_description": "cooles basket-item"
}
],
"shippedItems": [{"type": "SHIPPING",
"price_gross": 1,
"tax_rate": 19,
"description": "basket-item",
"additional_description": "cooles basket-item"
}
],
"returnedItems": [{"type": "SHIPPING",
"price_gross": 1,
"tax_rate": 19,
"description": "basket-item",
"additional_description": "cooles basket-item"
}
],
"cancelledItems": [{"type": "SHIPPING",
"price_gross": 1,
"tax_rate": 19,
"description": "basket-item",
"additional_description": "cooles basket-item"
}
]
}
},
"payment_information": {"maximum_processing_offset_in_hours": 0,
"payment_method": {"current_payment_method_details": {"prepayment": {"reference": "test-ref",
"reservation_end_date": "2020-03-24",
"amount": 170,
"creation_date": "2020-03-10"
},
"invoices": [{"reference": "test-ref",
"amount": 170,
"original_due_date": "2020-03-24",
"current_due_date": "2020-03-24",
"creation_date": "2020-03-10",
"clearing_reference_number": "test-clear-ref",
"invoice_number": "test-shop-invoice-id"
}
],
"payment_method": "INVOICE",
"settlement_type": "DIRECT_DEBIT",
"instalment_plans": [{"reference": "KK7709094U2",
"creation_date": "2020-04-08",
"amount_total": 200.47,
"amount_credit": 186.07,
"amount_fees": 14.4,
"interest_rate": 5.99,
"effective_interest_rate": 3.33,
"number_of_instalments": 6,
"instalments": [{"amount_total": null,
"due_date": null,
"amount_interest": null,
"amount_repayment": null,
"amount_fee": null,
"amount_unscheduled": null,
"residual_debt": null,
"instalment_number": null
}
]
}
]
}
},
"payment_status": {"order_payment_status": "UNDERPAID",
"open_claim": {"amount": 100,
"current_claim": {"amount": 150,
"shop_claims": {"claims": [{"type": null,
"date": null,
"amount": null
}
],
"amount": 145
},
"ratepay_buyer_fees": {"buyer_fees": [{"type": null,
"date": null,
"amount": null
}
],
"amount": {"gross": 5
}
}
},
"settlement": {"settlements": [{"type": "string",
"date": "2019-08-24",
"amount": 0
}
],
"amount": 50
}
}
},
"dunning_status": {"current_order_dunning_level": "PAYMENT_REMINDER",
"order_dunning_date": "2020-03-24",
"current_dunning_fee": 0,
"dunning_block": {"blocked_from": "2020-03-25",
"blocked_until": "2020-04-01",
"blocking_reason": "Zahlungsaufschub aus Kulanz"
}
}
}
}