> ## Documentation Index
> Fetch the complete documentation index at: https://docs.korbit.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Cadastrar beneficiário PIX

> Cadastra a chave PIX de destino dos saques. Tipos aceitos: CPF, CNPJ, e-mail, telefone e chave aleatória (EVP). A chave é armazenada **criptografada** e sempre retornada mascarada.

<Warning>
  Beneficiário é destino de dinheiro: confirme o titular antes de cadastrar. Mudanças de beneficiário passam pelo fluxo de verificação da Korbit.
</Warning>


## OpenAPI

````yaml /openapi/korbit-public-v1.json post /v1/payout-beneficiaries
openapi: 3.1.0
info:
  title: Korbit API
  version: 1.0.0
  description: >-
    API de pagamentos da Korbit para merchants: PIX, cartão (com 3DS),
    assinaturas, checkout por link, payouts, antecipações e refunds — com
    idempotência, webhooks assinados e ambiente sandbox.
  contact:
    name: Suporte Korbit
    email: suporte@korbit.com.br
servers:
  - url: https://api.korbit.com.br
    description: Produção (chaves kbt_live_)
  - url: https://api-test.korbit.com.br
    description: Sandbox (chaves kbt_test_)
security:
  - bearerAuth: []
tags:
  - name: Antecipações
  - name: Assinaturas
  - name: Atividade
  - name: Catálogo
  - name: Chaves de API
  - name: Checkout
  - name: Clientes e Pedidos
  - name: Pagamentos
  - name: Refunds e Disputas
  - name: Saldo e Saques
  - name: Sandbox
  - name: Webhooks
paths:
  /v1/payout-beneficiaries:
    post:
      tags:
        - Saldo e Saques
      summary: Cadastrar beneficiário PIX
      description: >-
        Cadastra a chave PIX de destino dos saques. Tipos aceitos: CPF, CNPJ,
        e-mail, telefone e chave aleatória (EVP). A chave é armazenada
        **criptografada** e sempre retornada mascarada.
      operationId: createPayoutBeneficiary
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 255
          in: header
          name: idempotency-key
          required: true
        - schema:
            type: string
            pattern: ^[A-Za-z0-9_-]{43}$
          in: header
          name: x-korbit-dashboard-step-up
          required: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - pixKey
                - pixKeyType
              properties:
                pixKey:
                  type: string
                  minLength: 1
                  maxLength: 320
                  description: >-
                    A chave PIX em si — validada no cadastro (`403`/`422
                    INVALID_PIX_KEY` quando inválida).
                pixKeyType:
                  type: string
                  enum:
                    - CPF
                    - CNPJ
                    - EMAIL
                    - PHONE
                    - RANDOM
                  description: >-
                    Tipo da chave informada: CPF, CNPJ, EMAIL, PHONE ou EVP
                    (chave aleatória).
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - createdAt
                  - eligibilityCode
                  - id
                  - isPrimary
                  - maskedPixKey
                  - ownershipStatus
                  - pixKeyType
                  - updatedAt
                  - verificationMethod
                properties:
                  createdAt:
                    type: string
                    format: date-time
                  eligibilityCode:
                    type: string
                    enum:
                      - ELIGIBLE
                      - PIX_KEY_TYPE_UNSUPPORTED
                      - PIX_KEY_TAX_ID_MISMATCH
                      - MERCHANT_IDENTITY_REQUIRED
                  id:
                    type: string
                    format: uuid
                  isPrimary:
                    type: boolean
                  maskedPixKey:
                    type: string
                    minLength: 1
                    maxLength: 80
                  ownershipStatus:
                    type: string
                    enum:
                      - PENDING
                      - VERIFIED
                      - REJECTED
                  pixKeyType:
                    type: string
                    enum:
                      - CPF
                      - CNPJ
                      - EMAIL
                      - PHONE
                      - RANDOM
                  updatedAt:
                    type: string
                    format: date-time
                  verificationMethod:
                    anyOf:
                      - type: string
                        enum:
                          - TAX_ID_MATCH
                      - type: 'null'
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - createdAt
                  - eligibilityCode
                  - id
                  - isPrimary
                  - maskedPixKey
                  - ownershipStatus
                  - pixKeyType
                  - updatedAt
                  - verificationMethod
                properties:
                  createdAt:
                    type: string
                    format: date-time
                  eligibilityCode:
                    type: string
                    enum:
                      - ELIGIBLE
                      - PIX_KEY_TYPE_UNSUPPORTED
                      - PIX_KEY_TAX_ID_MISMATCH
                      - MERCHANT_IDENTITY_REQUIRED
                  id:
                    type: string
                    format: uuid
                  isPrimary:
                    type: boolean
                  maskedPixKey:
                    type: string
                    minLength: 1
                    maxLength: 80
                  ownershipStatus:
                    type: string
                    enum:
                      - PENDING
                      - VERIFIED
                      - REJECTED
                  pixKeyType:
                    type: string
                    enum:
                      - CPF
                      - CNPJ
                      - EMAIL
                      - PHONE
                      - RANDOM
                  updatedAt:
                    type: string
                    format: date-time
                  verificationMethod:
                    anyOf:
                      - type: string
                        enum:
                          - TAX_ID_MATCH
                      - type: 'null'
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '429':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '503':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
      security:
        - bearerAuth: []
        - dashboardSessionCookie: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Korbit API key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.