Fetch Balance

GET 
/v1/balance

Get entity balance information.

Using the entity secret API key will return balance information related to entity.

Responses

200

Successful response

application/json

Schema

Schema

currency string
total integer

Total balance in smallest currency unit

available integer

Available balance in smallest currency unit

transferred integer

Total transferred amount in smallest currency unit

Example (from schema)

{
  "currency": "string",
  "total": 0,
  "available": 0,
  "transferred": 0
}

401

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [authentication_error]

message string

Possible values: [Invalid authorization credentials]

errors object

Example (from schema)

{
  "type": "authentication_error",
  "message": "Invalid authorization credentials",
  "errors": null
}

403

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [api_error]

message string

Possible values: [User not authorized]

errors object

Example (from schema)

{
  "type": "api_error",
  "message": "User not authorized",
  "errors": null
}

404

One of the record referenced in the request was not found

application/json

Schema

Schema

type string

Possible values: [record_not_found]

message string
errors object

Example (from schema)

{
  "type": "record_not_found",
  "message": "The <object type> record you were looking for was not found.",
  "errors": null
}

Loading...