dLocal

dLocal Balance API

Inspect available merchant balance for payouts.

Documentation GitHub OpenAPI

Documentation

https://docs.dlocal.com/reference/requesting-payout-v3

https://docs.dlocal.com/docs/overview-payouts-v3

https://docs.dlocal.com/reference/security-payouts-v3

https://docs.dlocal.com/docs/platforms-overview

https://docs.dlocal.com/reference/create-account-v2-platforms-1

https://docs.dlocal.com/reference/notifications-v2-platforms

https://docs.dlocal.com/docs/kyc-verifications-overview

https://docs.dlocal.com/docs/kyc-verifications-process

https://docs.dlocal.com/reference/create-verification-1

https://docs.dlocal.com/reference/get-an-exchange-rate

Specifications

https://raw.githubusercontent.com/api-evangelist/d-local/refs/heads/main/openapi/d-local-balance-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/d-local/refs/heads/main/json-schema/payouts-v3-payout-schema.json

https://raw.githubusercontent.com/api-evangelist/d-local/refs/heads/main/json-structure/payouts-v3-payout-structure.json

https://raw.githubusercontent.com/api-evangelist/d-local/refs/heads/main/json-schema/platforms-account-schema.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/d-local/refs/heads/main/examples/payouts-v3-request-payout-example.json

https://raw.githubusercontent.com/api-evangelist/d-local/refs/heads/main/examples/payouts-v3-get-balance-example.json

https://raw.githubusercontent.com/api-evangelist/d-local/refs/heads/main/examples/platforms-create-account-example.json

https://raw.githubusercontent.com/api-evangelist/d-local/refs/heads/main/examples/kyc-create-verification-example.json

https://raw.githubusercontent.com/api-evangelist/d-local/refs/heads/main/examples/exchange-rates-get-rate-example.json

OpenAPI Specification

openapi: 3.0.3
info:
  title: dLocal Cards Accounts Balance API
  version: '2.1'
  description: 'Securely store cards for repeat usage. Create returns a `card_id` token

    that can be used in subsequent Payments and Authorizations.

    '
servers:
- url: https://api.dlocal.com
  description: Production
- url: https://sandbox.dlocal.com
  description: Sandbox
security:
- dLocalSignature: []
tags:
- name: Balance
  description: Inspect available merchant balance for payouts.
paths:
  /payouts/v3/balance:
    get:
      tags:
      - Balance
      operationId: getPayoutsBalance
      summary: Get Payouts Balance
      description: Retrieve the merchant's available payout balance.
      responses:
        '200':
          description: Balance returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Balance'
components:
  schemas:
    Balance:
      type: object
      properties:
        currency:
          type: string
        available_balance:
          type: number
        previous_day_closing_balance:
          type: number
        current_balance_date:
          type: string
          format: date
  securitySchemes:
    dLocalSignature:
      type: apiKey
      in: header
      name: Authorization