Pay Later OpenAPI specification (version 1)

Download OpenAPI specification:Download

Pay Later allows shoppers to postpone the due date of an open invoice transaction between 14 and 150 days. Shoppers may use Pay Later to prevent getting dunned. It gives them the ability to plan their payments more individually. Charges apply when using this feature.

The Pay Later API enables sellers to integrate this functionality into their frontends. The Pay Later API offers endpoints to check the Pay Later status of a purchase order and to book a Pay Later option. By using the Pay Later API shops can offer their customers greater payment flexibility when paying by open invoice while keeping them inside their own frontends.

Booked Pay Later options can be withdraw within 14 days. Therefore the shopper can use one of the channels referenced in Ratepay Pay Later Terms of Use.

Pay Later Status

Get Pay Later status for one order

SecurityBearer Authentication
Request
path Parameters
transaction_id
required
string
Example: 12-34567890123456789
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

Returns Pay Later status for the given transaction_id.

404

Is returned if the transaction_id is unknown.

405

Is returned if this 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/paylater/v1/{transaction_id}/status
Request samples 
Response samples 
application/json;charset=UTF-8
{
  • "transaction_id": "12-34567890123456789",
  • "pay_later_status": "ALREADY_WITHDRAWN",
  • "booking": {
    }
}