Balances

Balances show the merchant's money at 221 Pay. They are read only: only payments, refunds and payouts move them.

Read the balancesCopy Anchor Link

curl "$API_URL/v1/balances" -H "Authorization: Bearer $API_KEY"

{
  "gateway_mode": "real",
  "rails": {
    "sn_wave":   { "available": "245000", "pending": "0", "reserved": "100000" },
    "sn_orange": { "available": "38500",  "pending": "0", "reserved": "0" },
    "ci_wave":   { "available": "12000",  "pending": "0", "reserved": "0" }
  }
}

rails holds one balance per rail, under its identifier (sn_wave, ci_wave…): each rail activated on one of the merchant's projects, and each rail that still holds a balance. See Rails and countries.

Three bucketsCopy Anchor Link

The life of an amount:

1. Payment confirmed: the net amount (net) is credited; it is available as soon as the payment is confirmed.
2. Payout or refund accepted: the debited amount moves from available to reserved.
3. Payment out succeeded: it leaves reserved. Declined: it returns to available. Unknown outcome: it stays in reserved until proven.

One balance per railCopy Anchor Link

Each collection credits the balance of its rail: a ci_wave payment credits rails.ci_wave. Balances never mix:

• a payout draws on the balance of the payout number's rail;
• a refund draws on the balance of the refunded payment's rail.

Account mode: gateway_modeCopy Anchor Link

See Testing.

The same figures in the dashboardCopy Anchor Link

Balance and withdrawals section: balances, payout numbers and payout history. The dashboard home also summarises, per rail, the available balance and the success rate over the last 30 days.