Get pay-in balance

Pay-in funds not yet settled to you, and how they split across upcoming settlements.

Reads one pay-in account: accountType when given, otherwise your main pay-in account (payIn for most merchants, cryptoPayIn for merchants set up for crypto pay-ins). It is not a total across accounts.

  • totalBalanceMinor: net pay-ins not yet settled to you. Negative when refunds or chargebacks exceed unsettled funds. For IC++ pricing, a refund is deducted once it has settled.

  • ready.amountMinor = amount of the next upcoming settlement; ready.settlementDate is when it is expected to be paid.

  • scheduled.amountMinor = sum of the upcoming settlements after the next one.

  • pending.amountMinor = totalBalanceMinor − ready.amountMinor − scheduled.amountMinor (funds not yet allocated to a settlement; negative in a deficit).

  • percent = slice amount ÷ totalBalanceMinor × 100; 0 when there is no positive balance.

Amounts are in minor units of currency. Balances are cached for up to a minute; asOf is when this one was computed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Pay-in account to read. Defaults to your main pay-in account: payIn (fiat) for most merchants, cryptoPayIn for merchants set up for crypto pay-ins. Not a total across accounts.

Allowed:
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json