Skip to main content
COB creates Pix payment payloads and tracks collection state.

​
Create a static BR Code

Use Create static BR Code when you need a reusable BR Code. The returned resource contains the encoded payment payload. Keep its identifier and use Get static BR Code or List static BR Codes to retrieve it later. A static BR Code is not a collection settlement record. Use a collection when you need to track a charge lifecycle.

​
Decode a QR Code

Decode QR Code reads an EMV payload. For an immediate charge, amountChangeAllowed is true when the receiver lets the payer change the amount: the amount is then only a suggestion. hasRecurrence is true when the QR Code also offers a Pix Automático recurrence, and recurrenceLocation carries its location. A recurrence-only QR Code decodes as STATIC with no key and no amount, and cannot be paid. To authorize the recurrence, send the same payload to Create authorization request from QR code. The optional paymentDate prices a due-date charge for that day, and budgetMs bounds the time the read of the receiver may take.

​
Create an immediate collection

  1. Call Create immediate collection with a new idempotency value.
  2. Save the collection identifier, BR Code payload, location, and expiration returned by the API.
  3. Read it through Get immediate collection or List immediate collections.
  4. With MOCK_TEST_ENDPOINTS_ENABLED=true, the mock provider can simulate a payment. Its callback records payment only when its amount matches the immediate collection amount. An identical callback is a safe replay. A callback with conflicting payment data is not a safe replay.
  5. If the charge must end without payment, use Cancel immediate collection. Cancelling an already cancelled collection returns the existing terminal result.

​
Create a due-date collection

A due-date collection requires the due-date calendar and debtor data. It can also carry value modifiers such as fine, interest, abatement, or discount.
  1. Call Create due-date collection. The plugin validates the Pix key before it creates the collection.
  2. Save the identifier and payment payload. Read it with Get due-date collection, or find it through List due-date collections.
  3. Apply only the documented due-date revision contract when a permitted value modifier must change. It uses JSON Merge Patch. Do not send a full replacement body by default.
  4. Cancel through Cancel due-date collection when the collection must no longer be payable.
The collection callback is internal to the plugin. Your client confirms payment by reading the public collection resource, not by posting a payment callback itself.

​
Avoid unsupported assumptions

This page covers static BR Codes and collections. For scheduled payments, see the scheduled-payment operations in the SPI API reference.