Skip to main content

Balance

Balance webhooks notify you when any new data is available after a successful balance fetch.

These webhooks fire only after a completed balance fetch. Actions performed on the member through other endpoints will not trigger the webhook.

FieldData typeDescription
actionStringThe action that triggered the webhook, e.g., member_data_updated.
completed_atIntegerThe date and time at which the process that triggered the webhook was finished.
completed_onStringThe date on which the process that triggered the webhook was finished.
member_guidStringThe unique identifier for the member which has new or updated transaction data. Defined by MX.
typeStringThe type of webhook being delivered. Current possible values are AGGREGATION, BALANCE, HISTORY, and STATEMENT; however, additional values may be added at any time.
user_guidStringThe unique identifier for the user with which the data is associated. Defined by MX.

Example Payload


_10
{
_10
"action": "member_data_updated",
_10
"completed_at": 1531947410,
_10
"completed_on": "2018-07-18",
_10
"member_guid": "MBR-48d9a481-f2a2-7e13-2685-62869cf0d33a",
_10
"type": "BALANCE",
_10
"user_guid": "USR-eaf4ac68-d17d-5e9b-7b46-959a5b315a9e"
_10
}