Get bank account balance

GET 
/api/balances

Returns the balance of the company's bank account for the given provider.

Request

Query Parameters

provider stringrequired

Possible values: [Zro Global, Pay4Fun]

Bank provider to fetch the balance from

type stringrequired

Possible values: [transactional, owner]

Balance operation type

Responses

200

Successful operation

application/json

Schema

Schema

balance float

Account balance, in BRL

currency currency (string)

Balance currency

Example (from schema)

{
  "balance": 1500.75,
  "currency": "BRL"
}

400

Bad Request or unable to get balance

401

Unauthenticated

application/json

Schema

Schema

message message (integer)

Response 401

Example (from schema)

{
  "message": "Invalid x-api-key"
}

422

Validation error

Loading...