# Endpoints da API (/docs/conta-digital/endpoints)

<QuickLinks>
  <QuickLink href="/docs/conta-digital/getting-started" title="Primeiros passos" />

  <QuickLink href="/docs/conta-digital/authentication" title="Autenticação" />

  <QuickLink href="/docs/conta-digital/webhooks" title="Webhooks" />

  <QuickLink href="/docs/conta-digital/error-codes" title="Códigos de erro" />
</QuickLinks>

Base URL: `https://api.hub.payzu.com.br/api/v1`. `GET /status` dispensa credencial; as demais rotas usam a credencial, como em [Autenticação](/docs/conta-digital/authentication). Cada rota informa o escopo que exige.

## Fluxo típico de integração [#fluxo-típico-de-integração]

<Mermaid
  chart="`
flowchart LR
  A[&#x22;POST /oauth/token&#x22;] --> B[&#x22;POST /transactions/payment&#x22;]
  B --> C[&#x22;Webhook PAYMENT_PAID&#x22;]
  C --> D[&#x22;GET /transactions/payment/{paymentId}&#x22;]
  D --> E[&#x22;POST /transactions/withdraw&#x22;]

  click A &#x22;/docs/conta-digital/endpoints/authentication/post_oauth_token&#x22; &#x22;Obter token de acesso&#x22;
  click B &#x22;/docs/conta-digital/endpoints/charges/post_payment&#x22; &#x22;Criar cobrança Pix&#x22;
  click C &#x22;/docs/conta-digital/webhooks&#x22; &#x22;Webhooks&#x22;
  click D &#x22;/docs/conta-digital/endpoints/charges/get_payment&#x22; &#x22;Consultar cobrança&#x22;
  click E &#x22;/docs/conta-digital/endpoints/withdrawals/post_withdraw&#x22; &#x22;Sacar para chave Pix&#x22;

  style B fill:#14ce71,stroke:#0eb464,color:#ffffff
`"
/>

## Autenticação [#autenticação]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/authentication/post_oauth_token" title="Obter token de acesso" method="POST" path="/oauth/token" />
</QuickLinks>

## Cobranças [#cobranças]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/charges/post_payment" title="Criar cobrança Pix" method="POST" path="/transactions/payment" />

  <QuickLink href="/docs/conta-digital/endpoints/charges/get_payments" title="Listar cobranças" method="GET" path="/transactions/payment" />

  <QuickLink href="/docs/conta-digital/endpoints/charges/get_payment" title="Consultar cobrança" method="GET" path="/transactions/payment/{paymentId}" />

  <QuickLink href="/docs/conta-digital/endpoints/charges/get_payment_receipt" title="Comprovante da cobrança" method="GET" path="/transactions/payment/{paymentId}/receipt" />

  <QuickLink href="/docs/conta-digital/endpoints/charges/post_payment_refund" title="Estornar cobrança" method="POST" path="/transactions/payment/{paymentId}/refund" />
</QuickLinks>

## Saques [#saques]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/withdrawals/post_withdraw" title="Sacar para chave Pix" method="POST" path="/transactions/withdraw" />

  <QuickLink href="/docs/conta-digital/endpoints/withdrawals/get_withdraws" title="Listar saques" method="GET" path="/transactions/withdraw" />

  <QuickLink href="/docs/conta-digital/endpoints/withdrawals/get_withdraw" title="Consultar saque" method="GET" path="/transactions/withdraw/{withdrawId}" />

  <QuickLink href="/docs/conta-digital/endpoints/withdrawals/get_withdraw_receipt" title="Comprovante do saque" method="GET" path="/transactions/withdraw/{withdrawId}/receipt" />
</QuickLinks>

## Pix copia e cola e destinatário [#pix-copia-e-cola-e-destinatário]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/pix/post_pix_decode" title="Ler Pix copia e cola" method="POST" path="/transactions/pix/decode" />

  <QuickLink href="/docs/conta-digital/endpoints/pix/post_pix_destination" title="Consultar destinatário" method="POST" path="/transactions/pix/destination" />

  <QuickLink href="/docs/conta-digital/endpoints/pix/post_pix_qr_payment" title="Pagar Pix copia e cola" method="POST" path="/transactions/pix/qr-payments" />
</QuickLinks>

## Chaves Pix [#chaves-pix]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/pix-keys/get_pix_keys" title="Listar chaves Pix" method="GET" path="/transactions/pix-keys" />

  <QuickLink href="/docs/conta-digital/endpoints/pix-keys/post_pix_key" title="Criar chave Pix" method="POST" path="/transactions/pix-keys" />

  <QuickLink href="/docs/conta-digital/endpoints/pix-keys/put_pix_key_default" title="Definir chave padrão" method="PUT" path="/transactions/pix-keys/{pixKeyId}/default" />

  <QuickLink href="/docs/conta-digital/endpoints/pix-keys/delete_pix_key" title="Apagar chave Pix" method="DELETE" path="/transactions/pix-keys/{pixKeyId}" />
</QuickLinks>

## Transferências entre contas [#transferências-entre-contas]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/internal-transfers/post_internal_transfer" title="Transferir para outra conta PayZu" method="POST" path="/transactions/internal-transfer" />

  <QuickLink href="/docs/conta-digital/endpoints/internal-transfers/get_internal_transfers" title="Listar transferências" method="GET" path="/transactions/internal-transfer" />

  <QuickLink href="/docs/conta-digital/endpoints/internal-transfers/get_internal_transfer" title="Consultar transferência" method="GET" path="/transactions/internal-transfer/{transferId}" />

  <QuickLink href="/docs/conta-digital/endpoints/internal-transfers/get_internal_transfer_receipt" title="Comprovante da transferência" method="GET" path="/transactions/internal-transfer/{transferId}/receipt" />
</QuickLinks>

## Depósitos [#depósitos]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/deposits/get_deposit" title="Consultar depósito" method="GET" path="/transactions/deposit/{depositId}" />

  <QuickLink href="/docs/conta-digital/endpoints/deposits/get_deposit_receipt" title="Comprovante do depósito" method="GET" path="/transactions/deposit/{depositId}/receipt" />

  <QuickLink href="/docs/conta-digital/endpoints/deposits/post_deposit_refund" title="Devolver depósito" method="POST" path="/transactions/deposit/{depositId}/refund" />
</QuickLinks>

## Saldo, extrato e limites [#saldo-extrato-e-limites]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/account/get_balance" title="Consultar saldo" method="GET" path="/transactions/balance" />

  <QuickLink href="/docs/conta-digital/endpoints/account/get_statement" title="Consultar extrato" method="GET" path="/transactions/statement" />

  <QuickLink href="/docs/conta-digital/endpoints/account/get_limits" title="Consultar limites e tarifas" method="GET" path="/transactions/limits" />

  <QuickLink href="/docs/conta-digital/endpoints/account/get_metrics" title="Consultar métricas" method="GET" path="/transactions/metrics" />
</QuickLinks>

## Contestações MED [#contestações-med]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/infractions/get_infractions" title="Listar contestações MED" method="GET" path="/transactions/infractions" />

  <QuickLink href="/docs/conta-digital/endpoints/infractions/get_infraction" title="Consultar contestação MED" method="GET" path="/transactions/infractions/{protocol}" />
</QuickLinks>

## Webhooks [#webhooks]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/webhooks/get_webhooks" title="Listar endpoints de webhook" method="GET" path="/transactions/webhooks" />

  <QuickLink href="/docs/conta-digital/endpoints/webhooks/post_webhook" title="Cadastrar endpoint de webhook" method="POST" path="/transactions/webhooks" />

  <QuickLink href="/docs/conta-digital/endpoints/webhooks/put_webhook" title="Alterar endpoint de webhook" method="PUT" path="/transactions/webhooks/{webhookId}" />

  <QuickLink href="/docs/conta-digital/endpoints/webhooks/delete_webhook" title="Excluir endpoint de webhook" method="DELETE" path="/transactions/webhooks/{webhookId}" />

  <QuickLink href="/docs/conta-digital/endpoints/webhooks/get_callback_secret" title="Consultar segredo de callback" method="GET" path="/transactions/callback-secret" />

  <QuickLink href="/docs/conta-digital/endpoints/webhooks/post_callback_secret" title="Emitir segredo de callback" method="POST" path="/transactions/callback-secret" />

  <QuickLink href="/docs/conta-digital/endpoints/webhooks/post_callback_secret_rotate" title="Rotacionar segredo de callback" method="POST" path="/transactions/callback-secret/rotate" />
</QuickLinks>

## Status [#status]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/status/get_status" title="Saúde do serviço" method="GET" path="/status" />
</QuickLinks>

## Eventos de webhook [#eventos-de-webhook]

O que chega ao seu endpoint em cada evento. Como conferir a assinatura e quando há nova tentativa: [Webhooks](/docs/conta-digital/webhooks).

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_payment_created" title="PAYMENT_CREATED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_payment_paid" title="PAYMENT_PAID" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_payment_refunded" title="PAYMENT_REFUNDED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_payment_expired" title="PAYMENT_EXPIRED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_withdraw_created" title="WITHDRAW_CREATED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_withdraw_completed" title="WITHDRAW_COMPLETED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_withdraw_failed" title="WITHDRAW_FAILED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_refund_completed" title="REFUND_COMPLETED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_refund_failed" title="REFUND_FAILED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_deposit_received" title="DEPOSIT_RECEIVED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_internal_transfer_sent" title="INTERNAL_TRANSFER_SENT" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_internal_transfer_received" title="INTERNAL_TRANSFER_RECEIVED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_withdraw_refund_received" title="WITHDRAW_REFUND_RECEIVED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_infraction_opened" title="INFRACTION_OPENED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_infraction_closed" title="INFRACTION_CLOSED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_infraction_deadline" title="INFRACTION_DEADLINE" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_account_blocked" title="ACCOUNT_BLOCKED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_account_unblocked" title="ACCOUNT_UNBLOCKED" />
</QuickLinks>