Skip to main content

consulta_de_agenda_sem_opt_in

Request

  • ENDPOINT
    /receivables/inquiry
  • MÉTODO
    POST
  • BODY
    (antes de ser assinado):

YOUR REQUEST HISTORY

body.json
{
"notification_type": "webhook",
"owner_person_type": "legal",
"owner_person_name": "John Sample Inc",
"owner_document_number": "86498542000151",
"reference_code": "5830c2f9-fd17-4c9c-b30c-68ddd1a92751",
"agenda": {
"end_date": "2021-06-23",
"start_date": "2021-06-23"
}
}

Atenção

A request com pré-autorização deverá ser usada, quando o solicitante da agenda já tem o consentimento do cliente. Dessa forma, deverá ser passado no campo authorization dentro de signatures, todas as informações referentes ao consentimento do cliente.

Essa request gerará uma consulta de agenda que será consultada assincronamente, o resultado virá via webhook.

BODY PARAMS

CampoDescrição
notification_type (obrigatório)
owner_person_type (obrigatório)Tipo de pessoa (natural ou juridica) objeto da consulta de agenda.
owner_person_name (obrigatório)Nome do objeto da consulta de agenda.
owner_document_number (obrigatório)Numero de documento do objeto da consulta de agenda.
reference_code (obrigatório)Identificador único do opt-in.
signature (obrigatório)Informações do opt-in.
agenda (obrigatório)Parâmetros para a consulta de agenda.

SIGNATURE OBJECT

CampoDescrição
signers (obrigatório)Lista de signatários.
authorization (obrigatório)

AGENDA OBJECT

CampoDescrição
acquirers (obrigatório)Lista de números de documentos da Credenciadoras.
card_schemes (obrigatório)Lista de arranjos de pagamento.
end_dateData de termino da consulta.
start_date (obrigatório)Data de início da consulta.