Settlement Events

Settlements Created

The bulk funding report generation has started; the event provides the metadata about the report.

{
    "id": "event_5c489c65-fd17-48f8-bfbf-146b46f01ee5",
    "type": "reports.instantFundingSettlement.created",
    "object": "INSTANT_FUNDING_SETTLEMENT_REPORT",
    "timestamp": "2021-05-25T19:27:00.231Z",
    "payload": {
        "settlementID": "1b06c469-9706-4ea0-90a6-9ad8f441d6ca_20210525",
        "settlementProfileID": "settlement-profile-bank-account-1",
        "settlementDate": "2021-05-25",
        "status": "PENDING",
        "statusComment": "Created from aggregator service",
        "totalAmount": 100,
        "depositsAmount": 100,
        "created": "2021-05-25T00:00:00.293Z",
        "updated": "2021-05-25T00:00:00.293Z",
        "updatedBy": "Instant Funding Aggregator Job"
    },
    "ibID": "1b06c469-9706-4ea0-90a6-9ad8f441d6ca"
}

Settlements Updates

The bulk funding report generation has been updated; the event provides the metadata about the report.

{
    "id": "event_5c489c65-fd17-48f8-bfbf-146b46f01ee5",
    "type": "reports.instantFundingSettlement.updated",
    "object": "INSTANT_FUNDING_SETTLEMENT_REPORT",
    "timestamp": "2021-05-25T19:27:00.231Z",
    "payload": {
        "settlementID": "1b06c469-9706-4ea0-90a6-9ad8f441d6ca_20210525",
        "settlementProfileID": "settlement-profile-bank-account-1",
        "settlementDate": "2021-05-25",
        "status": "APPROVED",
        "statusComment": "Created from aggregator service",
        "totalAmount": 100,
        "depositsAmount": 100,
        "created": "2021-05-25T00:00:00.293Z",
        "updated": "2021-05-26T00:15:00.223Z",
        "updatedBy": "Instant Funding Aggregator Job"
    },
    "ibID": "1b06c469-9706-4ea0-90a6-9ad8f441d6ca"
}

Settlements Completed

The bulk funding report has been marked as successful; the event provides the metadata about the report.

{
    "id": "event_5c489c65-fd17-48f8-bfbf-146b46f01ee5",
    "type": "reports.instantFundingSettlement.completed",
    "object": "INSTANT_FUNDING_SETTLEMENT_REPORT",
    "timestamp": "2021-05-25T19:27:00.231Z",
    "payload": {
        "settlementID": "1b06c469-9706-4ea0-90a6-9ad8f441d6ca_20210525",
        "settlementProfileID": "settlement-profile-bank-account-1",
        "settlementDate": "2021-05-25",
        "status": "SUCCESSFUL",
        "statusComment": "Created from aggregator service",
        "totalAmount": 100,
        "depositsAmount": 100,
        "created": "2021-05-25T00:00:00.293Z",
        "updated": "2021-05-26T00:15:00.223Z",
        "updatedBy": "Instant Funding Aggregator Job"
    },
    "ibID": "1b06c469-9706-4ea0-90a6-9ad8f441d6ca"
}

Reconciliation Created

The cashless brokerage report has been created; the event provides metadata about the report.

{
    "id": "event_86511a83-3189-409e-8a08-b27b8eb06f75",
    "type": "reconciliations.created",
    "timestamp": "2022-09-26T04:20:03.528998301Z",
    "payload": {
        "id": "3396978d-ebb2-4466-95c5-43ade57b9c8f_20220928",
        "date": "2022-09-28",
        "status": "Pending",
        "statusComment": "Created from aggregator service",
        "totalAmount": 0,
        "created": "2022-09-26T04:20:03.514Z",
        "updated": "2022-09-26T04:20:03.514Z",
        "updatedBy": "SYSTEM AGGREGATOR JOB"
    }
}

[NEW] Settlement Created

The settlement generation has started.

{
    "id" : "event_96511a83-3189-409e-8a08-b27b8eb06f75",
    "type" : "settlements.created",
    "object" : "SETTLEMENTS_REPORT",
    "timestamp" : "2024-03-24T22:28:21.810Z",
    "payload" : {
        "settlementID": "sett_63ccb073-a7b6-4b33-af77-5baec5cc4494_profile1_20240324",
        "settlementDate": "2024-03-24",
        "partnerID": "63ccb073-a7b6-4b33-af77-5baec5cc4494",
        "status": "PENDING",
        "statusComment": "Report generated via aggregator cron job.",
        "totalAmount": -14250,
        "createdAt": "2024-03-24T22:28:21.810Z",
        "updatedAt": "2024-03-24T22:28:21.810Z",
        "updatedBy": "SYSTEM",
        "settlementProfileID": "profile1"
    }
}

[NEW] Settlement Approved

The settlement has been approved.

{
    "id" : "event_96511a83-3189-409e-8a08-b27b8eb06f75",
    "type" : "settlements.updated",
    "object" : "SETTLEMENTS_REPORT",
    "timestamp" : "2024-03-24T22:28:21.810Z",
    "payload" : {
        "settlementID": "sett_63ccb073-a7b6-4b33-af77-5baec5cc4494_profile1_20240324",
        "settlementDate": "2024-03-24",
        "partnerID": "63ccb073-a7b6-4b33-af77-5baec5cc4494",
        "status": "APPROVED",
        "statusComment": "Finished processing breakdown.",
        "totalAmount": -14250,
        "createdAt": "2024-03-24T22:28:21.810Z",
        "updatedAt": "2024-03-24T22:28:21.810Z",
        "updatedBy": "SYSTEM",
        "settlementProfileID": "profile1"
    }
}

[NEW] Settlement Completed

The settlement has been completed.

{
    "id" : "event_96511a83-3189-409e-8a08-b27b8eb06f75",
    "type" : "settlements.completed",
    "object" : "SETTLEMENTS_REPORT",
    "timestamp" : "2024-03-24T22:28:21.810Z",
    "payload" : {
        "settlementID": "sett_63ccb073-a7b6-4b33-af77-5baec5cc4494_profile1_20240324",
        "settlementDate": "2024-03-24",
        "partnerID": "63ccb073-a7b6-4b33-af77-5baec5cc4494",
        "status": "SUCCESSFUL",
        "statusComment": "Settlement report is settled.",
        "totalAmount": -14250,
        "createdAt": "2024-03-24T22:28:21.810Z",
        "updatedAt": "2024-03-24T22:28:21.810Z",
        "updatedBy": "SYSTEM",
        "settlementProfileID": "profile1"
    }
}