# API endpoints (/en/docs/cartao/endpoints)

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

  <QuickLink href="/docs/cartao/authentication" title="Authentication" />

  <QuickLink href="/docs/cartao/test-cards" title="Test cards" />

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

## Typical integration flow [#typical-integration-flow]

<Mermaid
  chart="`
flowchart LR
  A[&#x22;POST /token&#x22;] --> B[&#x22;POST /charges&#x22;]
  B --> C[&#x22;Status webhook&#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;Get token&#x22;
  click B &#x22;/docs/cartao/endpoints/charges/post_charges&#x22; &#x22;Create charge&#x22;
  click C &#x22;/docs/cartao/webhooks&#x22; &#x22;Webhooks&#x22;
  click D &#x22;/docs/cartao/endpoints/charges/get_charges__chargeId_&#x22; &#x22;Query charge&#x22;
  click E &#x22;/docs/cartao/endpoints/charges/put_charges__chargeId__reverse&#x22; &#x22;Reverse charge&#x22;

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

You get a token, create the charge, receive the webhook with the result, query the state whenever you need and reverse it if applicable.

## Token [#token]

API authentication: exchange `client_id` and `client_secret` for a JWT token.

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

## Charges [#charges]

Creation, query and reversal of credit card charges.

<QuickLinks>
  <QuickLink href="/docs/cartao/endpoints/charges/post_charges" title="Create charge" method="POST" path="/charges" />

  <QuickLink href="/docs/cartao/endpoints/charges/get_charges" title="List charges" method="GET" path="/charges" />

  <QuickLink href="/docs/cartao/endpoints/charges/get_charges__chargeId_" title="Get charge" method="GET" path="/charges/{chargeId}" />

  <QuickLink href="/docs/cartao/endpoints/charges/put_charges__chargeId__reverse" title="Reverse charge" method="PUT" path="/charges/{chargeId}/reverse" />
</QuickLinks>

## Recurrences [#recurrences]

Management of subscriptions created with the `recurrence` node in `POST /charges`.

<QuickLinks>
  <QuickLink href="/docs/cartao/endpoints/recurrences/get_charges_recurrences__recurrentPaymentId_" title="Get recurrence" method="GET" path="/charges/recurrences/{recurrentPaymentId}" />

  <QuickLink href="/docs/cartao/endpoints/recurrences/put_charges_recurrences__recurrentPaymentId__amount" title="Change recurrence amount" method="PUT" path="/charges/recurrences/{recurrentPaymentId}/amount" />

  <QuickLink href="/docs/cartao/endpoints/recurrences/put_charges_recurrences__recurrentPaymentId__deactivate" title="Deactivate recurrence" method="PUT" path="/charges/recurrences/{recurrentPaymentId}/deactivate" />

  <QuickLink href="/docs/cartao/endpoints/recurrences/put_charges_recurrences__recurrentPaymentId__reactivate" title="Reactivate recurrence" method="PUT" path="/charges/recurrences/{recurrentPaymentId}/reactivate" />
</QuickLinks>

## Currencies [#currencies]

Reference rates and conversion for international charges.

<QuickLinks>
  <QuickLink href="/docs/cartao/endpoints/currencies/get_currency_rate" title="Get currency rate" method="GET" path="/currencies/{code}/rate" />

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

  <QuickLink href="/docs/cartao/endpoints/currencies/get_currency_rates" title="List currency rates" method="GET" path="/currencies/rates" />
</QuickLinks>

## Conventions [#conventions]

| Item                  | Value                                                                                                                                                                                     |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Base URL (production) | `https://api.payzu.io/v1`                                                                                                                                                                 |
| Base URL (sandbox)    | `https://api.sandbox.payzu.io/v1`                                                                                                                                                         |
| Authentication        | mTLS (client certificate) + `Authorization: Bearer YOUR_TOKEN`, obtained from [`POST /token`](/docs/cartao/endpoints/token/post_token). See [Authentication](/docs/cartao/authentication) |
| Content-Type          | `application/json`                                                                                                                                                                        |
| Amounts               | In cents (`10000` = R$ 100.00). Exchange rates (`rate.bid`, `rate.ask`) are decimals                                                                                                      |