Retrieve Merchant Balances at the end of the specified date

GET 
/pix/entities/{entity-id}/closing-balances/{report-date}

Retrieves a merchant's balances from all PIX providers at the end of the specified date.

Request

Path Parameters

entity-id stringrequired

Possible values: <= 50 characters

report-date daterequired

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 BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

Example (from schema)

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

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 BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

Example (from schema)

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

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 BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

Example (from schema)

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

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 BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

Example (from schema)

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

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 BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

Example (from schema)

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

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 BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

Example (from schema)

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

Loading...