Consultar agenda

get

https://splitsandbox.braspag.com.br/schedule-api/v1/ReconciliationSchedules

Consulta agenda de acordo com os filtros disponíveis.

Query Params

DocumentNumber

string

úmero de documento (CPF ou CNPJ) do participante.

TransactionId

string

Número da transação.

InitialForecastedDate

date

Data inicial prevista de pagamento para busca.

FinalForecastedDate

date

Data final prevista de pagamento para busca.

InitialScheduleDate

date

Data inicial de lançamento de informação na agenda.

FinalScheduleDate

date

Data final de lançamento de informação na agenda.

Brand

string

Bandeira que deve ser considerada na consulta. Por padrão, o saldo é consultado em todas as bandeiras na qual o solicitante possui agenda.

Product

string

Produto que deve ser considerado na consulta ("CreditCard" para cartão de crédito, "DebitCard" para cartão de débito ou "BankSlip" para boleto). Por padrão, são retornadas informações de todos os produtos na qual o solicitante possui agenda.

MerchantId

string

Id do Merchant para o qual deseja consultar as informações. Serão retornadas informações referentes ao número de documento do cadastro.

ScheduleEvent

array of int32s

Ids dos Eventos de Agenda que se deseja consultar - consulte os Ids no anexo Eventos de Agenda.

ScheduleEvent

ReceivableId

string

Id do Receivable que deseja consultar as informações. Serão retornadas informações referentes ao identificador do recebível.

PageIndex

int32

Índice da paginação. É necessário para percorrer as páginas do resultado.

Headers

Authorization

string

required

Bearer <acess_token>

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200