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
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 = trueeformalizationStrategy = GTBANKER. Sem isso, o contrato vai direto da averbação para a formalização.O contrato deve estar em
PENDING_PAYMENT_APPROVALe 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 aENDORSEDe segue para formalização (FORMALIZED→COMPLETED).
Response
202 Accepted:
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
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.
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).
JWT token fornecido pelo administrador
Número do contrato a confirmar
Aprovação aceita (contrato enviado para formalização)
Resposta 202 da confirmação de aprovação de pagamento (processamento assíncrono).
Identificador público do contrato. Pode vir omitido (ausente no JSON) em contratos antigos.
0198f2a1-7c3e-7b2d-9f14-3a5c8e6d1b02Estado do contrato após a aprovação (segue para formalização).
Não autenticado
Permissão insuficiente
Contrato não encontrado para o originador
Contrato fora de PENDING_PAYMENT_APPROVAL, ou Idempotency-Key em processamento.
Mais de 75 requisições por segundo. Aguarde o header Retry-After e reenvie com nova Idempotency-Key — com a mesma chave, o 429 gravado é repetido.
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