{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-apis/index.yaml","sidebar":"sidebar-sidebar.yaml__apis"},"props":{"definitionId":"apis/index.yaml","dynamicMarkdocComponents":[],"baseSlug":"/apis","seo":{"title":"Pix Charges","description":"The Pix Charges API lets clients create dynamic Pix charges: a single-use Pix QR code that the payer can scan or paste into their banking app. Each charge carries `pixCopyPaste` (the copy-and-paste payload) and `qrCodeImage` (a base64-encoded JPEG of the QR code).\n\nCharges are not pushed to you: poll `GET /v1/pix-charges/{id}` to follow a charge until it reaches a final status.\n\nA charge has one of these statuses:\n\n| Status | Meaning |\n|:-------|:--------|\n| `active` | The charge can be paid. Only active charges can be canceled. |\n| `under_review` | The charge is under review. |\n| `paid` | The charge was paid. `paymentDetails` is present. Final status. |\n| `canceled` | The charge was canceled with `POST /v1/pix-charges/{id}/cancel`. Final status. |\n| `expired` | The charge was not paid before `payableUntil`. Final status. It can be set 1 to 3 days after `payableUntil`, not right at the end of that day. |\n\n**Due date and payable period.** Without `dueDate`, the charge is due 365 days from today (Brasilia time) and `daysPayableAfterDue` is 0. `daysPayableAfterDue` can only be sent together with `dueDate`; when `dueDate` is sent without it, it defaults to 180. The response always carries the effective `dueDate` and `daysPayableAfterDue`, and `payableUntil`, the last day the QR code can be paid.\n\n**Your own reference.** `externalId` is unique per organization. Reusing one returns a `409` whose `errorData.chargeId` is the id of the existing charge."},"itemId":"pix-charges","disableAutoScroll":true,"metadata":{},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"headers":{"accept":"*/*","accept-encoding":"br,gzip","host":"tryjeeves.redocly.app","user-agent":"Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)","via":"2.0 Caddy, 2.0 ea9784182c7536f5ce15ec71cf0089d6.cloudfront.net (CloudFront), 1.1 Caddy","x-amz-cf-id":"VwGErrfmxpJhx85qljHfdbtCW4jqoW9tBIzZ5iMYV84DEJ2vIPPqvg==","x-forwarded-for":"216.73.216.25, 54.156.60.142, 64.252.67.48","x-forwarded-host":"tryjeeves.redocly.app","x-forwarded-proto":"https","x-redocly-prefers-markdown":"0","x-request-id":"cds-3690cf1f-db79-4752-9982-5f0ad801205d"},"remoteAddr":{"hostname":"::ffff:10.0.3.209","port":35036},"lang":"en"}},"pagePropGetterError":{"message":"","name":""}},"slug":"/apis/pix-charges","userData":{"isAuthenticated":false,"teams":["anonymous"]}}