> For the complete documentation index, see [llms.txt](https://docs.giro.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/aprovacao-de-pagamento.md).

# Aprovação de Pagamento

Passo opcional em que o originador confirma explicitamente, depois da **averbação**, que o contrato pode seguir para a **formalização** (CCB + desembolso). Até a confirmação, o contrato averbado não é enviado ao GTBanker.

## Quando se aplica

Só quando o originador tem **as duas** configurações:

| Configuração              | Valor      |
| ------------------------- | ---------- |
| `requiresPaymentApproval` | `true`     |
| `formalizationStrategy`   | `GTBANKER` |

Em qualquer outra combinação o passo não existe: o contrato segue da averbação direto para a formalização.

## Estados do contrato

```
SIGNED ──(averbação concluída)──▶ PENDING_PAYMENT_APPROVAL ──(confirmação do originador)──▶ ENDORSED ──▶ FORMALIZED ──▶ COMPLETED
```

| Estado                     | Significado                                                                                                           |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `SIGNED`                   | Assinado, enviado para averbação                                                                                      |
| `PENDING_PAYMENT_APPROVAL` | Averbação **concluída** (estado de averbação `ENDORSED`), aguardando a confirmação do originador. Não vai ao GTBanker |
| `ENDORSED`                 | Originador confirmou; segue para a formalização no GTBanker                                                           |
| `FORMALIZED`               | CCB recebida do GTBanker (`CCB_RECEIVED`)                                                                             |
| `COMPLETED`                | Desembolso realizado (`PAYMENT_SUCCESS`)                                                                              |

## Passo a passo

1. **Averbação concluída.** Chega o webhook `ENDORSEMENT_ENDORSED`, como em qualquer fluxo, e o contrato entra em `PENDING_PAYMENT_APPROVAL`.
2. **Webhook `CONTRACT_PAYMENT_APPROVAL_REQUIRED`** (`status: PENDING_PAYMENT_APPROVAL`). É **adicional** ao `ENDORSEMENT_ENDORSED` e só chega se você estiver **inscrito** nele.
3. **Confirmação.** Chame [`POST /api/v1/originator/contracts/{contractNumber}/payment-approval`](https://docs.giro.tech/desenvolvedores/api-gtpayroll/api-reference/contratos/confirmar-aprovacao-pagamento.md), sem corpo (`contractNumber` com máx. 50 caracteres). Resposta `202 Accepted`:

   | Campo            | Tipo            | Descrição                         |
   | ---------------- | --------------- | --------------------------------- |
   | `publicId`       | `string (uuid)` | Identificador público do contrato |
   | `requestNumber`  | `string`        | Número da requisição do contrato  |
   | `contractNumber` | `string`        | Número do contrato (CCB)          |
   | `status`         | `string`        | Estado após o aceite: `ENDORSED`  |
   | `message`        | `string`        | Mensagem sobre o processamento    |

   ```json
   {
     "publicId": "0198f2a1-7c3e-7b2d-9f14-3a5c8e6d1b07",
     "requestNumber": "GTAB12CD34EF",
     "contractNumber": "00345678",
     "status": "ENDORSED",
     "message": "Contrato liberado para formalização."
   }
   ```
4. **Formalização.** O contrato segue o fluxo padrão: `FORMALIZED` e depois `COMPLETED`.

### Erros

| Código                                                              | Quando                                          |
| ------------------------------------------------------------------- | ----------------------------------------------- |
| `404 Not Found`                                                     | Contrato não encontrado ou de outro originador  |
| `409 Conflict` (`errorCode: CONTRACT_NOT_PENDING_PAYMENT_APPROVAL`) | Contrato não está em `PENDING_PAYMENT_APPROVAL` |

## Rejeição

Não há endpoint de rejeição. Para não prosseguir, use a [desaverbação](https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/desaverbacao.md) ([`POST /api/v1/originator/contracts/exclude`](https://docs.giro.tech/desenvolvedores/api-gtpayroll/api-reference/contratos/desaverbar-contrato.md)): ela cancela o contrato e devolve a margem consignável, com os estados e webhooks descritos no guia.

## Eventos

| Evento                               | Source     | Quando                                        |
| ------------------------------------ | ---------- | --------------------------------------------- |
| `ENDORSEMENT_ENDORSED`               | `CONTRACT` | Averbação concluída                           |
| `CONTRACT_PAYMENT_APPROVAL_REQUIRED` | `CONTRACT` | Contrato entrou em `PENDING_PAYMENT_APPROVAL` |

Payload em [Eventos e Payloads](https://docs.giro.tech/desenvolvedores/api-gtpayroll/webhooks/eventos-e-payloads.md#contract_payment_approval_required).

{% embed url="<https://giro.tech/central-de-atendimento/>" %}
