{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-receivables/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Issuing Pix charges","description":"Start today using our public API to power your next project."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"issuing-pix-charges"},"children":["Issuing Pix charges"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a Pix charge your customer pays with a QR code, send it, and follow it until it is paid."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-a-pix-charge-is"},"children":["What a Pix charge is"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A Pix charge is a single-use, dynamic Pix QR code for a fixed amount. It can be paid once, and only for exactly that amount. The money lands in your Jeeves BRL account instantly, 24/7."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There is no boleto behind it, so it never shows up in your customer's DDA. To collect with a boleto instead, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/receivables/issuing-boletos"},"children":["Issuing boletos"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create-a-charge"},"children":["Create a charge"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/pix-charges"]}," (scope ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pix_charges:write"]},") returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["201"]}," with the charge. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payerData"]}," are required."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \\\n  'https://public-sandbox.tryjeeves.com/v1/pix-charges' \\\n  -H \"Authorization: Bearer $JEEVES_ACCESS_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"amount\": 150.75,\n    \"memo\": \"Payment for services\",\n    \"externalId\": \"INV-789\",\n    \"payerData\": {\n      \"name\": \"Global Tech\",\n      \"personType\": \"legal\",\n      \"documentNumber\": \"12345678000195\"\n    },\n    \"metadata\": { \"internalReference\": \"INV-789\" }\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Required. In BRL, positive, at most 2 decimal places."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payerData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Required. Your customer: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," (1 to 100 characters), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["personType"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["natural"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["legal"]},") and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["documentNumber"]},", a CPF (11 digits) or a CNPJ (14 digits), digits only."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dueDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Optional. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YYYY-MM-DD"]},", from today to 365 days from today. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#due-date-and-payable-period"},"children":["Due date and payable period"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["daysPayableAfterDue"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Optional. How many days the QR stays payable after ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dueDate"]},", from 0 to 180. Only with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dueDate"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["memo"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Optional. A note for the payer, up to 140 characters, shown with the charge."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Optional. Your own reference, up to 64 characters, unique per organization. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#retry-safely-with-externalid"},"children":["Retry safely with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]}]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Optional. Your own key-value reference data, with string values."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response is the charge:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"4c2fa514-a44d-40f2-8d57-c0caf1b9165a\",\n  \"status\": \"active\",\n  \"externalId\": \"INV-789\",\n  \"metadata\": { \"internalReference\": \"INV-789\" },\n  \"amount\": 150.75,\n  \"dueDate\": \"2027-01-10\",\n  \"daysPayableAfterDue\": 0,\n  \"payableUntil\": \"2027-01-10\",\n  \"memo\": \"Payment for services\",\n  \"payerData\": {\n    \"name\": \"Global Tech\",\n    \"personType\": \"legal\",\n    \"documentNumber\": \"12345678000195\"\n  },\n  \"pixCopyPaste\": \"00020126580014br.gov.bcb.pix0136123e4567-e89b-12d3-a456-426614174000520400005303986540515.075802BR5912Your Company6009SAO PAULO62070503***6304ABCD\",\n  \"qrCodeImage\": \"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBD...\",\n  \"createdAt\": \"2026-01-10T14:00:00Z\",\n  \"updatedAt\": \"2026-01-10T14:00:00Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"send-it-to-your-customer"},"children":["Send it to your customer"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Jeeves does not deliver the charge. Share it through your own channel: email, WhatsApp or your app."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["qrCodeImage"]}," is a base64-encoded image of the QR code. Show it, or attach it as an image."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pixCopyPaste"]}," is the copy-and-paste code. Your customer pastes it into their bank app."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"due-date-and-payable-period"},"children":["Due date and payable period"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Read this before you set a due date."]}," The charge is payable until ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payableUntil"]},", and that depends on whether you send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dueDate"]},"."]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Without ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dueDate"]}]},", the charge is due 365 days from today (Brasília time) and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["daysPayableAfterDue"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["With ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dueDate"]}]}," (from today to 365 days from today), the QR stays payable for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["daysPayableAfterDue"]}," days after it: from 0 to 180, 180 by default."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payableUntil"]}]}," in the response is the last payable day, until the end of that day in Brasília time. The response always carries the effective ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dueDate"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["daysPayableAfterDue"]},", including the defaults."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["daysPayableAfterDue"]}," can only be sent together with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dueDate"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"track-it-until-its-final"},"children":["Track it until it's final"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There are no webhooks for Pix charges yet. Poll the charge until it reaches a final status, or list charges and filter them:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl 'https://public-sandbox.tryjeeves.com/v1/pix-charges/4c2fa514-a44d-40f2-8d57-c0caf1b9165a' \\\n  -H \"Authorization: Bearer $JEEVES_ACCESS_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl 'https://public-sandbox.tryjeeves.com/v1/pix-charges?externalId=INV-789&page=1&pageSize=20' \\\n  -H \"Authorization: Bearer $JEEVES_ACCESS_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/pix-charges"]}," (scope ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pix_charges:read"]},") filters by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdAt[gte]"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdAt[lte]"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]},", and paginates with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The charge can be paid. Only active charges can be canceled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["under_review"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The payer paid, but the bank is holding the funds for a manual review (rare). If the review is rejected, the charge returns to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Paid, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentDetails"]}," is filled in. Final."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["canceled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["You canceled it. Final."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Not paid by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payableUntil"]},". Final. It can be set 1 to 3 days after ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payableUntil"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"cancel"},"children":["Cancel"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/pix-charges/{id}/cancel"]}," (scope ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pix_charges:write"]},") returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," with the charge. It returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["409"]}," if the charge isn't ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \\\n  'https://public-sandbox.tryjeeves.com/v1/pix-charges/4c2fa514-a44d-40f2-8d57-c0caf1b9165a/cancel' \\\n  -H \"Authorization: Bearer $JEEVES_ACCESS_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A charge can't be changed after it is created. To change the amount or the dates, cancel it and create a new one."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"retry-safely-with-externalid"},"children":["Retry safely with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]}," is unique per organization. Create the charge with your own reference, and a retried request never creates a second charge: reusing an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]}," returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["409"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errorData.chargeId"]}," is the ID of the charge that already exists."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"message\": \"The externalId is already used by another charge.\",\n  \"statusCode\": 409,\n  \"errorData\": { \"chargeId\": \"4c2fa514-a44d-40f2-8d57-c0caf1b9165a\" }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"errors"},"children":["Errors"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"HTTP"},"children":["HTTP"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"When"},"children":["When"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"What to do"},"children":["What to do"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The request body is malformed."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Fix the request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["409"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]}," is already used, or you canceled a charge that isn't ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["For a duplicate ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]},", fetch the existing charge with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errorData.chargeId"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["422"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The account can't receive Pix charges yet: it has no Pix key."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Contact Jeeves support."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["502"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The Pix provider failed."]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Retry with the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Full schemas and every error: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis#tag/Pix-Charges"},"children":["Pix Charges in the API reference"]},"."]}]},"headings":[{"value":"Issuing Pix charges","id":"issuing-pix-charges","depth":1},{"value":"What a Pix charge is","id":"what-a-pix-charge-is","depth":2},{"value":"Create a charge","id":"create-a-charge","depth":2},{"value":"Send it to your customer","id":"send-it-to-your-customer","depth":2},{"value":"Due date and payable period","id":"due-date-and-payable-period","depth":2},{"value":"Track it until it's final","id":"track-it-until-its-final","depth":2},{"value":"Cancel","id":"cancel","depth":2},{"value":"Retry safely with externalId","id":"retry-safely-with-externalid","depth":2},{"value":"Errors","id":"errors","depth":2}],"frontmatter":{"seo":{"title":"Issuing Pix charges"}},"lastModified":"2026-11-02T14:48:40.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/receivables/issuing-pix-charges","userData":{"isAuthenticated":false,"teams":["anonymous"]}}