KOkoin
Notification Services Sales

Payment Sale

Changed on

Receiving notifications of a sale finalized.

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

Request

  • Base URL
    https://api-sandbox.koin.com.br
  • URL
    https://api-sandbox.koin.com.br/v1/payment/orders/{order_id}/notifications
  • Auth
    none declared

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"
  },
  "amount": {
    "currency_code": "BRL",
    "value": 1500.56
  }
}

Response

Notification response

Changes

  • 1e3734785750Revision changes
    • warning

      changed the pattern of the request property / from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2}

    • warning

      removed the request property /