Retrieve Dynamic Charge with Due Date Details

{ "additionalInfo": { "customerId": "67890", "orderId": "12345" }, "amount": { "original": "100.00", "abatement": { "modality": "PERCENT", "value": "3.00" }, "discount": { "modality": "AMOUNT_ADVANCE_BUSINESS_DAY", "discountDateFixed": [ { "date": "2024-12-25", "value": "10.00" } ], "value": "5.00" }, "fine": { "modality": "PERCENT", "value": "2.00" }, "interest": { "modality": "PERCENTAGE_PER_MONTH_CALENDAR_DAYS", "value": "1.00" } }, "createdAt": "2024-01-15T10:30:00Z", "debtor": { "address": "Rua das Flores, 123", "city": "São Paulo", "document": "12345678901", "email": "joao@example.com", "name": "João da Silva", "state": "SP", "zipCode": "01310-100" }, "deletedAt": "2024-01-25T10:30:00Z", "description": "Payment for order #12345", "dueDate": "2024-12-31", "emv": "00020126580014br.gov.bcb.pix...", "id": "550e8400-e29b-41d4-a716-446655440010", "locationUrl": "https://api.example.com/qr/550e8400", "metadata": {}, "receiver": { "address": "Rua das Flores, 123", "city": "São Paulo", "document": "12345678901", "name": "João da Silva", "state": "SP", "tradeName": "Company Name", "zipCode": "01310-100" }, "receiverKey": "+5511999999999", "review": 0, "status": "ACTIVE", "tags": [ "ecommerce", "subscription" ], "txId": "TXabcdefghijklmno123456789", "updatedAt": "2024-01-20T14:45:00Z", "validAfterDue": 5 }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Account-Id

string

required

Account ID (UUID format)

Path Parameters

collection_id

string

required

Identifier of the due date collection

Response

additionalInfo

object

AdditionalInfo is a key-value map for additional information (optional)

Show child attributes

Example:

{ "customerId": "67890", "orderId": "12345" }

amount

object

Amount is the amount configuration object (required)

Show child attributes

createdAt

string

CreatedAt is the timestamp when the collection was created (required)

Example:

"2024-01-15T10:30:00Z"

debtor

object

Debtor is the debtor information (required)

Show child attributes

deletedAt

string

DeletedAt is the timestamp when the collection was deleted (optional, nullable)

Example:

"2024-01-25T10:30:00Z"

description

string

Description is the custom description of the collection (optional)

Example:

"Payment for order #12345"

dueDate

string

DueDate is the due date for the collection in format YYYY-MM-DD (required)

Example:

"2024-12-31"

emv

string

EMV is the QR code payload in EMV format (required)

Example:

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

string

ID is the unique identifier of the collection (required)

Example:

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

locationUrl

string

LocationURL is the URL to access the collection location/QR code (required)

Example:

"https://api.example.com/qr/550e8400"

metadata

object

Metadata is the custom metadata associated with this collection

Show child attributes

receiver

object

Receiver is the receiver information (required)

Show child attributes

receiverKey

string

Pix key that will receive the payment

Example:

"+5511999999999"

review

integer

Review is the revision number of the collection (required)

Example:

0

status

string

Status is the current status of the collection (required) Valid values: ACTIVE, COMPLETED, REMOVED_BY_RECEIVER, REMOVED_BY_PSP

Example:

"ACTIVE"