Current balance (from the ledger)

GET

/v1/balance

curl --request GET \
  --url http://localhost:4000/v1/balance \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearerAuth

Responses

200

Balance

Media typeapplication/json

object

object

required

string

Allowed values: balance

livemode

required

boolean

currency

required

string

available

required

integer

pending_payouts

required

integer

Example

{
  "object": "balance"
}

400

Validation error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Authentication error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Not found

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

429

Rate limited; see Retry-After response header

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}