Consultar agenda

Sandbox

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

Produção

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

PageCount

Número

Quantidade de páginas.

PageIndex

Número

Página atual.

PageSize

Número

Quantidade máxima de itens por página.

TotalItems

Número

Quantidade total de URs para o filtro solicitado.

TotalItemSchedules

Número

Quantidade total de ItemSchedules para o filtro solicitado.

Items

Arrayiente | Método

Lista de objetos contendo informações de agenda, separada por produto e bandeira.

Items[].DocumentNumber

string

Número do documento (CPF/CNPJ) do lojista.

Items[].ForecastedDate

Date

Data prevista de pagamento. Formato YYYY-dd-MM. Ex: 2021-11-01.

Items[].Product

String

Produto. Tipos possíveis: "CreditCard" para cartão de crédito, "DebitCard" para cartão de débito ou "BankSlip" para boleto.

Items[].Brand

String

Bandeira do cartão ou banco emissor do boleto. Tipos possíveis: Visa, Master, Amex, Elo e Diners.

Items[].ForecastedNetAmount

Número

Valor em centavos, podendo ser negativo. Ex R$1,00 = 100, referente ao somatório dos valores líquidos de agenda.

Items[].ItemSchedules

Arrayiente | Mé

Lista de objeto contendo informações de cada agenda individual.

Items[].ItemSchedules[].ScheduleId

GUID

Id de identificação do evento da agenda.

Items[].ItemSchedules[].MerchantDetails

MerchantDetails

Objeto contendo os detalhes da loja envolvida na agenda.

Items[].ItemSchedules[].MerchantDetails.MasterMerchantId

GUID

Id do Master. Retornado quando o Merchant for um sellers.

Items[].ItemSchedules[].MerchantDetails.MerchantId

GUID

Id da loja.

Items[].ItemSchedules[].MerchantDetails.MerchantType

String

Tipo da loja. Valores possíveis: Master ou Subordinate

Items[].ItemSchedules[].MerchantDetails.CorporateName

String

Razão social da loja.

Items[].ItemSchedules[].MerchantDetails.FancyName

String

Nome fantasia da loja.

Items[].ItemSchedules[].MerchantDetails.DocumentType

String

Tipo de documento da loja. Tipos possíveis: CNPJ ou CPF.

Items[].ItemSchedules[].ScheduleType

String

Tipo de Evento da Agenda. Valores possíveis:

Crédito:

Credit
FeeCredit
RefundCredit
ChargebackCredit
AntiFraudFeeCredit
AdjustmentCredit
ChargebackReversalCredit
AnticipationCredit
AnticipationCommissionCredit
AnticipatedInstallmentsCredit
RefundReversalCredit
ReversalFeeCredit
BankSlipFeeCredit
BalanceCompensationCredit
ReversalAntiFraudFeeCredit
ReversalBankSlipFeeCredit
ScheduleBalanceCredit

Débito:

Debit
FeeDebit
RefundDebit
ChargebackDebit
AntiFraudFeeDebit
AdjustmentDebit
ChargebackReversalDebit
AnticipationCommissionDebit
AnticipatedInstallmentsDebit
RefundReversalDebit
ReversalPayoutDebit
ReversalFeeDebit
BankSlipFeeDebit
BalanceCompensationDebit
ReversalAntiFraudFeeDebit
ReversalBankSlipFeeDebit
AnticipationDebit
CompensationBetweenSamePaymentArrangementDebit
ScheduleBalanceDebit

Items[].ItemSchedules[].TransactionalEventType

string

Tipo do evento transacional de agenda. Valores possíveis :
Adjustment
Anticipation
Antifraud
Chargeback
ChargebackReversal
DebitBalanceAccounts
Refund
RefundReversal
Transaction
TransactionReversal

Items[].ItemSchedules[].TransactionalEventId

GUID

Id do Evento transacional.

Items[].ItemSchedules[].InstallmentNumber

Número

Número da parcela agendada.

Items[].ItemSchedules[].InstalmentNetAmount

Número

Valor líquido da parcela, podendo ser negativo. Ex: -R$100 =-100.

Items[].ItemSchedules[].PaymentDetails

PaymentDetails

Objeto contendo detalhes do pagamento (transação ou pedido) ao qual a agenda se refere.

Items[].ItemSchedules[].PaymentDetails.PaymentId

GUID

Id do pagamento (transação) devolvido pelo split.

Items[].ItemSchedules[].PaymentDetails.Installments

Número

Número total de parcelas da transação.

Items[].ItemSchedules[].PaymentDetails.CaptureDate

Data

Data em que a transação foi capturada, isto é, o dia em que o dinheiro foi debitado do cartão/conta do comprador; ou em que o pagamento do boleto foi confirmado. Ex: 2021-01-01.

Items[].ItemSchedules[].PaymentDetails.AuthorizationDate

DateTime

Data e hora em que a transação foi autorizada. Significa o momento em que a operadora do cartão reservou o saldo do cartão do comprador, mas esse valor não necessariamente foi debitado (o débito acontece na captura como explicado no campo anterior). Ex: 2021-01-01 00:00:00.

Items[].ItemSchedules[].PaymentDetails.Nsu

String

Número sequencial único retornado pela adquirente após a autorização da transação.

Items[].ItemSchedules[].PaymentDetails.AffiliationCode

String

Número de filiação da loja junto à adquirente.

Items[].ItemSchedules[].PaymentDetails.OrderId

String

Número do pedido da loja.