Platform Liquidity Program

Subscribe to webhook events for Platform Liquidity Program balance alerts.

The following webhook events are available for the Payments for Platforms Platform Liquidity Program.

Event	Description
platform_liquidity_program.low_balance	Available balance for Platform Liquidity Program has fallen below the threshold.

Payload examples

Relevant webhook events:

platform_liquidity_program.low_balance

Payload example:

JSON

1{
2    "accountId":"acct_TOslkS7-MnyXlQuV8Lb4og",
3    "data":Object{...},
4    "id":"86b69f91-06f0-3fe8-8faf-4de58954ca8e",
5    "name":"platform_liquidity_program"
6}

The data object is the same as the response body of Get a program API API.

JSON

1{
2    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
3    "name": "Dummy Liquidity Program",
4    "status": "ACTIVE",
5    "limit_balances": [
6      {
7        "available": 100,
8        "reserved": 0,
9        "total": 100,
10        "currency": "USD"
11      }
12    ],
13    "supported_currencies": [
14      {
15        "currency": "USD",
16        "low_balance_threshold": 500
17      }
18    ]
19  }

Was this page helpful?