Structure of the Event Notification
An event notification body is sent in JSON format and shares similarities to what you would get in response to a typical API request. You can determine the type of notification by the eventType field.
This field is a sub-field in the notificationRequestItem field in the notificationItems array, Example event types are refund or transaction.
All information about a resource notification is included in the data field.
Refund Event
Dispute Event
Transaction Event
Wallet Transaction Event
Recurrent Transaction Event
Recurring Debit Transaction Event
The refund event notification body is structured thus:
1
{
2
"notificationItems": [
3
{
4
"notificationRequestItem": {
5
"eventType": "refund",
6
"eventDate": "2020-05-01 12:55:57",
7
"eventId": "0be677f841254a3eb92fab0d0b6ba232",
8
"data": {
9
"amount": "10",
10
"createdAt": "2019-10-24 07:47:49",
11
"transactionRef": "IHrE1571828556059",
12
"description": "I need my money",
13
"type": "FULL_REFUND",
14
"mode": "TEST",
15
"updatedAt": "2019-10-24 07:47:49",
16
"refundRef": "0ee983dd9222280bed389572",
17
"merchantId": "00000013",
18
"currency": "NGN",
19
"customer": {
20
"customerPhone": "09034343434",
21
"customerEmail": "[email protected]",
22
"customerName": "Obia Ugochukwu"
23
}
24
}
25
}
26
}
27
]
28
}
Copied!
The dispute event notification body is structured thus:
1
{
2
"notificationItems": [
3
{
4
"notificationRequestItem": {
5
"eventType": "dispute",
6
"eventDate": "2020-05-01 12:56:07",
7
"eventId": "da28df9ea5dd4807b59e5761afd7231b",
8
"data": {
9
"evidence": [
10
{
11
"images": [
12
{
13
"image": ""
14
}
15
],
16
"createdAt": {
17
"dayOfWeek": "TUESDAY",
18
"month": "NOVEMBER",
19
"hour": 11,
20
"dayOfYear": 316,
21
"dayOfMonth": 12,
22
"year": 2019,
23
"monthValue": 11,
24
"nano": 0,
25
"chronology": {
26
"calendarType": "iso8601",
27
"id": "ISO"
28
},
29
"minute": 24,
30
"second": 35
31
},
32
"id": 28,
33
"message": "Ready to deploy",
34
"msgSender": "merchant"
35
},
36
{
37
"images": [
38
{
39
"image": ""
40
}
41
],
42
"createdAt": {
43
"dayOfWeek": "TUESDAY",
44
"month": "NOVEMBER",
45
"hour": 10,
46
"dayOfYear": 316,
47
"dayOfMonth": 12,
48
"year": 2019,
49
"monthValue": 11,
50
"nano": 0,
51
"chronology": {
52
"calendarType": "iso8601",
53
"id": "ISO"
54
},
55
"minute": 51,
56
"second": 59
57
},
58
"id": 20,
59
"message": "what up"
60
}
61
],
62
"disputeRef": "e159936a690b462d881a4ce6090c66df",
63
"dateOfResolution": "2019-11-07 18:57:51",
64
"merchantId": "00000005",
65
"resolution": "accept",
66
"dateOfDispute": "2019-11-15 08:52:31",
67
"transDetails": {
68
"amount": "10.00",
69
"fee": "0",
70
"transactionDate": "2019-11-07 03:14:12"
71
},
72
"customerEmail": "[email protected]",
73
"id": 2,
74
"category": "DISPUTE",
75
"status": "ACCEPTED",
76
"dueWhen": "2019-11-27 18:57:51",
77
"transactionRef": "PUBK_RW5yjSthWIWvRyST6HzcG0c3ckTehfqH1573135946855"
78
}
79
}
80
}
81
]
82
}
Copied!
The transaction event notification body is structured thus:
1
{
2
"notificationItems": [
3
{
4
"notificationRequestItem": {
5
"eventType": "transaction",
6
"eventDate": "2020-05-01 12:56:22",
7
"eventId": "d95b17db00984ef6847913eb5f35c97d",
8
"data": {
9
"amount": "2.00",
10
"mobile": "08039229321",
11
"status": "APPROVED",
12
"reference": "54637776z",
13
"gatewayMessage": "Approved by financial institution",
14
"publicKey": "tNUFstIHrE",
15
"businessName": "Centric Gateway",
16
"accountNumber": "0011929382",
17
"bankCode": "000016",
18
"description": "transaction event occurred",
19
"fee": "2.00",
20
"clientAppCode": "app1",
21
"datetime": "2019:11:22 01:45:24",
22
"callbackUrl": "https://checkout.seerbit.com/?m=EQREZEhyRn",
23
"redirectUrl": "https://checkout.seerbit.com/?m=EQREZEhyRn",
24
"channel": "transfer",
25
"productId": "Foods",
26
"channelType": "Mastercard",
27
"maskedPan": "4508-75xx-xxxx-1019",
28
"sourceIP": "1.0.0.10",
29
"deviceType": "Apple Laptop",
30
"type": "3DSECURE",
31
"fullname": "John Doe",
32
"email": "[email protected]",
33
"gatewayReference": "",
34
"grossAmount": "3.00",
35
"country": "NG",
36
"currency": "NGN",
37
"creditAccountName": "Centric Gateway",
38
"creditAccountNumber": "1212321211",
39
"narration": "My narration here",
40
"sessionId": "00002999299388837772828883778",
41
"bankName": "firstbank",
42
"externalReference": "2i2idde2",
43
"createdAt": "2019:11:22 01:45:24",
44
"updatedAt": "2019:11:22 01:45:24",
45
"generatedAt": "2019:11:22 01:45:24",
46
"lastFourDigits": "007",
47
"cardBin": "222300",
48
"paymentType": "CARD"
49
}
50
}
51
}
52
]
53
}
Copied!
The wallet transaction event notification body is structured thus:
1
{
2
"notificationItems": [
3
{
4
"notificationRequestItem": {
5
"eventType": "transaction.wallet",
6
"eventDate": "2020-05-01 12:52:28",
7
"eventId": "c472deceabf44924901b104523af14df",
8
"data": {
9
"amount": "100.00",
10
"mobile": "08033456500",
11
"reference": "shh3332hwhwhh22hjjjwj",
12
"gatewayMessage": "APPROVED",
13
"publicKey": "hhw33y2x",
14
"bankCode": "000016",
15
"description": "wallet transaction",
16
"fee": "2.00",
17
"type": "Transfer",
18
"fullname": "John Doe",
19
"email": "[email protected]",
20
"country": "NG",
21
"currency": "NGN",
22
"origin": "string",
23
"internalRef": "string",
24
"creditAccountName": "Test Account",
25
"creditAccountNumber": "23221122321",
26
"originatorAccountnumber": "1929383828392",
27
"originatorName": "CGW",
28
"narration": "my narration here",
29
"sessionId": "00002999299388837772828883778",
30
"externalReference": "2203000002992910219",
31
"createdAt": "2019-12-12 16:20:59",
32
"updatedAt": "2019-12-12 16:20:59"
33
}
34
}
35
}
36
]
37
}
Copied!
The recurrent transaction event notification body is structured thus:
1
{
2
"notificationItems": [
3
{
4
"notificationRequestItem": {
5
"eventType": "transaction.recurrent",
6
"eventDate": "2020-05-01 12:50:33",
7
"eventId": "30a33df05b0c465c8c38f4113621685a",
8
"data": {
9
"amount": "150",
10
"mobile": "08033456500",
11
"reference": "TESTPilotR251218123PPOIU149",
12
"publicKey": "SBTESTPUBK_dhrpzbRpR34l6VmqkCFOKA94L5E1jSTu",
13
"description": "Pilot Test Subscription",
14
"productId": "Terrain",
15
"maskedPan": "5123-45xx-xxxx-0008",
16
"email": "[email protected]",
17
"gatewayReference": "F325090871582705056234",
18
"country": "NG",
19
"narration": "Reccurrent",
20
"createdAt": "2020-02-26T09:17:30",
21
"updatedAt": "2020-02-26T09:18:26.496",
22
"lastFourDigits": "0008",
23
"cardBin": "512345"
24
}
25
}
26
}
27
]
28
}
Copied!
The recurring debit transaction event notification body is structured thus:
1
{
2
"notificationItems": [
3
{
4
"notificationRequestItem": {
5
"eventType": "transaction.recurring.debit",
6
"eventDate": "2020-05-01 12:55:32",
7
"eventId": "799f8cad23bc4bc389280f996d81ea55",
8
"data": {
9
"amount": "2000",
10
"reference": "PILOT76558370651618723659",
11
"gatewayMessage": "Successful",
12
"publicKey": "SBTESTPUBK_dhrpzbRpR34l6VmqkCFOKA94L5E1jSTu",
13
"description": "Authorised charge",
14
"channelType": "Recurring Debit",
15
"maskedPan": "5123--4xx-xxxx-xx-0",
16
"type": "TOKEN",
17
"fullname": "Frank Gboyega",
18
"email": "[email protected]",
19
"gatewayReference": "F786046901582644089560",
20
"country": "NG",
21
"currency": "NGN",
22
"narration": "Authorised charge",
23
"createdAt": "2020-02-25T16:21:23",
24
"updatedAt": "2020-02-25T16:21:31.319",
25
"paymentType": "card"
26
}
27
}
28
}
29
]
30
}
Copied!
Last modified 1yr ago
Copy link