Balance Recurrence Notification
This chapter provides an in-depth overview of the BalanceRecurrence notification message, which is published when a recurrence on a balance occurs.
Notification Overview
Headers of the BalanceRecurrence Notification
The following table lists the headers in the BalanceRecurrence notification:
| Header | Description | Value |
|---|---|---|
X-Ocs-Io-transaction-id |
ID of the transaction. |
|
X-Ocs-Io-notification-code |
Code of the Notification. |
|
X-Ocs-Io-notification-payload |
Name (JAVA’s Simple Name) of the Notification’s Payload. |
|
Fields of the BalanceRecurrence Notification Payload
The following table lists and describes the fields in the BalanceRecurrence notification payload:
| Field | Description |
|---|---|
effectiveDate |
Effective Date/Time of the Notification. |
offerSubscription |
ID (Ref ID / External ID) of the Offer Subscription. |
offer |
Offer. |
customer |
Customer ID (Ref ID / External ID) in case Balance is subscribed to Customer level. |
account |
Account ID (Ref ID / External ID) in case Balance is subscribed to Account level. |
subscriber |
Subscriber ID (Ref ID / External ID) in case Balance is subscribed to Subscriber level. |
unitsOfMeasurement |
Units Of Measurement. |
currency |
Currency, populated only if Balance is of type Monetary. |
grantedBalance |
Balance granted. |
balanceDeducted |
Indicates whether Balance is deducted to 0. |
actualBalance |
Actual Balance. |
validFrom |
Date/Time from when Balance Value is valid. |
validTo |
Date/Time till when Balance is valid. |
periodStart |
Start Date/Time of the Recurrence Period. |
periodEnd |
End Date/Time of the Recurrence Period. |
cycle |
SeqNo of the Cycle. |
| Detailed API documentation and endpoint specifics are available here. |