Criar uma renegociação

Request

ENDPOINT

/debt

MÉTODO

POST

Request Body

{
  "notification_type": "webhook",
  "owner_person_type": "legal",
  "owner_person_name": "John Sample Inc",
  "owner_document_number": "86498542000151",
  "reference_code": "5830c2f9-fd17-4c9c-b30c-68ddd1a92751",
  "signature": {
    "signers": [
      {
        "name": "John Sample",
        "email": "john.sample@yopmail.com",
        "person_type": "natural",
        "document_number": "42889916090"
      }
    ]
  },
  "agenda": {
    "acquirers": [
      "cdc"
    ],
    "card_schemes": [
      "cdc"
    ],
    "end_date": "2021-06-23",
    "start_date": "2021-06-23"
  }
}

Atenção!

O payload ultilizado na emissão de um refinanciamento é o mesmo ultilizado na emissã de uma divida simples, com a adição da lista de operações que serão quitadas em "refinanced_credit_operations".

Body Params

Campo	Tipo	Descrição	Máx. Caract.
notification_type *	enum	tipo de notificação	-
owner_person_type *	enum	Tipo de pessoa (natural ou juridica) objeto da consulta de agenda.	-
owner_person_name *	string	Nome do objeto da consulta de agenda.	-
owner_document_number *	string	Numero de documento do objeto da consulta de agenda.	-
reference_code *	object	Identificador único do opt-in.	-
signature *	object	Informações do opt-in. refinanciadas.	-
agenda *	object	Parâmetros para a consulta de agenda.	-

Definições

Objeto agenda

Campo	Tipo	Descrição	Máx. Caract.
acquirers *	array	Lista de números de documentos da Credenciadoras.	-
card_schemes *	array	Lista de arranjos de pagamento.	-
end_date *	string	Data de termino da consulta.	-
start_date *	string	Data de início da consulta.	-

Enumeradores

Enumerador Person Type

Enumerador	Descrição
legal	Pessoa juridica
natural	Pesso física

Enumerador Account Type

Enumerador	Descrição
webhook	Conta corrente

Response

STATUS

200

Response Body

{}

STATUS

400

Response Body

{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}