API Reference

Cria solicitação de opt-in de agendas

post
https://dup-api-stg.shipay.com.br/v1/funders/opt-ins

Este serviço cria solicitações de opt-in para acesso à Agenda de Duplicatas do Sacador.

A solicitação é processada de forma assíncrona na escrituradora/registradora e depende da autorização do Sacador, por isso a resposta retorna um identificador (process_id) que deve ser utilizado na consulta de processamento posteriormente para obter o status de sucesso ou insucesso da solicitação.

Body Params
string
required
length ≥ 1

Código de autorização do opt-in fornecido pelo Sacador.

date
required

Data da autorização do opt-in.

string
enum
required

Frequência de atualização da agenda.

ValorDescrição
dailyDiária.
weeklySemanal.
biweeklyQuinzenal.
monthlyMensal.
no_recurrenceSem recorrência (consulta única).
Allowed:
string
enum
required

Abrangência da agenda de duplicatas autorizada pelo opt-in.

ValorDescrição
allTodas as duplicatas.
openDuplicatas ativas/em aberto.
historicalDuplicatas do histórico.
Allowed:
date
required

Início da vigência do opt-in. Deve ser anterior ou igual a calendar_valid_until.

date
required

Fim da vigência do opt-in.

covered_buyers
array of objects
required
length ≥ 1

Lista de Sacados cobertos pelo opt-in.

Covered Buyers*
boolean
required

Indica se o documento do Sacador deve ser tratado pela base (raiz do CNPJ).

string
required
length ≥ 1

Número do documento do Sacador (CPF ou CNPJ), sem máscara.

string
enum
required

Tipo de documento do Sacador (CPF ou CNPJ).

Allowed:
Responses

Updated 22 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago

Did this page help you?