Skip to main content
PATCH
Revise a due-date collection's value modifiers

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. Replaying the same key with a divergent method, URL or body is PIX-0031 @ 412.

Required string length: 1 - 64
X-Account-Id
string
required

Receiver merchant account UUID

Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

Path Parameters

id
string
required

Collection UUID

Example:

"019e22f9-aabe-7ec9-ba6b-41608b9accf9"

Body

application/json
abatement
object | null

Replace (object) or remove (null) the abatement (abatimento) modifier; omit to leave unchanged

discount
object

Replace (object) or remove (null) the discount (desconto) modifier; omit to leave unchanged

fine
object | null

Replace (object) or remove (null) the fine (multa) modifier; omit to leave unchanged

interest
object | null

Replace (object) or remove (null) the interest (juros) modifier; omit to leave unchanged

Response

OK

accountId
string
required
Example:

"0196a7b2-3e5f-7061-ac12-34567890abcd"

amount
string
required
Example:

"100.50"

calendar
object
required
createdAt
string<date-time>
required
Example:

"2026-05-06T10:30:00Z"

currency
enum<string>
required
Available options:
BRL
Example:

"BRL"

emvPayload
string
required
Example:

"00020126360014br.gov.bcb.pix2562https://pix.example.com/qr/v2/cobv-abc1235204000053039865802BR5910Loja Teste6007Goiania62070503***63041D3F"

expiresAt
string<date-time>
required
Example:

"2026-05-06T11:30:00Z"

externalId
string
required
Example:

"0196a7b2-4f60-7172-bd23-4567890abcde"

id
string
required
Example:

"0196a7b2-1c3d-7e4f-8a90-1234567890ab"

isExpired
boolean
required
Example:

false

keyType
enum<string>
required
Available options:
CPF,
CNPJ,
PHONE,
EMAIL,
EVP
Example:

"EVP"

keyValue
string
required
Example:

"123e4567-e12b-12d1-a456-426655440000"

locationUrl
string
required
Example:

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

merchantCity
string
required
Example:

"Goiania"

merchantDocument
string
required
Example:

"39053344705"

merchantName
string
required
Example:

"Loja Teste"

organizationId
string
required
Example:

"0196a7b2-2d4e-7f50-9b01-234567890abc"

status
enum<string>
required
Available options:
ACTIVE,
COMPLETED,
CANCELLED
Example:

"ACTIVE"

txId
string
required
Example:

"TX1234567890123456789012345"

type
enum<string>
required
Available options:
IMMEDIATE,
DUE_DATE
Example:

"DUE_DATE"

updatedAt
string<date-time>
required
Example:

"2026-05-06T10:30:00Z"

abatement
object
additionalInfo
object[] | null
cancelledAt
string<date-time>
Example:

"2026-05-06T10:40:00Z"

cancelledReason
string
Example:

"Customer requested cancellation"

debtor
object
description
string
Example:

"Fatura de servicos"

discount
object
fine
object
interest
object
payment
object