TANITARDevelopers
WebhooksEvent catalogRewards

event.ticket.wallet-payment-settled

Version 1 of the event.ticket.wallet-payment-settled webhook event.

The event.ticket.wallet-payment-settled event.

Event typeevent.ticket.wallet-payment-settled
Schema version1
Routing keyevent.event.ticket.wallet-payment-settled.v1
Produced byReward Management
Schemaurn:defendr:contract:reward:ticket-wallet-payment-settled:1

data fields

FieldTypeRequiredDescription
orderIdstringyes
playerIdstringyes
amountintegeryes
currencyKeystringyes
state"succeeded", "rejected", "reversed"yes
revisionintegeryes

Some fields are required only in particular states. The JSON Schema below is authoritative.

Example delivery

Signed with the example secret whsec_placeholder_example_webhooks_signing_secret, so you can check your verifier against it. See Verifying signatures.

POST /your/webhook/endpoint HTTP/1.1
content-type: application/json
webhook-id: whd_00000000-0000-4000-8000-000000000013
webhook-timestamp: 1800000000
webhook-signature: v1,ebvpt4gMFWp5kO0GGxZiSA5bUZtX9mcfbHcDhn/NGCc=
tanitar-event-type: event.ticket.wallet-payment-settled
tanitar-schema-version: 1
tanitar-delivery-attempt: 1

{"messageId":"evt_00000000-0000-4000-8000-000000000013","kind":"event","type":"event.ticket.wallet-payment-settled","schemaVersion":1,"occurredAt":"2027-01-15T10:00:00.000Z","producer":"reward-management-service","accountId":"acc_11111111-1111-4111-8111-111111111111","correlationId":"corr_00000000-0000-4000-8000-000000000013","data":{"orderId":"ticket_order_aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa","playerId":"player_example","amount":1,"currencyKey":"red","state":"succeeded","revision":1}}

The same body, formatted:

{
  "messageId": "evt_00000000-0000-4000-8000-000000000013",
  "kind": "event",
  "type": "event.ticket.wallet-payment-settled",
  "schemaVersion": 1,
  "occurredAt": "2027-01-15T10:00:00.000Z",
  "producer": "reward-management-service",
  "accountId": "acc_11111111-1111-4111-8111-111111111111",
  "correlationId": "corr_00000000-0000-4000-8000-000000000013",
  "data": {
    "orderId": "ticket_order_aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "playerId": "player_example",
    "amount": 1,
    "currencyKey": "red",
    "state": "succeeded",
    "revision": 1
  }
}

JSON Schema

urn:defendr:contract:reward:ticket-wallet-payment-settled:1
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "urn:defendr:contract:reward:ticket-wallet-payment-settled:1",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "orderId",
    "playerId",
    "amount",
    "currencyKey",
    "state",
    "revision"
  ],
  "properties": {
    "orderId": {
      "type": "string",
      "minLength": 1
    },
    "playerId": {
      "type": "string",
      "minLength": 1
    },
    "amount": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991
    },
    "currencyKey": {
      "type": "string",
      "minLength": 1
    },
    "state": {
      "enum": [
        "succeeded",
        "rejected",
        "reversed"
      ]
    },
    "revision": {
      "type": "integer",
      "minimum": 1
    }
  }
}

On this page