Webhooks

Webhooks function as a callback mechanism, where OnTop sends HTTP POST requests to a predefined URL defined by the Client in response to particular events. This approach to communication allows for seamless integration and data sharing between us and Clients, eliminating the need for constant polling or manual data retrieval.

KYC verified and active

Contains information about the KYC event, including the verification status, worker ID, client ID, external ID, and worker email. This state implies that the worker has successfully verified its identity through the KYC and a wallet has been created.

{
  "event_type": "KYC",
  "data": {
    "status": "ACTIVE",
    "worker_id": 888,
    "client_id": 999,
    "external_id": "abc123",
    "worker_email": "[email protected]"
  }
}

Payment Status

Notifies about the final status of each payment enqueued using the Paylist interface. The event body includes the payment ID, the paylist ID, the amount transferred and worker data.

{
  "event_type": "PAYMENT",
  "data": {
    "payment_id": 20,
    "client_id": 999,
    "worker_id": 111,
    "paylist_id": 24,
    "idempotency_key": "bea3502a2a5a1f776bce4d7c2ce6f267",
    "email": "[email protected]",
    "transaction_status": "SUCCESS",
    "transaction_amount": 100.00,
    "transaction_date_time": 1698708987.544633693
  }
}

Client Wallet Top-up

Provides details about a Client's Wallet top-up event, including transaction ID, transaction type, amount, and a reference ID (idempotence key).

{
  "event_type": "CLIENT_WALLET_TOP_UP",
  "data": {
    "transaction_id": 7,
    "transaction_type": "TRANSFER",
    "amount": 1000,
    "reference_id": "aabvadasxxxxbxyyyzzz"
  }
}