Consult a bill by digitable line

curl --request POST \
  --url https://payments.sandbox.lerian.net/v1/payments/consult \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "digitableLine": "<string>"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://payments.sandbox.lerian.net/v1/payments/consult"

	payload := strings.NewReader("{\n  \"digitableLine\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({digitableLine: '<string>'})
};

fetch('https://payments.sandbox.lerian.net/v1/payments/consult', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://payments.sandbox.lerian.net/v1/payments/consult"

payload = { "digitableLine": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "amount": "<string>",
  "assignor": "<string>",
  "beneficiary": {
    "document": "<string>",
    "name": "<string>",
    "personType": "PF"
  },
  "discount": "<string>",
  "dueDate": "2023-12-25",
  "fine": "<string>",
  "interest": "<string>",
  "limitDate": "2023-12-25",
  "maxAmount": "<string>",
  "minAmount": "<string>",
  "originalAmount": "<string>",
  "payable": true,
  "paymentWindow": {
    "end": "<string>",
    "start": "<string>"
  },
  "receiverBank": {
    "code": "<string>",
    "ispb": "<string>",
    "name": "<string>"
  },
  "segment": "<string>",
  "settlementDate": "2023-12-25",
  "state": "<string>",
  "utilitySegment": "<string>"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Consult a bill by digitable line

Consults a bill by its digitable line without paying it: the source’s own view of the amount, the dates and who receives the money.

Why POST for a read. The digitable line identifies a payable bill and is sensitive, so it travels in the body instead of the URL, where proxies, logs and browser history would keep it. Nothing is created or changed: the request carries no Idempotency-Key and repeating it is safe.

Local validation first. The line must be 47 digits for a bank slip or 48 digits starting with 8 for a utilities bill, digits only and never normalized: any other form is refused with 400 PBP-0001 before any check digit is computed. A line in the right form whose check digits do not match is refused with 422 PBP-0100. Neither reaches the source.

Segments differ. Every member of the answer is always present; a member the segment does not report is null. A bank slip reports payability, the face value, fine, interest, discount, the due and limit dates, the beneficiary and the receiving bank. A utilities bill reports the assignor, its segment, the state, the payment window and a settlement date, which is not a due date. A bank slip the source does not know is 404 PBP-0110; a utilities line the source does not know is refused with 422 PBP-0111.

Permission. The operation requires payments/create, the same permission as initiating a payment: consulting is the first step of paying.

Isolation. The tenant and the provider credential come from the token, never from the request. The X-Organization-Id header is required and validated in form (a canonical UUID); it does not scope the consult, which reads no stored data of any organization.

POST

payments

consult

Consult a bill by digitable line

curl --request POST \
  --url https://payments.sandbox.lerian.net/v1/payments/consult \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "digitableLine": "<string>"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://payments.sandbox.lerian.net/v1/payments/consult"

	payload := strings.NewReader("{\n  \"digitableLine\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({digitableLine: '<string>'})
};

fetch('https://payments.sandbox.lerian.net/v1/payments/consult', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://payments.sandbox.lerian.net/v1/payments/consult"

payload = { "digitableLine": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "amount": "<string>",
  "assignor": "<string>",
  "beneficiary": {
    "document": "<string>",
    "name": "<string>",
    "personType": "PF"
  },
  "discount": "<string>",
  "dueDate": "2023-12-25",
  "fine": "<string>",
  "interest": "<string>",
  "limitDate": "2023-12-25",
  "maxAmount": "<string>",
  "minAmount": "<string>",
  "originalAmount": "<string>",
  "payable": true,
  "paymentWindow": {
    "end": "<string>",
    "start": "<string>"
  },
  "receiverBank": {
    "code": "<string>",
    "ispb": "<string>",
    "name": "<string>"
  },
  "segment": "<string>",
  "settlementDate": "2023-12-25",
  "state": "<string>",
  "utilitySegment": "<string>"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Organization-Id

string

Midaz organization of the caller. Required: a request without it, or with a value that is not a canonical UUID, is refused with 400 PBP-0025. Declared optional on the schema so that refusal keeps its own code instead of the schema's PBP-0001. The organization is validated and does not scope the consult: the tenant and the provider credential come from the token.

Corpo

application/json

digitableLine

string

obrigatório

Digitable line, digits only: 47 for a bank slip, or 48 starting with 8 for a utilities bill.

Required string length: 47 - 48

Pattern: ^(?:[0-79][0-9]{46}|8[0-9]{47})$

Resposta

amount

string

obrigatório

Consulted amount, two decimal places.

assignor

string | null

obrigatório

Utility company. Utilities only.

beneficiary

object | null

obrigatório

Who receives the money, with the document masked.

Show child attributes

discount

string | null

obrigatório

Discount granted. Bank slip only.

dueDate

string<date> | null

obrigatório

Due date. Bank slip only.

fine

string | null

obrigatório

Fine charged. Bank slip only.

interest

string | null

obrigatório

Interest charged. Bank slip only.

limitDate

string<date> | null

obrigatório

Last date the slip is payable. Bank slip only.

maxAmount

string | null

obrigatório

Highest payable amount, when the source reports a band.

minAmount

string | null

obrigatório

Lowest payable amount, when the source reports a band.

originalAmount

string | null

obrigatório

Face value of the slip. Bank slip only.

payable

boolean | null

obrigatório

Whether the source accepts the bill for payment, as it reported. Bank slip only.

paymentWindow

object | null

obrigatório

Time of day the bill can be paid. Utilities only.

Show child attributes

receiverBank

object | null

obrigatório

Bank that receives the payment. Bank slip only.

Show child attributes

segment

string

obrigatório

FEBRABAN segment the line was consulted on.

settlementDate

string<date> | null

obrigatório

Settlement date the source reported. Utilities only; it is not a due date.

state

string | null

obrigatório

Federative unit of the utility. Utilities only.

utilitySegment

string | null

obrigatório

The source's own segment text. Utilities only.

API de Boletos

API de Pagamentos

API de Dashboards

API de Administração

API de Webhooks

Tratamento de erros

Consult a bill by digitable line

Autorizações

Cabeçalhos

Corpo

Resposta