Webhooks

This section provides a list of possible events that can be received as webhooks for Gaming Transactions.

To enable real-time updates between APARA and customers, we send a series of events throughout the order lifecycle.

Order statuses

Events	Event Type	Status	Description
Payment Initiated	Order	initiated	Post confirming the order details, wallet address, and payment method selection, the user will be redirecting to the payment checkout page
Payment Authorised	Order	fund_settled	User has submitted the payment details on the payment checkout page and the confirmation is received from the bank
Payment Unauthorised	Order	fund_failed	User has submitted the payment details on the payment checkout page and the payment is declined from the bank
Stablecoin deposit	Order	asset_deposited	Apara has deposited the stable coin to user's wallet.
Balance Top Up	Order	completed	The order is successfully completed and this should trigger the balance top-up on the end user's gaming platform.
Expired	Order	expired	The order is expired due to transaction not completed by user.
Manual Review	Order	manual_review	The order is hold for manual review by our compliance team.

Sample Events

{
  "eventId": "EV-241127050202174",
  "entityId": "OR-241127050200660",
  "entityType": "order",
  "status": "initiated",
  "user": {
    "userId": "UX-241112114510486",
    "firstName": "Aryan",
    "lastName": "Dev",
    "country": "BE",
    "createdAt": "2024-11-12T11:45:17.557Z"
  },
  "order": {
    "orderId": "OR-241127050200660",
    "type": "gaming",
    "depositCurrency": "EUR",
    "depositAmount": 0,
    "withdrawCurrency": "USDC",
    "withdrawAmount": 0,
    "walletAddress": "",
    "createdAt": "2024-11-27T05:02:00.548Z",
    "customerOrderId": "order-1234"
  },
  "partnerContext": {},
  "createdAt": "2024-11-27T05:02:02.006Z"
}

{
  "eventId": "EV-241127050552618",
  "entityId": "OR-241127050200660",
  "entityType": "order",
  "status": "fund_settled",
  "user": {
    "userId": "UX-241112114510486",
    "firstName": "Aryan",
    "lastName": "Dev",
    "country": "BE",
    "createdAt": "2024-11-12T11:45:17.557Z"
  },
  "order": {
    "orderId": "OR-241127050200660",
    "type": "gaming",
    "depositCurrency": "EUR",
    "depositAmount": 25,
    "withdrawCurrency": "USDC",
    "withdrawAmount": 24.843798,
    "walletAddress": "",
    "createdAt": "2024-11-27T05:02:00.548Z",
    "customerOrderId": "order-1234"
  },
  "partnerContext": {
    "testfield1": "1234",
    "testfield2": "5678"
  },
  "createdAt": "2024-11-27T05:05:52.011Z"
}

{
  "eventId": "EV-241127050552618",
  "entityId": "OR-241127050200660",
  "entityType": "order",
  "status": "fund_failed",
  "user": {
    "userId": "UX-241112114510486",
    "firstName": "Aryan",
    "lastName": "Dev",
    "country": "BE",
    "createdAt": "2024-11-12T11:45:17.557Z"
  },
  "order": {
    "orderId": "OR-241127050200660",
    "type": "gaming",
    "depositCurrency": "EUR",
    "depositAmount": 25,
    "withdrawCurrency": "USDC",
    "withdrawAmount": 24.843798,
    "walletAddress": "",
    "createdAt": "2024-11-27T05:02:00.548Z",
    "customerOrderId": "order-1234",
    "failureCode": "PAYMENT_NOT_COMPLETED",
    "failureMessage": "Payment was not completed. Please try again."
  },
  "partnerContext": {
    "testfield1": "1234",
    "testfield2": "5678"
  },
  "createdAt": "2024-11-27T05:05:52.011Z"
}

{
  "eventId": "EV-241127050745298",
  "entityId": "OR-241127050200660",
  "entityType": "order",
  "status": "asset_deposited",
  "user": {
    "userId": "UX-241112114510486",
    "firstName": "Aryan",
    "lastName": "Dev",
    "country": "BE",
    "createdAt": "2024-11-12T11:45:17.557Z"
  },
  "order": {
    "orderId": "OR-241127050200660",
    "type": "gaming",
    "depositCurrency": "EUR",
    "depositAmount": 25,
    "withdrawCurrency": "USDC",
    "withdrawAmount": 24.843798,
    "walletAddress": "",
    "createdAt": "2024-11-27T05:02:00.548Z",
    "customerOrderId": "order-1234"
  },
  "partnerContext": {
    "testfield1": "1234",
    "testfield2": "5678"
  },
  "createdAt": "2024-11-27T05:07:45.185Z"
}

{
  "eventId": "EV-241127050915602",
  "entityId": "OR-241127050200660",
  "entityType": "order",
  "status": "completed",
  "user": {
    "userId": "UX-241112114510486",
    "firstName": "Aryan",
    "lastName": "Dev",
    "country": "BE",
    "createdAt": "2024-11-12T11:45:17.557Z"
  },
  "order": {
    "orderId": "OR-241127050200660",
    "type": "gaming",
    "depositCurrency": "EUR",
    "depositAmount": 25,
    "withdrawCurrency": "USDC",
    "withdrawAmount": 24.843798,
    "walletAddress": "",
    "createdAt": "2024-11-27T05:02:00.548Z",
    "customerOrderId": "order-1234"
  },
  "partnerContext": {
    "testfield1": "1234",
    "testfield2": "5678"
  },
  "createdAt": "2024-11-27T05:09:15.027Z"
}

{
  "eventId": "EV-241127050915602",
  "entityId": "OR-241127050200660",
  "entityType": "order",
  "status": "expired",
  "user": {
    "userId": "UX-241112114510486",
    "firstName": "John",
    "lastName": "Doe",
    "country": "BE",
    "createdAt": "2024-11-12T11:45:17.557Z"
  },
  "order": {
    "orderId": "OR-241127050200660",
    "type": "gaming",
    "depositCurrency": "EUR",
    "depositAmount": 25,
    "withdrawCurrency": "USDC",
    "withdrawAmount": 24.843798,
    "walletAddress": "",
    "createdAt": "2024-11-27T05:02:00.548Z",
    "customerOrderId": "order-1234",
    "failureCode":"TRANSACTION_EXPIRED",    
    "failureMessage": ""
  },
  "partnerContext": {
    "testfield1": "1234",
    "testfield2": "5678"
  },
  "createdAt": "2024-11-27T05:09:15.027Z"
}

Was this page helpful?

Last updated today

Built with Documentation.AI