Listar Boletos
Dados da API
- Dados da API:
- URL: https://integration.sopague.com.br/sopague
- Arquitetura: Representational State Transfer (REST)
Listar Boleto por data de vencimento
Este conjunto de endpoints é utilizado para listar boletos com base em datas de vencimento ou pagamento. Ele retorna uma lista detalhada com as informações relevantes dos boletos, como valor, status e informações do pagador.
GET /api/billissuer/list/by/due-date?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}
Este endpoint retorna boletos emitidos cuja data de vencimento está no intervalo informado.
Dicionário de dados - Parâmetros
| HEADER | DESCRIÇÃO | TIPO | TAMANHO | OBSERVAÇÃO |
|---|---|---|---|---|
| accountNumber | Número da conta que o boleto foi emitido | long | - | - |
| startDate | Data de vencimento inicial | date | - | Formato YYYY-MM-DD |
| endDate | Data de vencimento final | date | - | Formato YYYY-MM-DD |
- 🟢 200
Resposta
[{
"id":"00000000-0000-0000-0000-000000000000",
"value":0.00,
"issueDate":"2023-01-01",
"dueDate":"2023-01-01",
"payerDocument":"string", "payerName":"string", "payerStreetAndNumber":" string ", "payerZipCode":" string ",
"payerCity":" string ",
"payerCityState":" string ",
"payerNeighborhood":"string”,
"payerPhoneNumber":"string",
"effectivePaymentDate":"2023-01-01",
"effectiveCreditDate": "2023-01-01",
"effectivePaymentValue":0,
"barCode":null,
"digitableLine":null,
"pixEmv":null,
"statusBill":1,
"statusIntegration":1
}]
Dicionário de dados - Retorno
| HEADER | DESCRIÇÃO | TIPO | TAMANHO | OBSERVAÇÃO |
|---|---|---|---|---|
| Id | Identificador único do boleto | String | - | Identificador do boleto |
| Value | Valor original do boleto | decimal | 11, 2 | Formato 0.00 |
| IssueDate | Data de emissão | date | - | Formato YYYY-MM-DD |
| DueDate | Data de vencimento | date | - | Formato YYYY-MM-DD |
| PayerDocument | - | String | 14 | Somente números. |
| PayerName | Nome do devedor | String | 50 | - |
| PayerZipCode | CEP do devedor | String | 8 | Somente números. |
| PayerCity | Cidade do devedor | String | 100 | - |
| PayerCityState | Sigla da UF do devedor | String | 2 | - |
| PayerStreetAndNumber | Logradouro e número do devedor | String | 100 | - |
| PayerNeighborhood | Bairro do devedor | String | 50 | - |
| effectivePaymentDate | Data em que o pagamento do boleto foi registrado | Date | - | Formato YYYY-MM-DD |
| effectiveCreditDate | Data em que o valor do pagamento do boleto foi creditado no extrato | Date | - | Formato YYYY-MM-DD |
| effectivePaymentValue | Valor do pagamento | Decimal | 11, 2 | - |
| barCode | Código de barras | String | - | - |
| digitableLine | Linha digitável | String | - | - |
| pixEmv | EMV PIX, caso habilitado para emitir PIX | String | - | - |
| statusBill | Status do boleto | int | - | Formato: 1 = Processando; 2 = Emitido; 3 = Recebido; 9 = Vencido; 99 = Falha; |
| statusIntegration | Status da integração | int | - | Formato: 1 = Processando; 2 = Emitido; 9 = Rejeitado; Falha = 99; |
Listar Boleto por data pagamento
Utilizado para listar boletos por data de vencimento.
GET /api/billissuer/list/by/payment-date?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}
O método recebe o um período inicial e um período final de data de vencimento e retorna uma lista de boletos com status 3 (Recebido), que compreendido entre (inclusive) as datas informadas.
Dicionário de dados - Parâmetros
| HEADER | DESCRIÇÃO | TIPO | TAMANHO | OBSERVAÇÃO |
|---|---|---|---|---|
| accountNumber | Número da conta que o boleto foi emitido | long | - | - |
| startDate | Data de vencimento inicial | date | - | Formato YYYY-MM-DD |
| endDate | Data de vencimento final | date | - | Formato YYYY-MM-DD |
- 🟢 200
Resposta
[{
"id":"00000000-0000-0000-0000-000000000000",
"value":0.00,
"issueDate":"2023-01-01",
"dueDate":"2023-01-01",
"payerDocument":"string", "payerName":"string", "payerStreetAndNumber":" string ", "payerZipCode":" string ",
"payerCity":" string ",
"payerCityState":" string ",
"payerNeighborhood":"string”,
"payerPhoneNumber":"string",
"effectivePaymentDate":"2023-01-01",
"effectiveCreditDate": "2023-01-01",
"effectivePaymentValue":0,
"barCode":null,
"digitableLine":null,
"pixEmv":null,
"statusBill":1,
"statusIntegration":1
}]
Dicionário de dados - Retorno
| HEADER | DESCRIÇÃO | TIPO | TAMANHO | OBSERVAÇÃO |
|---|---|---|---|---|
| Id | Identificador único do boleto | String | - | Identificador do boleto |
| Value | Valor original do boleto | decimal | 11, 2 | Formato 0.00 |
| IssueDate | Data de emissão | date | - | Formato YYYY-MM-DD |
| DueDate | Data de vencimento | date | - | Formato YYYY-MM-DD |
| PayerDocument | - | String | 14 | Somente números. |
| PayerName | Nome do devedor | String | 50 | - |
| PayerZipCode | CEP do devedor | String | 8 | Somente números. |
| PayerCity | Cidade do devedor | String | 100 | - |
| PayerCityState | Sigla da UF do devedor | String | 2 | - |
| PayerStreetAndNumber | Logradouro e número do devedor | String | 100 | - |
| PayerNeighborhood | Bairro do devedor | String | 50 | - |
| effectivePaymentDate | Data em que o pagamento do boleto foi registrado | Date | - | Formato YYYY-MM-DD |
| effectiveCreditDate | Data em que o valor do pagamento do boleto foi creditado no extrato | Date | - | Formato YYYY-MM-DD |
| effectivePaymentValue | Valor do pagamento | Decimal | 11, 2 | - |
| barCode | Código de barras | String | - | - |
| digitableLine | Linha digitável | String | - | - |
| pixEmv | EMV PIX, caso habilitado para emitir PIX | String | - | - |
| statusBill | Status do boleto | int | - | Formato: 1 = Processando; 2 = Emitido; 3 = Recebido; 9 = Vencido; 99 = Falha; |
| statusIntegration | Status da integração | int | - | Formato: 1 = Processando; 2 = Emitido; 9 = Rejeitado; Falha = 99; |
Listar Boleto por data de crédito
Este endpoint é utilizado para listar boletos com base na data em que o crédito foi efetivado. Ele retorna uma lista detalhada com informações relevantes dos boletos, como valor, status e dados do pagador.
GET /api/billissuer/list/by/credit-date?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}&statusIntegration={statusIntegration}
O método recebe um período inicial e um período final para a data de crédito, retornando os boletos cuja data de crédito está no intervalo especificado.
Dicionário de dados - Parâmetros
| HEADER | DESCRIÇÃO | TIPO | TAMANHO | OBRIGATÓRIO | OBSERVAÇÃO |
|---|---|---|---|---|---|
| accountNumber | Número da conta que o boleto foi emitido | integer | - | Sim | - |
| startDate | Data de crédito inicial | datetime | - | Sim | Formato YYYY-MM-DD |
| endDate | Data de crédito final | datetime | - | Sim | Formato YYYY-MM-DD |
| statusIntegration | Status da integração do boleto | integer | - | Não | Valores: 1, 2, 9, 99 |
- 🟢 200
Resposta
[
{
"Id": "GUID",
"Value": "decimal",
"IssueDate": "DateTime",
"DueDate": "DateTime",
"PayerDocument": "string",
"PayerName": "string",
"PayerStreetAndNumber": "string",
"PayerZipCode": "string",
"PayerCity": "string",
"PayerCityState": "string",
"PayerNeighborhood": "string",
"PayerPhoneNumber": "string",
"EffectivePaymentDate": "DateTime",
"EffectiveCreditDate": "DateTime",
"EffectivePaymentValue": "decimal",
"BarCode": "string",
"OurNumber": "string",
"DigitableLine": "string",
"PixEmv": "string",
"OverduePaymentAllow": "boolean",
"OverduePaymentDateLimit": "DateTime",
"OverduePaymentPenalty": "decimal",
"OverduePenaltyReceived": "decimal",
"OverduePaymentInterest": "decimal",
"OverdueInterestReceived": "decimal",
"CancelDate": "DateTime",
"CancellationReason": "string",
"StatusBill": "int",
"ReferenceCode": "string"
}
]
Dicionário de dados - Retorno
| HEADER | DESCRIÇÃO | TIPO | TAMANHO | OBRIGATÓRIO | OBSERVAÇÃO |
|---|---|---|---|---|---|
| Id | Identificador único do boleto | GUID | - | Sim | Identificador do boleto |
| Value | Valor original do boleto | decimal | 11, 2 | Sim | Formato 0.00 |
| IssueDate | Data de emissão | datetime | - | Não | Formato YYYY-MM-DD |
| DueDate | Data de vencimento | datetime | - | Sim | Formato YYYY-MM-DD |
| PayerDocument | Documento do pagador (CPF/CNPJ) | string | 14 | Sim | Somente números. |
| PayerName | Nome do pagador | string | 50 | Sim | - |
| PayerZipCode | CEP do pagador | string | 8 | Sim | Somente números. |
| PayerCity | Cidade do pagador | string | 100 | Sim | - |
| PayerCityState | Estado do pagador | string | 2 | Sim | - |
| PayerStreetAndNumber | Logradouro e número do pagador | string | 100 | Sim | - |
| PayerNeighborhood | Bairro do pagador | string | 50 | Sim | - |
| EffectivePaymentDate | Data do pagamento efetivo | datetime | - | Não | Formato YYYY-MM-DD |
| EffectiveCreditDate | Data do crédito efetivo | datetime | - | Não | Formato YYYY-MM-DD |
| EffectivePaymentValue | Valor pago efetivamente | decimal | 11, 2 | Não | - |
| BarCode | Código de barras | string | - | Não | - |
| OurNumber | Nosso número | string | - | Não | - |
| DigitableLine | Linha digitável | string | - | Não | - |
| PixEmv | Código Pix EMV | string | - | Não | - |
| StatusBill | Status do boleto | int | - | Não | 1 = Processando; 2 = Emitido; 3 = Recebido; 9 = Vencido; 99 = Falha; |
| ReferenceCode | Código de referência do boleto | string | - | Não | - |