Event types

Events

Events are how OrkestaPay notifies changes in orders and payments. Currently, OrkestaPay handles one event per resource:

Example of order.update

{
  "data": {
    "merchant_order_id": "2162561c-33b2-4f6e-87d8-2ce8f1d6bdce",
    "order_id": "ord_98976db462554156a02edd7f29272c29",
    "status": "COMPLETED",
    "update_at": "1707435730619"
  },
  "event_type": "order.update"
}

Example of payment.update

{
  "data": {
    "amount": 170,
    "authorized_at": "1707435730571",
    "captured": true,
    "captured_amount": 170,
    "captured_at": "1707435730595",
    "captured_currency_code": "MXN",
    "created_at": "1707435729682",
    "currency_code": "MXN",
    "payment_id": "pay_36119cc55eaf4f019f6de6d283c2c207",
    "payment_method": {
      "card": {
        "bin": "411111",
        "brand": "VISA",
        "card_type": "CREDIT",
        "last_four": "1111"
      },
      "id": "pym_351436ff4e874fb7a8afe270eba62886",
      "type": "CARD"
    },
    "processor_response": {
      "authorization": "pi_3OfUlkGYqhDa3Ul603O3qeC1",
      "code": "APPROVED",
      "decline_code": "",
      "message": "Transaction approved",
      "processor_transaction_id": ""
    },
    "status": "COMPLETED"
  },
  "event_type": "payment.update"
}