get https://splitsandbox.braspag.com.br/schedule-api/v1/receivables
Consulta as URs de acordo com os filtros disponíveis.
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | get | https://splitsandbox.braspag.com.br/schedule-api/v1/receivables |
| Produção | get | https://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 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âmetro | Tipo | Descrição |
|---|---|---|
PageIndex | Número | Página atual. |
PageSize | Número | Quantidade de itens máximo por página. |
PageCount | Número | Quantidade de páginas. |
Items | Array[Receivable] | Lista de objetos contendo informações dos recebíveis. |
Items[].ReceivableId | GUID | Identificador único da UR. |
Items[].DocumentNumber | String | Número de documento (CPF ou CNPJ) do proprietário da unidade de recebível. |
Items[].ForecastDate | Data | Data prevista de pagamento. Formato YYYY-DD-MM. Ex: 2021-11-01. |
Items[].Product | String | Produto. Tipos possíveis: "CreditCard", "DebitCard", "BankSlip" (boleto). |
Items[].Brand | String | Bandeira do cartão ou banco emissor do boleto. |
Items[].TotalAmount | decimal | Valor Total das liquidações da UR. Ex R$1,00 = 100. |
Items[].ReceivableAmount | Número | Valor em centavos, podendo ser negativo. Ex.: R$1,00 = 100. |
Items[].AnticipatedAmount | Número | Valor em centavos antecipado líquido da Unidade de Recebível. |
Items[].Settlements | Array[Settlement] | Lista de objeto contendo informações de pagamento dos recebíveis. |
Items[].Settlements[].ReceivableSettlementType | String | Tipo 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[].SettlementStatus | String | Status do pagamento. Valores previstos: 1-Scheduled 2-pending 3-Settled 4-Error Veja a descrição na tabela Status do Pagamento. |
Items[].Settlements[].Anticipated | Boolean | Flag para indicar informações referentes à antecipação. |
Items[].Settlements[].Amount | String | Valor líquido a ser pago. |
Items[].Settlements[].Instruction | Instruction | Objeto contendo as informações de pagamento efetivado ou previsto. Retorno obrigatório quando ReceivableSettlementType for diferente de ChangeOfOwnership (troca de titularidade). |
Items[].Settlements[].Instruction.Ispb | String | Código Ispb do banco. |
Items[].Settlements[].Instruction.CompeCode | String | Código COMPE do banco. |
Items[].Settlements[].Instruction.AgencyDigit | String | Dígito da agência bancária. |
Items[].Settlements[].Instruction.AccountNumber | String | Número da conta. |
Items[].Settlements[].Instruction.AccountDigit | String | Dígito da conta |
Items[].Settlements[].Instruction.AccountType | String | Tipo de conta. Valores possíveis:1-CheckingAccount, 2-SavingsAccount, 3-PaymentAccount, 4-DepositAccount, 5-GuaranteedAccount, 6-InvestmentAccount |
Items[].Settlements[].Instruction.BankAccountDocumentNumber | String | Número de documento do titular da conta (CPF ou CNPJ). |
Items[].Settlements[].Instruction.BankAccountHolderName | String | Nome do titular da conta |
Items[].Settlements[].AnticipationDetails | AnticipationDetails | Detalhes da antecipação. Obrigatório caso Anticipated= true. |
Items[].Settlements[].AnticipationDetails.GrossAmount | Número | Valor em centavos do total bruto resultado das antecipações em centavos. |
Items[].Settlements[].AnticipationDetails.AnticipatedFee | Número | Valor em centavos do total da taxa descontado referente as antecipações. |
Items[].Settlements[].ChangeOfOwnershipDetails | ChangeOfOwnershipDetails | Detalhes da troca de titularidade. Obrigatório caso ReceivableSettlementType = ChangeOfOwnership |
Items[].Settlements[].ChangeOfOwnershipDetails.BeneficiaryDocumentNumber | String | Número do documento do titular que vai receber o valor cedido na troca de titularidade. |
Items[].Settlements[].ChangeOfOwnershipDetails.Protocol | GUID | Identificador do efeito de protocolo recebido da registradora que informou a troca de titularidade. |
Items[].Settlements[].SettlementDate | Data | Data de pagamento. |