GET /v1/balances
Balances from the ledger
Secret key
Host https://api.socialmatterspay.com · https://sandbox.socialmatterspay.com
Responses
| Status | Meaning |
|---|---|
200 | Balance |
Fields of data (200)
| Field | Notes | ||||||||
|---|---|---|---|---|---|---|---|---|---|
objectstring = "balance" | — | ||||||||
available_centsinteger | What a payout would send now, never negative: the balance less held_cents and reserve_held_cents | ||||||||
merchant_balance_centsinteger | What SMP owes the merchant; negative when returns exceed it | ||||||||
held_centsinteger | Settled payments not yet released (every payment is released on settlement unless SMP staff set a release delay) | ||||||||
reserve_held_centsinteger | Held back by reserves SMP staff added; never more than is available. The reserves are on the dashboard. | ||||||||
pending_centsinteger | — | ||||||||
unnetted_return_centsinteger | — | ||||||||
unnetted_fee_centsinteger | Assessed fees not yet carried by a payout | ||||||||
pending_payout_centsinteger | — | ||||||||
payout_holdobject | 4 child fields
| ||||||||
currencystring = "USD" | — | ||||||||
as_ofstring (date-time) | — |
Examples (2)
Balance now
curl https://sandbox.socialmatterspay.com/v1/balances \
-H 'Authorization: Bearer sk_sandbox_…'HTTP 200
Cache-Control: no-store
{
"data": {
"object": "balance",
"available_cents": 8051,
"merchant_balance_cents": 8051,
"held_cents": 0,
"reserve_held_cents": 0,
"pending_cents": 0,
"unnetted_return_cents": 0,
"unnetted_fee_cents": 240,
"pending_payout_cents": 0,
"payout_hold": {
"active": false
},
"currency": "USD",
"as_of": "2026-10-28T00:22:35.577Z"
}
}Balance after the return
curl https://sandbox.socialmatterspay.com/v1/balances \
-H 'Authorization: Bearer sk_sandbox_…'HTTP 200
Cache-Control: no-store
{
"data": {
"object": "balance",
"available_cents": 0,
"merchant_balance_cents": -5400,
"held_cents": 0,
"reserve_held_cents": 0,
"pending_cents": 0,
"unnetted_return_cents": 4200,
"unnetted_fee_cents": 1200,
"pending_payout_cents": 0,
"payout_hold": {
"active": false
},
"currency": "USD",
"as_of": "2026-10-28T00:22:36.681Z"
}
}
GET /v1/balances/history
Daily change of the merchant balance
Secret key
Host https://api.socialmatterspay.com · https://sandbox.socialmatterspay.com
Parameters
| Field | Notes |
|---|---|
daysquery · integer | 1 to 90. default 30 |
Responses
| Status | Meaning |
|---|---|
200 | One row per day with movement |
Fields of each item of data (200)
| Field | Notes |
|---|---|
datestring (date) | — |
credits_centsinteger | — |
debits_centsinteger | — |
net_change_centsinteger | — |
Example
Daily balance changes
curl https://sandbox.socialmatterspay.com/v1/balances/history?days=7 \
-H 'Authorization: Bearer sk_sandbox_…'HTTP 200
Cache-Control: no-store
{
"data": [
{
"date": "2026-10-28",
"credits_cents": 12424,
"debits_cents": 17824,
"net_change_cents": -5400
}
]
}