Pular para o conteúdo principal

Listar configurações de cessão

Lista as configurações de cessão da sua integração. Cada configuração é o acordo com um cessionário: para quem as dívidas são cedidas e quando a cessão automática roda. A assignment_configuration_key devolvida aqui é usada para criar um lote de cessão.

Endpoint​

ENDPOINT
/v2/assignment/assignment_configurations
MÉTODO
GET
STATUS
200

Autenticação​

Requer assinatura da requisição. Veja Troca de chaves.

Parâmetros de consulta​

CampoTipoObrigatórioDescriçãoTamanho
purchaser_document_numberstringNãoFiltra pelo CNPJ do cessionário, só dígitos.14
pageintegerNãoPágina desejada. Padrão 1.—
page_sizeintegerNãoConfigurações por página. Padrão 10.—

Resposta​

CampoTipoObrigatórioDescriçãoTamanho
dataarraySimConfigurações da página.—
data[].assignment_configuration_keyuuidSimChave da configuração de cessão.36
data[].is_activebooleanSimtrue quando a configuração está ativa.—
data[].purchaser_document_numberstringSimCNPJ do cessionário, só dígitos.14
data[].purchaser_namestringSimNome do cessionário.—
data[].requester_keyuuidSimChave da sua integração.36
data[].requester_namestringSimNome da sua integração.—
data[].next_execution_datetimestringNãoData e hora da próxima cessão automática, em ISO 8601.—
data[].is_automatic_debtbooleanSimIndica se a configuração opera com débito automático.—
paginationobjectSimpage e page_size usados na consulta.—
{
"data": [
{
"assignment_configuration_key": "3571e292-3a83-4011-904d-20ee963022ef",
"is_active": true,
"purchaser_document_number": "12345678000190",
"purchaser_name": "NOME DO CESSIONARIO",
"requester_key": "d3f788fd-0000-0000-0000-000000000000",
"requester_name": "NOME DO ORIGINADOR",
"next_execution_datetime": "2026-09-30T06:00:00",
"is_automatic_debt": false
}
],
"pagination": {
"page": 1,
"page_size": 10
}
}

Erros​

StatusCódigoDescrição
403QIT000005A consulta pediu configurações de outra integração.

Próximo passo​