Skip to main content
POST
Conciliar cobrança

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json
txId
string
obrigatório

Transaction identifier of the charge to mark as paid.

Exemplo:

"txid-cobv-001"

Resposta

OK

amount
string
obrigatório

Original charge amount in BRL as a decimal string, scale 2.

Exemplo:

"250.00"

chargeType
string
obrigatório

Charge type: COB (immediate), COBV (due-date), or LoteCobV batch item.

Exemplo:

"COB"

createdAt
string
obrigatório

Creation timestamp in RFC3339 UTC.

Exemplo:

"2025-03-07T14:30:00Z"

id
string
obrigatório

Server-assigned charge identifier (UUID).

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

merchantCity
string
obrigatório

Merchant city on the charge.

Exemplo:

"São Paulo"

merchantName
string
obrigatório

Merchant legal/trade name on the charge.

Exemplo:

"Lerian Studio"

pixKey
string
obrigatório

Pix key of the receiver settling the charge.

Exemplo:

"12345678901"

status
string
obrigatório

Charge lifecycle status (ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP).

Exemplo:

"ATIVA"

txId
string
obrigatório

Merchant transaction identifier for the charge.

Exemplo:

"txid-cobv-001"

updatedAt
string
obrigatório

Last-update timestamp in RFC3339 UTC.

Exemplo:

"2025-03-07T14:30:00Z"

discountAmount
string

Configured early-payment discount in BRL as a decimal string, scale 2; empty for none.

Exemplo:

"10.00"

dueAt
string

Due date for due-date charges (COBV) as an RFC3339 UTC timestamp; null for immediate charges.

Exemplo:

"2025-03-15T23:59:59Z"

expiresAt
string

Immediate-charge (COB) expiry as an RFC3339 UTC timestamp; null when not applicable.

Exemplo:

"2025-03-08T23:59:59Z"

interestPercent
string

Configured monthly interest as a percentage decimal string (e.g. "1.00" = 1%); empty for none.

Exemplo:

"1.00"

paidAt
string

Settlement timestamp as an RFC3339 UTC timestamp; null until the charge is reconciled as paid.

Exemplo:

"2025-03-08T10:15:00Z"

payableAmount
string

Amount payable at the reference time in BRL, scale 2, after discount/penalty/interest; empty when not computed.

Exemplo:

"252.50"

payloadLocation
string

Resolvable payload location URL for the dynamic charge QR (empty when unavailable).

Exemplo:

"https://pix.example.com/qr/v2/txid-cobv-001"

penaltyPercent
string

Configured late-payment penalty as a percentage decimal string (e.g. "2.00" = 2%); empty for none.

Exemplo:

"2.00"

rawPayload
string

Raw EMV copy-and-paste payload string for the charge (empty when unavailable).

Exemplo:

"00020126580014br.gov.bcb.pix..."