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

# Criar Checkout (Página)

> Criar página de Checkout onde o usuário pode escolher a rede de preferência e efetuar o pagamento. 

## Parâmetros de Requisição

<ParamField body="amount" type="number" required>
  Valor para cobrança em Reais Brasileiro (BRL). Ex: 10
</ParamField>

<ParamField body="success_url" type="string">
  Opcional. URL para redirecionamento após o pagamento bem sucedido (status: SUCCESS)
</ParamField>

<ParamField body="cancel_url" type="string">
  Opcional. URL para redirecionamento em caso de pagamento expirado ou falha. (status: FAILED)
</ParamField>

## Parâmetros de Resposta

<ResponseField name="id" type="string">
  Identificador único da transação ou cobrança gerada no sistema no formato UUID.
</ResponseField>

<ResponseField name="amount" type="integer">
  Valor total da transação (geralmente representado na menor unidade da moeda, como centavos).
</ResponseField>

<ResponseField name="status" type="string">
  Status atual da transação (Ex: `PENDING` para pendente, `PAID` para paga, `CANCELED` para cancelada).
</ResponseField>

<ResponseField name="success_url" type="string | null">
  URL de redirecionamento para onde o usuário será enviado após a conclusão bem-sucedida do pagamento.
</ResponseField>

<ResponseField name="cancel_url" type="string | null">
  URL de redirecionamento para onde o usuário será enviado caso decida cancelar o pagamento ou o checkout.
</ResponseField>

<ResponseField name="checkout_url" type="string">
  Link direto para a página de pagamento (checkout) onde o cliente final realizará a transação.
</ResponseField>

<ResponseField name="created_at" type="string">
  Data e hora exatas em que o registro foi criado no servidor, no formato ISO 8601 (UTC).
</ResponseField>

<RequestExample>
  ```shellscript cURL theme={null}
  curl --request POST \
    --url https://checkout.uspix.vc/api/checkouts \
    --header 'authorization: Bearer CHAVE_API' \
    --header 'content-type: application/json' \
    --data '{
    "amount": 45
  }'
  ```

  ```python Python theme={null}
  import requests

  url = "https://checkout.uspix.vc/api/checkouts"

  payload = {
      "amount": 45
  }
  headers = {
      "authorization": "Bearer CHAVE_API",
      "content-type": "application/json"
  }

  response = requests.post(url, json=payload, headers=headers)

  print(response.json())
  ```

  ```javascript Javascript theme={null}
  const url = 'https://checkout.uspix.vc/api/checkouts';
  const options = {
    method: 'POST',
    headers: {
      authorization: 'Bearer CHAVE_API',
      'content-type': 'application/json'
    },
    body: '{"amount": 45}'
  };

  try {
    const response = await fetch(url, options);
    const data = await response.json();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
  ```

  ```php PHP theme={null}
  <?php

  $curl = curl_init();

  curl_setopt_array($curl, [
    CURLOPT_URL => "https://checkout.uspix.vc/api/checkouts",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_POSTFIELDS => json_encode([
      'amount' => 45
    ]),
    CURLOPT_HTTPHEADER => [
      "authorization: Bearer CHAVE_API",
      "content-type: application/json"
    ],
  ]);

  $response = curl_exec($curl);
  $err = curl_error($curl);

  curl_close($curl);

  if ($err) {
    echo "cURL Error #:" . $err;
  } else {
    echo $response;
  }
  ```
</RequestExample>

<ResponseExample>
  ```json 201 theme={null}
  {
    "id": "019f9eed-2fff-7033-b3b0-a51ea254ac3c",
    "amount": 45,
    "status": "PENDING",
    "success_url": null,
    "cancel_url": null,
    "checkout_url": "https://checkout.uspix.vc/checkout/019f9eed-2fff-7033-b3b0-a51ea254ac3c",
    "created_at": "2026-07-26T14:56:12.000000Z"
  }
  ```
</ResponseExample>