Skip to main content
POST
Consult a bill by digitable line

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

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.

Cuerpo

application/json
digitableLine
string
requerido

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})$

Respuesta

OK

amount
string
requerido

Consulted amount, two decimal places.

assignor
string | null
requerido

Utility company. Utilities only.

beneficiary
object | null
requerido

Who receives the money, with the document masked.

discount
string | null
requerido

Discount granted. Bank slip only.

dueDate
string<date> | null
requerido

Due date. Bank slip only.

fine
string | null
requerido

Fine charged. Bank slip only.

interest
string | null
requerido

Interest charged. Bank slip only.

limitDate
string<date> | null
requerido

Last date the slip is payable. Bank slip only.

maxAmount
string | null
requerido

Highest payable amount, when the source reports a band.

minAmount
string | null
requerido

Lowest payable amount, when the source reports a band.

originalAmount
string | null
requerido

Face value of the slip. Bank slip only.

payable
boolean | null
requerido

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

paymentWindow
object | null
requerido

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

receiverBank
object | null
requerido

Bank that receives the payment. Bank slip only.

segment
string
requerido

FEBRABAN segment the line was consulted on.

settlementDate
string<date> | null
requerido

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

state
string | null
requerido

Federative unit of the utility. Utilities only.

utilitySegment
string | null
requerido

The source's own segment text. Utilities only.