Pular para o conteúdo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Confirmar Aprovação de Pagamento

Libera para formalização um contrato averbado que aguarda sua aprovação (PENDING_PAYMENT_APPROVAL). Passo a passo no guia Aprovação de Pagamento.

Request

POST /api/v1/originator/contracts/{contractNumber}/payment-approval

Autenticação: Authorization: Bearer {originatorToken}. Sem corpo.

Parâmetros

Parâmetro
Local
Tipo
Obrigatório
Descrição

contractNumber

path

string

Sim

Número do contrato (CCB) em PENDING_PAYMENT_APPROVAL (máx. 50 caracteres)

Regras de aprovação

  • Só se aplica quando o originador tem requiresPaymentApproval = true e formalizationStrategy = GTBANKER. Sem isso, o contrato vai direto da averbação para a formalização.

  • O contrato deve estar em PENDING_PAYMENT_APPROVAL e pertencer ao originador autenticado.

  • Não há endpoint de rejeição. Para não prosseguir, use a desaverbação (POST /contracts/exclude).

  • Assíncrono: responde 202, o contrato passa a ENDORSED e segue para formalização (FORMALIZED → COMPLETED).

Response

202 Accepted:

Campo
Tipo
Descrição

requestNumber

string

Número da requisição do contrato

contractNumber

string

Número do contrato (CCB)

status

string

Estado do contrato após o aceite — ENDORSED

message

string

Mensagem explicativa sobre o processamento

Exemplo

Resposta 202:

Erros

Código

errorCode

Situação

404

—

Contrato não encontrado ou de outro originador

409

CONTRACT_NOT_PENDING_PAYMENT_APPROVAL

Contrato fora de PENDING_PAYMENT_APPROVAL. Não retente

429

—

Mais de 75 requisições por segundo

Erros comuns a todos os endpoints — 401, 403 de token, 409 de Idempotency-Key em processamento, 500 e 503 — e o formato ProblemDetail estão em Erros da API.

Webhooks relacionados

Evento
Quando

CONTRACT_PAYMENT_APPROVAL_REQUIRED

Contrato entrou em PENDING_PAYMENT_APPROVAL e aguarda confirmação

ENDORSEMENT_ENDORSED

Averbação concluída (disparado antes do evento acima)

Detalhes em Eventos e Payloads.

Confirmar Aprovação de Pagamento

post
/api/v1/originator/contracts/{contractNumber}/payment-approval

Confirma o envio de um contrato já averbado à formalização no GTBanker, para originadores configurados com requiresPaymentApproval. Aplicável apenas a contratos no estado PENDING_PAYMENT_APPROVAL (averbados, aguardando a confirmação do originador).

Processamento assíncrono: o contrato transiciona para ENDORSED e é enfileirado para a formalização no GTBanker. Para rejeitar (em vez de aprovar), use a desaverbação (POST /contracts/exclude).

Autorizações
AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de rota
contractNumberstring · mín: 1 · máx: 50Obrigatório

Número do contrato a confirmar

Respostas
202

Aprovação aceita (contrato enviado para formalização)

application/json

Resposta 202 da confirmação de aprovação de pagamento (processamento assíncrono).

publicIdstring · máx: 36Opcional

Identificador público do contrato. Pode vir omitido (ausente no JSON) em contratos antigos.

Example: 0198f2a1-7c3e-7b2d-9f14-3a5c8e6d1b02
requestNumberstring · máx: 36Opcional
contractNumberstringOpcional
statusstring · enumOpcional

Estado do contrato após a aprovação (segue para formalização).

Valores possíveis:
messagestringOpcional
post/api/v1/originator/contracts/{contractNumber}/payment-approval
POST /api/v1/originator/contracts/{contractNumber}/payment-approval HTTP/1.1
Host: ingress.gtpayroll.staging.giro.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "publicId": "0198f2a1-7c3e-7b2d-9f14-3a5c8e6d1b02",
  "requestNumber": "GTAB12CD34EF",
  "contractNumber": "00345678",
  "status": "ENDORSED",
  "message": "Aprovação de pagamento confirmada; contrato enviado para formalização."
}

Atualizado