Skip to content
Developer
/
/Invoice

Invoice webhooks OpenAPI specification (version)

This is the documentation for the Ratepay invoice webhooks. The webhooks are still in development and subject to change. This documentation will evolve as the development of the webhooks progresses.

Download OpenAPI description
invoice_webhooks.json
invoice_webhooks.yaml
Overview
URL

https://www.ratepay.com/

Ratepay

info@ratepay.com

Languages
Servers

https://docs.ratepay.com/

Webhook for invoice communications

Request

Payload for invoice webhooks

Headers
x-signaturestringrequired

the hashed (SHA-512) payload

Example: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec
Authorizationstringrequired

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

Bodyapplication/jsonrequired
idnumber

Unique identifier of the webhook event.

Example: 92
shop_transaction_idstring[ 1 .. 50 ] characters

The order ID generated by the shop. This ID must be known to the buyer and is used for buyer communication, e.g. emails and buyer support.

Example: "shop-transaction-id-1234"
ratepay_payment_referencestring[ 10 .. 127 ] characters

Reference to be indicated in the bank transfer (generated by Ratepay).

Example: "GD1234567890"
ratepay_transaction_idstring

Ratepay transaction ID.

Example: "32-201411251340634"
invoice_idstring

The billing ID of the order.

Example: "DG0627731Z7-001"
eml_urlstring

The URL to fetch the email document.

Example: "https://api.ratepay.com/api/order/123/correspondences/invoices/456/eml"
pdf_urlstring

The URL to fetch the PDF document.

Example: "https://api.ratepay.com/api/order/123/correspondences/invoices/456/pdf"
curl -i -X POST \
  'https://docs.ratepay.com/webhook-invoice(to%20be%20defined)' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'x-signature: 1be8ca419d1969085fba97228a5eeb55683cc5442cb475ffd9d8a40419ead40d3d82bea3209b6f4fdcce51c9ce6eb43a025faaf05b09bb90e4cb3c143143adec' \
  -d '{
    "id": 92,
    "shop_transaction_id": "shop-transaction-id-1234",
    "ratepay_payment_reference": "GD1234567890",
    "ratepay_transaction_id": "32-201411251340634",
    "invoice_id": "DG0627731Z7-001",
    "eml_url": "https://api.ratepay.com/api/order/123/correspondences/invoices/456/eml",
    "pdf_url": "https://api.ratepay.com/api/order/123/correspondences/invoices/456/pdf"
  }'

Responses

Success