Reconcile charge

Admin-only endpoint that marks a charge as paid by its transaction ID, recording the payment timestamp.

POST /api/v1/brcode/charges/reconcile

Reconcile charge

cURL

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/charges/reconcile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "txId": "<string>"
}
'

200

{
  "amount": "<string>",
  "chargeType": "<string>",
  "createdAt": "<string>",
  "id": "<string>",
  "merchantCity": "<string>",
  "merchantName": "<string>",
  "pixKey": "<string>",
  "status": "<string>",
  "txId": "<string>",
  "updatedAt": "<string>",
  "discountAmount": "<string>",
  "dueAt": "<string>",
  "expiresAt": "<string>",
  "interestPercent": "<string>",
  "paidAt": "<string>",
  "payableAmount": "<string>",
  "payloadLocation": "<string>",
  "penaltyPercent": "<string>",
  "rawPayload": "<string>"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Body

application/json

txId · string · required

Transaction identifier of the charge to mark as paid.

Example:

"txid-cobv-001"

Response

200

application/json

OK

amount · string · required

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

Example:

"250.00"

chargeType · string · required

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

Example:

"COB"

createdAt · string · required

Creation timestamp in RFC3339 UTC.

Example:

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

id · string · required

Server-assigned charge identifier (UUID).

Example:

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

merchantCity · string · required

Merchant city on the charge.

Example:

"São Paulo"

merchantName · string · required

Merchant legal/trade name on the charge.

Example:

"Lerian Studio"

pixKey · string · required

Pix key of the receiver settling the charge.

Example:

"12345678901"

status · string · required

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

Example:

"ATIVA"

txId · string · required

Merchant transaction identifier for the charge.

Example:

"txid-cobv-001"

updatedAt · string · required

Last-update timestamp in RFC3339 UTC.

Example:

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

discountAmount · string

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

Example:

"10.00"

dueAt · string

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

Example:

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

expiresAt · string

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

Example:

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

interestPercent · string

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

Example:

"1.00"

paidAt · string

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

Example:

"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.

Example:

"252.50"

payloadLocation · string

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

Example:

"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.

Example:

"2.00"

rawPayload · string

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

Example:

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