Retrieve ledger-derived balances for the merchant dashboard

{
  "currency": "USD",
  "availableMinor": "4999",
  "pendingMinor": "2500",
  "heldMinor": "1000",
  "payoutReadyMinor": "4999",
  "pendingPayoutMinor": "0"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Clerk session token for the merchant dashboard.

Response

Current balances

currency

string

required

Allowed value: "USD"

availableMinor

string

required

Posted balance currently available, in integer USD cents.

Pattern: ^[0-9]+$

pendingMinor

string

required

Payments in initiated, pending, or active state, in integer USD cents.

Pattern: ^[0-9]+$

heldMinor

string

required

Payments in provider hold state, in integer USD cents.

Pattern: ^[0-9]+$

payoutReadyMinor

string

required

Posted balance eligible to enter the payout flow, in integer USD cents.

Pattern: ^[0-9]+$

pendingPayoutMinor

string

required

Amount currently reserved in the payout-clearing account, in integer USD cents.

Pattern: ^-?[0-9]+$

⌘I

{
  "currency": "USD",
  "availableMinor": "4999",
  "pendingMinor": "2500",
  "heldMinor": "1000",
  "payoutReadyMinor": "4999",
  "pendingPayoutMinor": "0"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

Getting started

Hosted checkout

Payments and payouts

Integration reliability

API reference

Retrieve ledger-derived balances for the merchant dashboard

Authorizations

Response