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

# Iniciar el pago por PIX

> Genera el cargo PIX (código QR) de un pedido pendiente de pago.

**orderId** `string` *required*

El ID del pedido.

Cada código QR es válido durante hasta 30 minutos (`expires_at`), y nunca más allá del vencimiento del propio pedido.
Si vuelves a llamar mientras el código QR sigue siendo válido, se devuelve el mismo. Cuando caduca,
si vuelves a llamar mientras el pedido sigue abierto, se devuelve un código QR nuevo para el mismo pedido.

### Respuesta

**response** `object`

**Mostrar objeto**

**transaction\_amount** `number`

El importe del cargo, en BRL.

**external\_reference** `string | null`

El ID del pedido, devuelto como referencia externa del pago.

**txid** `string`

El ID de la transacción PIX.

**expires\_at** `string | null`

Cuándo deja de poder pagarse este código QR, en ISO 8601 (hasta 30 minutos después de generarse, nunca después de que caduque el pedido).

**qrcode** `object`

**Mostrar objeto**

**copy** `string | null`

El código PIX de copiar y pegar.

**base64** `string | null`

La imagen del código QR, codificada en base64.

```json Response theme={null}
{
  "response": {
    "transaction_amount": 24.9,
    "external_reference": "order-abc123",
    "txid": "9c2b1e3a-...-000",
    "expires_at": "2026-10-13T15:30:00.000Z",
    "qrcode": {
      "copy": "00020126...6304ABCD",
      "base64": "iVBORw0KGgoAAAANSUhEUgAA..."
    }
  }
}
```

### Respuestas de error

**code** `string`

El código de error que indica el motivo del fallo. Valores posibles:

* `AUTH_TOKEN_MISSING`, `API_KEY_INVALID`, `SESSION_REVOKED`: Falta la cabecera `Authorization`, la clave de API no es válida o la sesión del panel fue revocada (`401`).
* `API_KEY_IP_DENIED`, `API_KEY_SCOPE_DENIED`: La clave de API se usa desde una IP fuera de su lista de permitidas, o no tiene el scope que requiere la ruta (`403`).
* `USER_NOT_FOUND`: No se encontró el usuario autenticado.
* `ORDER_NOT_FOUND`: El pedido indicado no existe.
* `FORBIDDEN`: El pedido no pertenece al usuario autenticado.
* `ORDER_NOT_PAYABLE`: El pedido ya está pagado, cancelado o caducado (400), o todavía se está confirmando un pago con tarjeta del pedido (409).
* `COUPON_PAYMENT_METHOD`: El cupón del pedido no permite PIX.
* `PAYMENT_METHOD_UNAVAILABLE`: El pago en línea no está disponible temporalmente.
* `INVALID_PARAMS`: El `orderId` tiene un formato incorrecto.
* `RATE_LIMIT_EXCEEDED`: Se está iniciando otro pago de la cuenta. Vuelve a intentarlo en breve.
* `INTERNAL_SERVER_ERROR`: Se produjo un error inesperado en el servidor.

```json Error Response (400) theme={null}
{
  "code": "ORDER_NOT_PAYABLE"
}
```


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