Registrar Endosso-Penhor

POST

https://app.qescritural.com.br/api/bookkeeping/integration/v1/{tenantId}/act/endorsement/pledge

Nesta API, você registra um endosso‑penhor de duplicatas, transferindo o direito de crédito para um credor pignoratício. Para isto, informe o tenantId, o tipo de titularidade (drawer ou holder), o CPF/CNPJ e o nome legal do titular, e um identificador único da operação (e, se aplicável, o código IPOC), inclua as datas de vigência, o valor total e o valor de garantia, bem como incluir as informações do endosso‑penhor, do endossante e do beneficiário. Você precisa especificar as duplicatas abrangidas (pelos UIDs) e o CPF/CNPJ do sacado. Em seguida, o sistema validará e registrará o endosso‑penhor, atualizando as duplicatas.

Checklist de uso da API

Realizei login

Estou com Bearer Token atualizado

Tenho tenantId da minha conta

Tenho as informações da duplicata

Tenho as informações do credor pignoratício

Envio a requisição com as informações abaixo

Requisição

Authorization

Bearer Token

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK

application/json

Body

🟠400Erro de validação

🟠401Não autorizado

🟠403Acesso negado

🔴500Erro interno do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://app.qescritural.com.br/api/bookkeeping/integration/v1/83696183000159/act/endorsement/pledge' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ownershipType": "drawer",
    "ownershipIdentification": "88414906249",
    "ownershipLegalName": "Antonio Fábio Baptista",
    "certificateNegotiationReference": "FB8D6B18-F18F-471A-8A57-02DF71284489",
    "creditOperationIdentifier": "IPOC000001234567890ABCDEFGHIJKLMNPQRSTVWXYZ1234567890ABCDEFGHIJKLMNPQRSTV",
    "startDate": "2025-11-12T12:30:12.000Z",
    "endDate": "2025-11-12T12:30:12.000Z",
    "totalAmount": 1,
    "guaranteedAmount": 1,
    "pledgeEndorsement": {
        "endorser": {
            "identification": "88414906249",
            "legalName": "Ruan Roberto Pietro Porto",
            "email": "ruan.roberto.porto@gmail.com",
            "signature": "f5a18f9952e6953141539b6e69b4d79958cf0e75566f3489281496b27393686c",
            "signatureType": "Assinatura Eletrônica",
            "signatureDate": "2025-11-12T12:30:12.000Z"
        },
        "beneficiary": {
            "identification": "95156905366",
            "legalName": "Eloá Camila Marlene Lopes",
            "email": "eloa-lopes93@gmail.com"
        }
    },
    "actReceivables": [
        {
            "drawerIdentification": "00941170047",
            "tradeReceivableCertificateUniqueIdentifications": [
                "J7284200025185A4EJZZ"
            ]
        }
    ]
}'

Response Example

200 - Success

{
    "title": "One or more validation errors occurred.",
    "status": 400,
    "errors": {
        "Email": [
            "The Email field is required."
        ]
    }
}

Registrar Endosso-Penhor

Checklist de uso da API#

Requisição

Respostas

Checklist de uso da API