--- updatedAt: 2026-08-03T20:29:46.000Z agentTools: siteIndex: https://docs.cielo.com.br/llms.txt projectIndex: https://docs.cielo.com.br/split/llms.txt --- # Consultar Unidade de Recebíveis (URs) 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 master não possui permissão para visualizar as informações das unidades de recebíveis (URs) vinculadas aos sellers, podendo acessar apenas os dados da sua própria unidade de recebíveis. A API Split de Pagamento para consulta de unidade de recebíveis **não é habilitada automaticamente no ambiente Sandbox**. Para utilizá-la nesse ambiente, é necessário **solicitar a liberação por meio do suporte Cielo**. ### 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` | Arrayiente \| Méto | 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-MM-dd. 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` | Arrayiente \| Méto | 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](https://braspag.github.io//manual/split-pagamentos-nova-api-conciliacao#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](https://braspag.github.io//manual/split-pagamentos-nova-api-conciliacao#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. | # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "conciliação-no-split-de-pagamentos", "version": "1.0" }, "servers": [ { "url": "https://splitsandbox.braspag.com.br" } ], "security": [ {} ], "paths": { "/schedule-api/v1/receivables": { "get": { "summary": "Consultar Unidade de Recebíveis (URs)", "description": "Consulta as URs de acordo com os filtros disponíveis.", "operationId": "consultar-ur", "parameters": [ { "name": "InitialForecastedDate", "in": "query", "description": "Intervalo de data previsto de pagamento inicial para busca.
**É obrigatório enviar pelo menos um intervalo de datas no formato AAAA-MM-DD**.", "schema": { "type": "string", "format": "date" } }, { "name": "FinalForecastedDate", "in": "query", "description": "Intervalo de data previsto de pagamento final para busca.
**É obrigatório enviar pelo menos um intervalo de datas no formato AAAA-MM-DD**.", "schema": { "type": "string", "format": "date" } }, { "name": "InitialSettlementDate", "in": "query", "description": "Intervalo de data de pagamento efetivo inicial para busca.
**É obrigatório enviar pelo menos um intervalo de datas no formato AAAA-MM-DD**.", "schema": { "type": "string", "format": "date" } }, { "name": "FinalSettlementDate", "in": "query", "description": "Intervalo data de pagamento efetivo final para busca.
**É obrigatório enviar pelo menos um intervalo de datas no formato AAAA-MM-DD**.", "schema": { "type": "string", "format": "date" } }, { "name": "Brand", "in": "query", "description": "Bandeira que deve ser considerada na consulta. Por padrão, o saldo é consultado em todas as bandeiras na qual o solicitante possui recebíveis.
**Valores possíveis:** *Visa, Master, Amex, Elo, Diners* e *Hipercard*.", "schema": { "type": "string" } }, { "name": "Product", "in": "query", "description": "Produto que deve ser considerado na consulta (\"CreditCard\", \"DebitCard\" ou \"BankSlip\"). Por padrão, são retornadas informações de todas as bandeiras na qual o solicitante possui recebíveis.", "schema": { "type": "string" } }, { "name": "Anticipation", "in": "query", "description": "Marcador (flag) para informar se deseja consultar apenas informações referentes à antecipação.", "schema": { "type": "boolean" } }, { "name": "PageIndex", "in": "query", "description": "Índice da paginação. Necessário para percorrer as páginas do resultado", "schema": { "type": "integer", "format": "int32" } }, { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "description": "Bearer ", "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"PageIndex\": 1,\n \"PageSize\": 100,\n \"PageCount\": 5,\n \"Items\": [\n { \n \"ReceivableId\": \"d1ece5e7-f996-40eb-8825-8e3f7decba41\",\n \"DocumentNumber\": \"000000000000\",\n \"ForecastDate\": \"2021-11-16\",\n \"Product\": \"CreditCard\",\n \"Brand\": \"Visa\",\n \"TotalAmount\": 15055,\n \"ReceivableAmount\": 0,\n \"AnticipatedAmount\": 450,\n \"Settlements\": [\n {\n \"ReceivableSettlementType\": \"Braspag\",\n \"SettlementStatus\": \"Scheduled\", \n \"Anticipated\": false,\n \"Amount\": 4055,\n \"Instruction\": {\n \"Ispb\": \"1\",\n \"CompeCode\": \"001\",\n \"AgencyNumber\": \"00001\",\n \"AgencyDigit\": \"1\",\n \"AccountNumber\": \"353535\",\n \"AccountDigit\": \"1\",\n \"AccountType\": \"CheckingAccount\",\n \"BankAccountDocumentNumber\": \"000000000000\", \n \"BankAccountHolderName\": \"Nome do Beneficiario\"\n }\n },\n {\n \"ReceivableSettlementType\": \"Braspag\",\n \"SettlementStatus\": \"Scheduled\", \n \"Anticipated\": false,\n \"Amount\": 100,\n \"Instruction\": {\n \"Ispb\": 1,\n \"CompeCode\": \"001\",\n \"AgencyNumber\": \"00001\",\n \"AgencyDigit\": \"1\",\n \"AccountNumber\": \"353535\",\n \"AccountDigit\": \"1\",\n \"AccountType\": \"CheckingAccount\", \n \"BankAccountDocumentNumber\": \"000000000000\",\n \"BankAccountHolderName\": \"Nome do Beneficiario\"\n }\n },\n {\n \"ReceivableSettlementType\": \"Braspag\",\n \"Anticipated\": true,\n \"SettlementDate\": \"2021-11-10\",\n \"Amount\": 450,\n \"AnticipationDetails\": {\n \"GrossAmount\": 500,\n \"AnticipatedFee\": 50\n },\n \"SettlementStatus\": \"Settled\", \n \"Instruction\": {\n \"Ispb\": 1,\n \"CompeCode\": \"001\",\n \"AgencyNumber\": \"00001\",\n \"AgencyDigit\": \"1\",\n \"AccountNumber\": \"353535\",\n \"AccountDigit\": \"1\",\n \"AccountType\": \"CheckingAccount\",\n \"BankAccountDocumentNumber\": \"000000000000\",\n \"BankAccountHolderName\": \"Nome do Beneficiario\"\n }\n },\n {\n \"ReceivableSettlementType\": \"ChangeOfOwnership\",\n \"Amount\": 10000,\n \"ChangeOfOwnershipDetails\":{\n \"BeneficiaryDocumentNumber\": \"000000000\",\n \"Protocol\":\"0c486baa-872a-4dcd-a514-b5258cbc564d\" \n }\n },\n {\n \"ReceivableSettlementType\": \"LienFiduciaryAssignment\", \n \"Anticipated\": true,\n \"SettlementDate\": \"2021-11-10\",\n \"Amount\": 450,\n \"AnticipationDetails\": {\n \"GrossAmount\": 500,\n \"AnticipatedFee\": 50\n },\n \"SettlementStatus\": \"Settled\", \n \"Instruction\": {\n \"Ispb\": 1,\n \"CompeCode\": \"001\",\n \"AgencyNumber\": \"00001\",\n \"AgencyDigit\": \"1\",\n \"AccountNumber\": \"353535\",\n \"AccountDigit\": \"1\",\n \"AccountType\": \"CheckingAccount\", \n \"BankAccountDocumentNumber\": \"000000000000\",\n \"BankAccountHolderName\": \"Nome do Beneficiario\"\n }\n }\n ]\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "PageIndex": { "type": "integer", "example": 1, "default": 0 }, "PageSize": { "type": "integer", "example": 100, "default": 0 }, "PageCount": { "type": "integer", "example": 5, "default": 0 }, "Items": { "type": "array", "items": { "type": "object", "properties": { "ReceivableId": { "type": "string", "example": "d1ece5e7-f996-40eb-8825-8e3f7decba41" }, "DocumentNumber": { "type": "string", "example": "000000000000" }, "ForecastDate": { "type": "string", "example": "2021-11-16" }, "Product": { "type": "string", "example": "CreditCard" }, "Brand": { "type": "string", "example": "Visa" }, "TotalAmount": { "type": "integer", "example": 15055, "default": 0 }, "ReceivableAmount": { "type": "integer", "example": 0, "default": 0 }, "AnticipatedAmount": { "type": "integer", "example": 450, "default": 0 }, "Settlements": { "type": "array", "items": { "type": "object", "properties": { "ReceivableSettlementType": { "type": "string", "example": "Braspag" }, "SettlementStatus": { "type": "string", "example": "Scheduled" }, "Anticipated": { "type": "boolean", "example": false, "default": true }, "Amount": { "type": "integer", "example": 4055, "default": 0 }, "Instruction": { "type": "object", "properties": { "Ispb": { "type": "string", "example": "1" }, "CompeCode": { "type": "string", "example": "001" }, "AgencyNumber": { "type": "string", "example": "00001" }, "AgencyDigit": { "type": "string", "example": "1" }, "AccountNumber": { "type": "string", "example": "353535" }, "AccountDigit": { "type": "string", "example": "1" }, "AccountType": { "type": "string", "example": "CheckingAccount" }, "BankAccountDocumentNumber": { "type": "string", "example": "000000000000" }, "BankAccountHolderName": { "type": "string", "example": "Nome do Beneficiario" } } } } } } } } } } } } } } } } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```