Consultar Unidade de Recebíveis (URs)

Consulta as URs de acordo com os filtros disponíveis.

AmbienteMétodoEndpoint
Sandboxhttps://splitsandbox.braspag.com.br/schedule-api/v1/receivables
Produçãohttps://split.braspag.com.br/schedule-api/v1/receivables

A API Split de Pagamento permite consultar as unidades de recebíveis de acordo com alguns parâmetros, como intervalo de data prevista de pagamento, intervalo de data de pagamento efetivo, bandeira, produto, MerchantId, antecipação, todos os sellers e número da página.

⚠️

O intervalo de datas para utilização da conciliação de URs deve seguir as seguintes regras:

  • É obrigatório passar pelo menos um intervalo de datas;
  • O intervalo entre a data inicial e final deve ser de no máximo 31 dias;
  • A data atual não pode estar entre o intervalo da busca;
  • A data inicial precisa ser um dia útil;
  • A data final precisa ser no máximo D-1 dia útil em relação a data atual ou maior que a data atual.

Resposta

A resposta da consulta de UR retorna os seguintes parâmetros:


ParâmetroTipoDescrição
PageIndexNúmeroPágina atual.
PageSizeNúmeroQuantidade de itens máximo por página.
PageCountNúmeroQuantidade de páginas.
ItemsArray[Receivable]Lista de objetos contendo informações dos recebíveis.
Items[].ReceivableIdGUIDIdentificador único da UR.
Items[].DocumentNumberStringNúmero de documento (CPF ou CNPJ) do proprietário da unidade de recebível.
Items[].ForecastDateDataData prevista de pagamento. Formato YYYY-DD-MM. Ex: 2021-11-01.
Items[].ProductStringProduto. Tipos possíveis: "CreditCard", "DebitCard", "BankSlip" (boleto).
Items[].BrandStringBandeira do cartão ou banco emissor do boleto.
Items[].TotalAmountdecimalValor Total das liquidações da UR. Ex R$1,00 = 100.
Items[].ReceivableAmountNúmeroValor em centavos, podendo ser negativo. Ex.: R$1,00 = 100.
Items[].AnticipatedAmountNúmeroValor em centavos antecipado líquido da Unidade de Recebível.
Items[].SettlementsArray[Settlement]Lista de objeto contendo informações de pagamento dos recebíveis.
Items[].Settlements[].ReceivableSettlementTypeStringTipo de pagamento. Valores previstos:
0-Braspag
1-ChangeOfOwnership
2-LienFiduciaryAssignment
3-LienOthers
4-JudicialBlockade
Veja a descrição na tabela Tipos de pagamento.
Items[].Settlements[].SettlementStatusStringStatus do pagamento. Valores previstos:
1-Scheduled
2-pending
3-Settled
4-Error
Veja a descrição na tabela Status do Pagamento.
Items[].Settlements[].AnticipatedBooleanFlag para indicar informações referentes à antecipação.
Items[].Settlements[].AmountStringValor líquido a ser pago.
Items[].Settlements[].InstructionInstructionObjeto contendo as informações de pagamento efetivado ou previsto. Retorno obrigatório quando ReceivableSettlementType for diferente de ChangeOfOwnership (troca de titularidade).
Items[].Settlements[].Instruction.IspbStringCódigo Ispb do banco.
Items[].Settlements[].Instruction.CompeCodeStringCódigo COMPE do banco.
Items[].Settlements[].Instruction.AgencyDigitStringDígito da agência bancária.
Items[].Settlements[].Instruction.AccountNumberStringNúmero da conta.
Items[].Settlements[].Instruction.AccountDigitStringDígito da conta
Items[].Settlements[].Instruction.AccountTypeStringTipo de conta. Valores possíveis:1-CheckingAccount, 2-SavingsAccount, 3-PaymentAccount, 4-DepositAccount, 5-GuaranteedAccount, 6-InvestmentAccount
Items[].Settlements[].Instruction.BankAccountDocumentNumberStringNúmero de documento do titular da conta (CPF ou CNPJ).
Items[].Settlements[].Instruction.BankAccountHolderNameStringNome do titular da conta
Items[].Settlements[].AnticipationDetailsAnticipationDetailsDetalhes da antecipação. Obrigatório caso Anticipated= true.
Items[].Settlements[].AnticipationDetails.GrossAmountNúmeroValor em centavos do total bruto resultado das antecipações em centavos.
Items[].Settlements[].AnticipationDetails.AnticipatedFeeNúmeroValor em centavos do total da taxa descontado referente as antecipações.
Items[].Settlements[].ChangeOfOwnershipDetailsChangeOfOwnershipDetailsDetalhes da troca de titularidade. Obrigatório caso ReceivableSettlementType = ChangeOfOwnership
Items[].Settlements[].ChangeOfOwnershipDetails.BeneficiaryDocumentNumberStringNúmero do documento do titular que vai receber o valor cedido na troca de titularidade.
Items[].Settlements[].ChangeOfOwnershipDetails.ProtocolGUIDIdentificador do efeito de protocolo recebido da registradora que informou a troca de titularidade.
Items[].Settlements[].SettlementDateDataData de pagamento.
Language
Click Try It! to start a request and see the response here!