ENentur
Partner Receipts

Send receipt

Send a receipt. Content will be defined by order ID and version of order. Receipts can only be made for orderVersions where there been a payment or a credit.

post/v1/receipts/send

Request

  • Base URL
    https://api.entur.io/sales
  • Auth
    HTTP bearer

Query parameters

organisationIdinteger
receiptType'SALE' | 'REFUND' | 'CANCEL' | 'CHANGE'

Overwrite receipt type if present

Request body

orderIdstring required

Order id to generate receipt

orderVersioninteger required

Which version of the order that should be used to generate a receipt

receiptLanguagestring

Desired language of the receipt. Currently only supporting 'nob' and 'eng'

serialNumberstring

The desired serial number for the receipt

copyReceiptboolean

Set to true when the receipt is a copy.

Example request

{
  "orderId": "2H1K65IM",
  "orderVersion": 1,
  "distribution": {
    "email": "customer@example.com",
    "telephone": {
      "countryCode": "47",
      "number": "61051910"
    }
  },
  "receiptLanguage": "nob",
  "serialNumber": "RCP-2024-000123",
  "copyReceipt": false
}

Response

Ok

referencestring required

Reference to receipt

Example response

{
  "reference": "a49f7259-7285-42ce-b7b0-e48a77fbfb39"
}

Changes

No recorded changes to this operation across all 1 revision of this API.