Returns a pan-operator level, summarised and aggregated information about a customer gambling and other spend.
Potential Use Cases:
- Detect gambling across multiple operators
- Identify potential gambling problem
The Insights webhook is HTTPS post request and a typical example of the request body is as follows:
{
"type": "INSIGHTS",
"data": {
"metadata": {
"merchantId": "684af205b26c48042487c93c",
"customerId": "eixyc0oxx9o0",
"reference": "eixyc0oxx9o0",
"citizenTransactionId": "54f97545-a987-cfa9-b2a8-f66b97",
"merchantTradingName": "Test Merchant"
},
"insightGroup": {
"id": "68d6593704a1aa70943d2bb1",
"name": "Payment Basics Global",
"insights": [
"PAYMENT_BASICS_GLOBAL"
],
"period": [
"MONTHLY"
],
"fromDate": "2025-06-28T09:32:33.440188Z",
"toDate": "2025-07-26T09:32:33.440206Z"
},
"insights": {
"PAYMENT_BASICS_GLOBAL": {
"insight": "PAYMENT_BASICS_GLOBAL",
"fromDate": "2025-06-28T09:32:33.440188Z",
"toDate": "2025-07-26T09:32:33.440206Z",
"accounts": [
{
"accountId": "0e9ffaca-2f19-4858-aa67-32a4ccda5acd",
"accountType": "CURRENT",
"currency": "GBP",
"closingBalance": 350,
"lastUpdatedAt": "2025-07-26T09:32:33.852652Z",
"consents": [
{
"consentId": "31d99e03-2ae2-40db-a39b-50b2fb650581",
"status": "ACTIVE",
"createdAt": "2025-07-26T09:32:33.126Z",
"expiresAt": "2025-10-25T10:32:33.125Z"
}
],
"paymentBasics": {
"categorisations": {
"OTHER": {
"PAYOUT": {
"paymentCount": 15,
"amount": 200
},
"PAYIN": {
"paymentCount": 5,
"amount": 300
}
},
"GAMBLING-OTHERS": {
"PAYOUT": {
"paymentCount": 3,
"amount": 100
},
"PAYIN": {
"paymentCount": 1,
"amount": 30
}
},
"GAMBLING-MERCHANT": {
"PAYOUT": {
"paymentCount": 3,
"amount": 50
},
"PAYIN": {
"paymentCount": 1,
"amount": 10
}
}
},
"period": {
"MONTHLY": [
{
"fromDate": "2025-06-28T09:32:33.440188Z",
"toDate": "2025-06-30T23:59:59Z",
"description": "2025-06",
"data": {
"OTHER": {
"PAYOUT": {
"paymentCount": 10,
"amount": 170
},
"PAYIN": {
"paymentCount": 3,
"amount": 200
}
},
"GAMBLING-OTHERS": {
"PAYOUT": {
"paymentCount": 1,
"amount": 20
},
"PAYIN": {
"paymentCount": 0,
"amount": 0
}
},
"GAMBLING-MERCHANT": {
"PAYOUT": {
"paymentCount": 1,
"amount": 20
},
"PAYIN": {
"paymentCount": 0,
"amount": 0
}
}
}
},
{
"fromDate": "2025-07-01T00:00:00Z",
"toDate": "2025-07-31T23:59:59Z",
"description": "2025-07",
"data": {
"OTHER": {
"PAYOUT": {
"paymentCount": 5,
"amount": 30
},
"PAYIN": {
"paymentCount": 2,
"amount": 100
}
},
"GAMBLING-OTHERS": {
"PAYOUT": {
"paymentCount": 2,
"amount": 80
},
"PAYIN": {
"paymentCount": 1,
"amount": 30
}
},
"GAMBLING-MERCHANT": {
"PAYOUT": {
"paymentCount":2,
"amount": 30
},
"PAYIN": {
"paymentCount": 1,
"amount": 10
}
}
}
}
}
]
}
}
}
]
}
}
}
}
| Field | Type | Description |
|---|
| insight | string | Always PAYMENT_BASICS_GLOBAL |
| fromDate | string | ISO 8601 period start date. |
| toDate | string | ISO 8601 period end date. |
| accounts | array[Account] | List of account objects. Payment basic insights are calculated per account basis. |
| Field | Type | Description |
|---|
| accountId | string | Unique current account identifier. |
| accountType | string | Type of account, e.g. "CURRENT". |
| currency | string | 3-letter ISO code, e.g. "GBP". |
| closingBalance | number | Closing account balance. |
| lastUpdatedAt | string | ISO timestamp for last update. |
| consents | array[Consent] | Array of consent objects. |
| paymentBasics | Payment Basics Global | Payment basics breakdown (see below). |
| Field | Type | Description |
|---|
| consentId | string | Consent identifier. |
| status | string | Consent status (e.g., "ACTIVE"). |
| createdAt | string | ISO creation timestamp. |
| expiresAt | string | ISO expiry timestamp. |
| Field | Type | Description |
|---|
| categorisations | Payment Basics Categories | Summary of payment Basics over each category. |
| period | Payment Basics Global Period | Payment Basics consolidated over a period |
| Field | Type | Description |
|---|
| <Period> | array[Payment Basics Period Data] | Payment basics broken down by period. Period can be MONTHLY, WEEKLY, DAILY |
| Field | Type | Description |
|---|
| fromDate | string | Month period start date. |
| toDate | string | Month period end date. |
| description | string | Month descriptor (e.g., "2025-07"). |
| data | Payment Basic Categories | Payment Basic Categories |
| Field | Type | Description |
|---|
| OTHER | Payment Basics Payments | Payment basic for the category OTHER |
| GAMBLING-OTHERS | Payment Basics Payments | Payment basic for the category GAMBLING-OTHERS |
| GAMBLING-MERCHANT | Payment Basics Payments | Payment basic for the category GAMBLING-MERCHANT |
| Field | Type | Description |
|---|
| PAYIN | Payment Data | Consolidated credits |
| PAYOUT | Payment Data | Consolidated debits |
| Field | Type | Description |
|---|
| paymentCount | number | Number of payments consolidated |
| amount | number | Consolidated payment amount |
Notes:
- Category names (e.g., "GAMBLING-OTHERS") are dynamically defined and may expand.
- All monetary values use the specified currency code.
- All times/dates should comply with ISO 8601 UTC format.
- For any added categories in the future, structure remains consistent.
