Retrieve Dynamic Charge with Due Date Details

Use this endpoint to retrieve detailed information about a specific due date collection.

GET /v1/collections/duedate/{collection_id}

Retrieve Dynamic Charge with Due Date Details

cURL

curl --request GET \
  --url https://api.example.com/v1/collections/duedate/{collection_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

200

{
  "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": {
    "document": "52998224725",
    "name": "João da Silva"
  },
  "dueDate": "2024-12-31",
  "emv": "00020126580014br.gov.bcb.pix...",
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "locationUrl": "https://api.example.com/qr/550e8400",
  "receiver": {
    "address": "Rua das Flores, 123",
    "city": "São Paulo",
    "document": "52998224725",
    "name": "João da Silva",
    "state": "SP",
    "zipCode": "01310-100",
    "tradeName": "Company Name"
  },
  "receiverKey": "[phone]",
  "review": 0,
  "status": "ACTIVE",
  "txId": "TXabcdefghijklmno123456789",
  "updatedAt": "2024-01-20T14:45:00Z",
  "validAfterDue": 5,
  "additionalInfo": {
    "customerId": "67890",
    "orderId": "12345"
  },
  "deletedAt": "2024-01-25T10:30:00Z",
  "description": "Payment for order #12345",
  "metadata": {},
  "tags": [
    "ecommerce",
    "subscription"
  ]
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id · string<uuid> · requerido

Account ID (UUID format)

Parámetros de ruta

collection_id · string · requerido

Identifier of the due date collection

Respuesta

200

application/json

OK

amount · object · requerido

Show child attributes

createdAt · string<date-time> · requerido

Ejemplo:

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

debtor · object · requerido

Show child attributes

dueDate · string · requerido

Ejemplo:

"2024-12-31"

emv · string · requerido

Ejemplo:

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

id · string · requerido

Ejemplo:

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

locationUrl · string · requerido

Ejemplo:

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

receiver · object · requerido

Show child attributes

receiverKey · string · requerido

Ejemplo:

"[phone]"

review · integer<int64> · requerido

Ejemplo:

0

status · string · requerido

Ejemplo:

"ACTIVE"

txId · string · requerido

Ejemplo:

"TXabcdefghijklmno123456789"

updatedAt · string<date-time> · requerido

Ejemplo:

"2024-01-20T14:45:00Z"

validAfterDue · integer<int64> · requerido

Ejemplo:

5

additionalInfo · object

Show child attributes

Ejemplo:

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

deletedAt · string<date-time>

Ejemplo:

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

description · string

Ejemplo:

"Payment for order #12345"

metadata · object

Show child attributes

tags · string[]

Ejemplo:

["ecommerce", "subscription"]