---
title: "Obter saldo"
url: "https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5/operations/obter-saldo"
---

> Full API specification: https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5.md

# Obter saldo

`GET` `/recipients/{recipient_id}/balance`

Operation ID: `obter-saldo`

## Path parameters

- `recipient_id` (string, required) - Identificador do recebedor

## Responses

- `200` - 200
- `400` - 400

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Pagar.me v5 API (Legado)
  version: 5.0.0
servers:
  - url: https://api.stone.com.br/core/v5
paths:
  /recipients/{recipient_id}/balance:
    get:
      summary: Obter saldo
      description: ""
      operationId: obter-saldo
      parameters:
        - name: recipient_id
          in: path
          description: Identificador do recebedor
          schema:
            type: string
          required: true
      responses:
        "200":
          description: "200"
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "currency": "BRL",
                        "available_amount": 0,
                        "waiting_funds_amount": 0,
                        "transferred_amount": 0,
                        "recipient": {
                            "id": "rp_pVZR1qZi64F9bR5e",
                            "name": "First recipient",
                            "email": "first_recipient@pagar.me",
                            "document": "12728994706",
                            "description": "Descrição do recebedor 1",
                            "type": "individual",
                            "status": "active",
                            "created_at": "2020-10-08T21:35:26Z",
                            "updated_at": "2020-10-17T18:54:06Z"
                        }
                    }
              schema:
                type: object
                properties:
                  currency:
                    type: string
                    example: BRL
                  available_amount:
                    type: integer
                    example: 0
                    default: 0
                  waiting_funds_amount:
                    type: integer
                    example: 0
                    default: 0
                  transferred_amount:
                    type: integer
                    example: 0
                    default: 0
                  recipient:
                    type: object
                    properties:
                      id:
                        type: string
                        example: rp_pVZR1qZi64F9bR5e
                      name:
                        type: string
                        example: First recipient
                      email:
                        type: string
                        example: first_recipient@pagar.me
                      document:
                        type: string
                        example: "12728994706"
                      description:
                        type: string
                        example: Descrição do recebedor 1
                      type:
                        type: string
                        example: individual
                      status:
                        type: string
                        example: active
                      created_at:
                        type: string
                        example: 2020-10-08T21:35:26Z
                      updated_at:
                        type: string
                        example: 2020-10-17T18:54:06Z
        "400":
          description: "400"
          content:
            application/json:
              examples:
                Result:
                  value: "{}"
              schema:
                type: object
                properties: {}
      deprecated: false
security:
  - sec0: []
components:
  securitySchemes:
    sec0:
      type: http
      scheme: basic
```