Webhooks Events

Webhooks Settings

After webhook token generation you will be able to configure trigger events depending on their type.

General Webhook Settings

Withdrawals

• Withdrawal is completed - withdrawal transaction was successful and its status was changed to COMPLETE. ("event_type": "withdrawal::completed")

• Withdrawal is declined - withdrawal transaction was declined for any reason and its status was changed to CANCELLED or DECLINED. ("event_type": "withdrawal::declined")

Other

• Rollback to account - overpayment amount was transferred to the account. ("event_type": "rollback::to_merchant")
• Rollback to client - overpayment amount was transferred to the client. ("event_type": "rollback::to_client")

Events

Withdrawal Complete/Declined

Event will be triggered when Withdrawal status changes to COMPLETE or CANCELLED.

Request Body

{
  "transaction": {
    "id": "4176141e-bd97-4f13-a71a-6547a230cf4a",
    "order_id": "283585b1-16c6-496d-b493-ab17a574ffd6",
    "external_order_id": "INV-123",
    "stock_orders": [],
    "currency": "USDT",
    "value": "11",
    "is_internal": false,
    "status": "CANCELLED",
    "hash": "null",
    "created_at": "2022-03-22 10:09:34",
    "completed_at": null
  },
  "event_type": "withdrawal::declined"
}

Rollback to client/account

Event will be triggered when overpaid invoice amount is transferred to merchant or client.

Request Body

{
  "transaction": {
    "id": "313b3e1b-3d3f-4359-9e30-a726aeed7a60",
    "order_id": "b7db772d-1c96-484b-ba9b-cc5ade03a754",
    "external_order_id": null,
    "stock_orders": [],
    "currency": "USDT",
    "value": "2",
    "is_internal": false,
    "type": "ROLLBACK_TO_MERCHANT",
    "status": "COMPLETE",
    "hash": null,
    "created_at": "2023-09-21 09:48:13",
    "completed_at": null
  },
  "event_type": "rollback::to_merchant/rollback::to_client"
}

Payment page webhook settings

Invoices

• Invoice is completed - full amount on specified invoice was received and order status was changed to COMPLETE. ("event_type": "order::completed")
• Invoice is declined - invoice wasn’t completed in time and its status was changed to DECLINED. ("event_type": "order::declined")
• Invoice is partially paid - invoice was partially paid and the order changed its status to PARTIALLY_FULFILLED. ("event_type": "order::partially_fulfilled")
• Final amount was received - invoice was completed and all exchange operations minus fees have been finished. ("event_type": "order::final_amount_was_received")

Transactions

• Transaction is completed - deposit transaction was received and its status was changed to COMPLETE. ("event_type": "transaction::completed")
• Transaction is declined - deposit transactions was cancelled for any reason and its status was changed to DECLINED. ("event_type": "transaction::declined")
• Transaction exchange is completed - amount received via transaction was successfully exchanged. ("event_type": "transaction::was_final_exchange")

Events

Invoice Status Changed

Event will be triggered when Invoice Status changed.

Request Body

{
  "order": {
    "id": "08d585b1-86c6-496d-b493-ab17a574fdd6",
    "currency": "UAH",
    "value": "200",
    "expected_amount": "200",
    "status": "DECLINED",
    "external_order_id": "423se231-f351-234g-g324-g35gd3452f45",
    "created_at": "2022-03-22 14:01:34",
    "completed_at": null,
    "acquiring_url": "https://merchant.pay.whitepay.com/fiat-order/08d585b1-86c6-496d-b493-ab17a574fdd6",
    "is_internal": false
  },
  "event_type": "order::declined"
}

Transaction Status Changed

Event will be triggered when Transaction Status changed.

Request Body

{
  "transaction": {
    "id": "4176141e-bd97-4f13-a71a-6547a230cf4a",
    "order_id": "283585b1-16c6-496d-b493-ab17a574ffd6",
    "external_order_id": "INV-123",
    "stock_orders": [
      {
        "amount": "200",
        "status": "CLOSED",
        "pair": "USDT_UAH",
        "date": "2022-03-22",
        "time": "14:03:37",
        "exchange_rate": "31.84713375796178343949",
        "created_at": "2022-03-22 14:03:37"
      }
    ],
    "currency": "UAH",
    "value": "200",
    "status": "COMPLETE",
    "hash": "cpi_V9EvsfSdGQ2xKNCx",
    "created_at": "2022-03-22 14:03:34",
    "completed_at": "2022-03-22 14:03:34"
  },
  "event_type": "transaction::completed"
}

Transaction final amount was received

Event will be triggered when final exchange of transaction amount was completed.

Request Body

{
  "transaction": {
    "id": "297771f9-9695-48f4-b31f-c9c47639a7c6",
    "order_id": "b15eed1b-fc86-48a6-abf1-a14d9813903f",
    "external_order_id": null,
    "stock_orders": [],
    "currency": "USDT",
    "value": "25.19",
    "is_internal": true,
    "type": "DEPOSIT",
    "status": "COMPLETE",
    "hash": "WB_PAY_6df4b1e3-5191-4e3d-bd8f-5c951152b327",
    "created_at": "2024-03-22 12:21:54",
    "completed_at": "2024-03-22 12:21:54",
    "received_total": "24.94",
    "received_currency": {
      "id": "05203599-0613-4dd7-861e-e4e1281a13a5",
      "ticker": "USDT",
      "is_fiat": false,
      "title": "Tether US",
      "precision": 2
    }
  },
  "event_type": "transaction::was_final_exchange"
}