v1

latestOpenAPI 3.0.3Apache License Version 2.02026-07-2631211285.4 KB
Notification Services Sales

Payment Sale

Receiving notifications of a sale finalized.

post/v1/payment/orders/{order_id}/notifications

Path parameters

order_idstring required

Order ID returned by create payment service

Request body

statusstring required

Sale status. States supported Confirmed or Cancelled.

Example request

{
  "status": "Cancelled",
  "transaction": {
    "reference_id": "REF0000001",
    "business_id": "BIZ0000001",
    "provider_reference": {
      "batch_id": "000012",
      "ticket_number": "000045",
      "tid": "10069930690009D31001",
      "nsu": "792048"
    }
  },
  "amount": {
    "currency_code": "BRL",
    "value": 1500.56
  }
}

Response

Notification response