# Endpoints da API (/docs/cartao/endpoints)



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

  <QuickLink href="/docs/cartao/authentication" title="Autenticação" />

  <QuickLink href="/docs/cartao/test-cards" title="Cartões de teste" />

  <QuickLink href="/docs/cartao/webhooks" title="Webhooks" />
</QuickLinks>

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

<Mermaid
  chart="`
flowchart LR
  A[&#x22;POST /token&#x22;] --> B[&#x22;POST /charges&#x22;]
  B --> C[&#x22;Webhook de status&#x22;]
  C --> D[&#x22;GET /charges/{chargeId}&#x22;]
  D --> E[&#x22;PUT /charges/{chargeId}/reverse&#x22;]

  click A &#x22;/docs/cartao/endpoints/token/post_token&#x22; &#x22;Obter token&#x22;
  click B &#x22;/docs/cartao/endpoints/charges/post_charges&#x22; &#x22;Criar cobrança&#x22;
  click C &#x22;/docs/cartao/webhooks&#x22; &#x22;Webhooks&#x22;
  click D &#x22;/docs/cartao/endpoints/charges/get_charges__chargeId_&#x22; &#x22;Consultar cobrança&#x22;
  click E &#x22;/docs/cartao/endpoints/charges/put_charges__chargeId__reverse&#x22; &#x22;Estornar cobrança&#x22;

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

Você obtém um token, cria a cobrança, recebe o webhook com o resultado, consulta o estado quando precisar e estorna se for o caso.

## Token [#token]

Autenticação da API: troque `client_id` e `client_secret` por um token JWT.

<QuickLinks>
  <QuickLink href="/docs/cartao/endpoints/token/post_token" title="Obter token de API" method="POST" path="/token" />
</QuickLinks>

## Cobranças [#cobranças]

Criação, consulta e estorno de cobranças com cartão de crédito.

<QuickLinks>
  <QuickLink href="/docs/cartao/endpoints/charges/post_charges" title="Criar Cobrança" method="POST" path="/charges" />

  <QuickLink href="/docs/cartao/endpoints/charges/get_charges" title="Listar Cobranças" method="GET" path="/charges" />

  <QuickLink href="/docs/cartao/endpoints/charges/get_charges__chargeId_" title="Consultar Cobrança" method="GET" path="/charges/{chargeId}" />

  <QuickLink href="/docs/cartao/endpoints/charges/put_charges__chargeId__reverse" title="Estornar Cobrança" method="PUT" path="/charges/{chargeId}/reverse" />
</QuickLinks>

## Recorrências [#recorrências]

Gestão de assinaturas criadas com o nó `recurrence` no `POST /charges`.

<QuickLinks>
  <QuickLink href="/docs/cartao/endpoints/recurrences/get_charges_recurrences__recurrentPaymentId_" title="Consultar Recorrência" method="GET" path="/charges/recurrences/{recurrentPaymentId}" />

  <QuickLink href="/docs/cartao/endpoints/recurrences/put_charges_recurrences__recurrentPaymentId__amount" title="Alterar valor da Recorrência" method="PUT" path="/charges/recurrences/{recurrentPaymentId}/amount" />

  <QuickLink href="/docs/cartao/endpoints/recurrences/put_charges_recurrences__recurrentPaymentId__deactivate" title="Desativar Recorrência" method="PUT" path="/charges/recurrences/{recurrentPaymentId}/deactivate" />

  <QuickLink href="/docs/cartao/endpoints/recurrences/put_charges_recurrences__recurrentPaymentId__reactivate" title="Reativar Recorrência" method="PUT" path="/charges/recurrences/{recurrentPaymentId}/reactivate" />
</QuickLinks>

## Câmbio [#câmbio]

Cotações de referência e conversão para cobrança internacional.

<QuickLinks>
  <QuickLink href="/docs/cartao/endpoints/currencies/get_currency_rate" title="Cotação de moeda" method="GET" path="/currencies/{code}/rate" />

  <QuickLink href="/docs/cartao/endpoints/currencies/get_currency_convert" title="Converter valor" method="GET" path="/currencies/{code}/convert" />

  <QuickLink href="/docs/cartao/endpoints/currencies/get_currency_rates" title="Listar cotações" method="GET" path="/currencies/rates" />
</QuickLinks>

## Convenções [#convenções]

| Item                | Valor                                                                                                                                                                                   |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Base URL (produção) | `https://api.payzu.io/v1`                                                                                                                                                               |
| Base URL (sandbox)  | `https://api.sandbox.payzu.io/v1`                                                                                                                                                       |
| Autenticação        | mTLS (certificado de cliente) + `Authorization: Bearer SEU_TOKEN`, obtido no [`POST /token`](/docs/cartao/endpoints/token/post_token). Veja [Autenticação](/docs/cartao/authentication) |
| Content-Type        | `application/json`                                                                                                                                                                      |
| Valores             | Em centavos (`10000` = R$ 100,00)                                                                                                                                                       |