Retrieve Merchant Balances

GET 
/pix/entities/{entity-id}/balances

Retrieves a merchant's balances from all PIX providers.

Request

Path Parameters

entity-id stringrequired

Possible values: <= 50 characters

Responses

200

OK

application/json

Schema

Schema

balances

object[]

Array [

provider Provider (string)required

Possible values: [P1, P2, P3, P4, P5, P6]

accountId AccountId (string)

amount Amount (number)

currency Currency (string)

Possible values: >= 3 characters and <= 3 characters

Default value: BRL

lastUpdated date-time

status ResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

]

result

object

required

status ResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "balances": [
    {
      "provider": "P1",
      "accountId": "string",
      "amount": 0,
      "currency": "BRL",
      "lastUpdated": "2024-07-29T15:51:28.071Z",
      "status": "success",
      "errors": {
        "code": "string",
        "reason": "string"
      }
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

400

Bad Request

application/json

Schema

Schema

balances

object[]

Array [

provider Provider (string)required

Possible values: [P1, P2, P3, P4, P5, P6]

accountId AccountId (string)

amount Amount (number)

currency Currency (string)

Possible values: >= 3 characters and <= 3 characters

Default value: BRL

lastUpdated date-time

status ResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

]

result

object

required

status ResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "balances": [
    {
      "provider": "P1",
      "accountId": "string",
      "amount": 0,
      "currency": "BRL",
      "lastUpdated": "2024-07-29T15:51:28.071Z",
      "status": "success",
      "errors": {
        "code": "string",
        "reason": "string"
      }
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

balances

object[]

Array [

provider Provider (string)required

Possible values: [P1, P2, P3, P4, P5, P6]

accountId AccountId (string)

amount Amount (number)

currency Currency (string)

Possible values: >= 3 characters and <= 3 characters

Default value: BRL

lastUpdated date-time

status ResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

]

result

object

required

status ResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "balances": [
    {
      "provider": "P1",
      "accountId": "string",
      "amount": 0,
      "currency": "BRL",
      "lastUpdated": "2024-07-29T15:51:28.071Z",
      "status": "success",
      "errors": {
        "code": "string",
        "reason": "string"
      }
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

403

Forbidden

application/json

Schema

Schema

balances

object[]

Array [

provider Provider (string)required

Possible values: [P1, P2, P3, P4, P5, P6]

accountId AccountId (string)

amount Amount (number)

currency Currency (string)

Possible values: >= 3 characters and <= 3 characters

Default value: BRL

lastUpdated date-time

status ResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

]

result

object

required

status ResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "balances": [
    {
      "provider": "P1",
      "accountId": "string",
      "amount": 0,
      "currency": "BRL",
      "lastUpdated": "2024-07-29T15:51:28.071Z",
      "status": "success",
      "errors": {
        "code": "string",
        "reason": "string"
      }
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

404

Not Found

application/json

Schema

Schema

balances

object[]

Array [

provider Provider (string)required

Possible values: [P1, P2, P3, P4, P5, P6]

accountId AccountId (string)

amount Amount (number)

currency Currency (string)

Possible values: >= 3 characters and <= 3 characters

Default value: BRL

lastUpdated date-time

status ResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

]

result

object

required

status ResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "balances": [
    {
      "provider": "P1",
      "accountId": "string",
      "amount": 0,
      "currency": "BRL",
      "lastUpdated": "2024-07-29T15:51:28.071Z",
      "status": "success",
      "errors": {
        "code": "string",
        "reason": "string"
      }
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

500

Internal Server Error

application/json

Schema

Schema

balances

object[]

Array [

provider Provider (string)required

Possible values: [P1, P2, P3, P4, P5, P6]

accountId AccountId (string)

amount Amount (number)

currency Currency (string)

Possible values: >= 3 characters and <= 3 characters

Default value: BRL

lastUpdated date-time

status ResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

]

result

object

required

status ResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "balances": [
    {
      "provider": "P1",
      "accountId": "string",
      "amount": 0,
      "currency": "BRL",
      "lastUpdated": "2024-07-29T15:51:28.071Z",
      "status": "success",
      "errors": {
        "code": "string",
        "reason": "string"
      }
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

Loading...