Endpoint to create a pix charge.
Request Fields Name Located in Description Mandatory Type apikey header API Key yes string x-timestamp header Date/time of the request (used to prevent replay attacks) yes string x-request-id header Random ID used to identify the request yes string x-hmac-signature header HMAC signature generated by combining the request parameters: Example: HMAC-SHA256(apikey + x-timestamp + requestBody + URL) yes string Authorization header Bearer token for authentication yes string (bearerToken) amount body Charge amount yes decimal pixKey body Account's Pix Key yes string returnQrCodeImage body Indicator that returns the qrCode image yes bool expiration body QRcode expiration time in seconds yes int payerDocument body Only for Bets. And when provided, the payment must be made using an account owned by the same document holder; otherwise, the payment will not be accepted no string additionalInfo body Additional information embedded in the QR Code. Max 5 items. no array
Request Example JSON
{
"expiration": 3600,
"amount": "18.92",
"returnQrCodeImage": false,
"additionalInfo": [
{
"name": "Title of information",
"value": "Content of information"
}
],
"pixKey": "b57c7b3c-976b-41f6-a5f6-7cccd86549bd",
"payerDocument": "36264164615"
}
Response Fields Field Type Additional Information txid string Transaction ID generated location string Located in of the generated QRCode qrCodeImage string Base64 image of the QRcode (Only when returnQrCodeImage = true is specified) status string Transaction status. See Transaction Statuses . amount decimal Transaction value pixCopyAndPaste string Copy and paste code from Pix pixKey string Pix key used for the transaction additionalInfo array Additional information
Response Example JSON
{
"txid": "ALzljVvS6DWp9ubnflS3nnCdeVBg7AxVt2p",
"location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002",
"qrCodeImage": null,
"status": "ATIVA",
"amount": 18.92,
"additionalInfo": [
{
"name": "Title of information",
"value": "Content of information"
}
],
"pixCopyAndPaste": "00020101021226830014BR.GOV.BCB.PIX2561api-h.rendimento.com.br/q/v2/aeafe31da3ef48c295e6353d703415da5204000053039865802BR5915Teste-automacao6009SAO PAULO61081125553262070503***6304BE8A",
"pixKey": "b57c7b3c-976b-41f6-a5f6-7cccd86549bd"
}
Endpoint to create a Pix charge with a due date. Supports interest, fines, discounts and deductions after/before the due date.
Request Fields Name Located in Description Mandatory Type apikey header API Key yes string x-timestamp header Date/time of the request (used to prevent replay attacks) yes string x-request-id header Random ID used to identify the request yes string x-hmac-signature header HMAC signature generated by combining the request parameters: Example: HMAC-SHA256(apikey + x-timestamp + requestBody + URL) yes string Authorization header Bearer token for authentication yes string (bearerToken) pixKey body Recipient's Pix key. yes string description body Charge description visible to the debtor. Max 140 characters. no string calendar body Calendar object containing due date and validity after due date. yes object calendar.dueDate body Due date of the charge. Must be a future date, max 3 years from today. yes DateTime (ISO 8601) calendar.validDaysAfterDueDate body Number of calendar days after due date that the QR Code remains active (charging interest and fines). Minimum 1. yes integer charge body Charge object containing amount and optional financial adjustments. yes object charge.amount body Original charge amount in BRL. Must be between R$ 0.01 and R$ 1,000,000,000.00. Max 2 decimal places. yes decimal charge.interest body Interest object applied after due date. no object charge.interest.modality body Interest modality (1–8). See Interest Modalities . no integer charge.interest.value body Interest value or percentage to apply after due date. Max 2 decimal places. no decimal charge.penalty body Penalty object applied after due date. no object charge.penalty.modality body Penalty modality: 1 = Fixed amount; 2 = Percentage. no integer charge.penalty.value body Penalty value or percentage to apply after due date. Max 2 decimal places. no decimal charge.discount body Discount object with modality, value and fixed dates when applicable. no object charge.discount.modality body Discount modality (1–6). See Discount Modalities . no integer charge.discount.value body Discount value or percentage. Required for modalities 3–6. Max 2 decimal places. no decimal charge.discount.fixedDate body List of fixed dates with discount values. Required for modalities 1 and 2. no array charge.discount.fixedDate.date body Deadline date for the discount. Cannot be after the due date. no DateTime (ISO 8601) charge.discount.fixedDate.value body Discount amount or percentage applied up to this date. Max 2 decimal places. no decimal charge.reduction body Reduction (deduction) object. no object charge.reduction.modality body Reduction (deduction) modality: 1 = Fixed amount; 2 = Percentage. no integer charge.reduction.value body Reduction value or percentage. Max 2 decimal places. no decimal debtor body Debtor object with identification and optional address fields. yes object debtor.name body Debtor's full name or company name. Max 200 characters. yes string debtor.document body Debtor's CPF (11 digits) or CNPJ (14 digits), without formatting. yes string debtor.address body Debtor's street address (optional). no string debtor.city body Debtor's city (optional). no string debtor.postalCode body Debtor's ZIP code, without formatting (optional). no string debtor.state body Debtor's state abbreviation (optional). no string additionalInfo body Additional information embedded in the QR Code. Max 5 items. no array additionalInfo.name body Label of the additional information. Max 50 characters. Required when the item is included. no string additionalInfo.value body Value of the additional information. Max 200 characters. Required when the item is included. no string
Request Example JSON
{
"pixKey": "b57c7b3c-976b-41f6-a5f6-7cccd86549bd",
"description": "Order #12345",
"calendar": {
"dueDate": "2026-03-31T00:00:00Z",
"validDaysAfterDueDate": 30
},
"charge": {
"amount": 150.00,
"interest": {
"modality": 2,
"value": 1.50
},
"penalty": {
"modality": 2,
"value": 2.20
},
"discount": {
"modality": 1,
"value": 10.00,
"fixedDate": [
{
"date": "2026-03-25T00:00:00Z",
"value": 10.00
}
]
},
"reduction": {
"modality": 1,
"value": 5.00
}
},
"debtor": {
"name": "João da Silva",
"document": "36264164615",
"address": "Rua das Flores, 100",
"city": "São Paulo",
"postalCode": "01310100",
"state": "SP"
},
"additionalInfo": [
{
"name": "Order reference",
"value": "ORD-2026-001"
}
]
}
Response Fields Field Type Additional Information txid string Transaction ID generated location string Located in of the generated QRCode qrCodeImage string Base64 image of the QRcode status string Transaction status. See Transaction Statuses . amount decimal Transaction value pixCopyAndPaste string Copy and paste code from Pix pixKey string Pix key used for the transaction additionalInfo array Additional information
Response Example JSON
{
"txid": "ALzljVvS6DWp9ubnflS3nnCdeVBg7AxVt2p",
"location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002",
"qrCodeImage": null,
"status": "ATIVA",
"amount": 150.00,
"additionalInfo": [
{
"name": "Title of information",
"value": "Content of information"
}
],
"pixCopyAndPaste": "00020101021226830014BR.GOV.BCB.PIX2561api-h.rendimento.com.br/q/v2/aeafe31da3ef48c295e6353d703415da5204000053039865802BR5915Teste-automacao6009SAO PAULO61081125553262070503***6304BE8A",
"pixKey": "b57c7b3c-976b-41f6-a5f6-7cccd86549bd"
}
Endpoint to create a static Pix QR Code (no expiration). Unlike immediate charges, a static QR Code can be paid multiple times and does not expire.
Request Fields Name Located in Description Mandatory Type apikey header API Key yes string x-timestamp header Date/time of the request (used to prevent replay attacks) yes string x-request-id header Random ID used to identify the request yes string x-hmac-signature header HMAC signature generated by combining the request parameters: Example: HMAC-SHA256( apikey + x-timestamp + requestBody + URL) yes string Authorization header Bearer token for authentication yes string (bearerToken) amount body Charge amount no decimal pixKey body Account's Pix Key yes string returnQrCodeImage body Indicator that returns the QR Code image yes bool description body Charge description. Only alphanumeric characters and spaces allowed. Max 41 characters. no string
Request Example JSON
{
"amount": 1000.00,
"pixKey": "468442e9-07e9-4c69-b7bf-1608313f288f",
"returnQrCodeImage": true,
"description": "Filial 2 Terminal 4"
}
Response Fields Field Type Description txid string Transaction ID. Alphanumeric, no spaces, max 25 characters. pixCopyAndPaste string Copy and paste code from Pix pixKey string Account's Pix Key qrCodeImage string Base64 image of the QR Code (null if returnQrCodeImage = false) amount decimal Charge amount status string QR Code status. See Static QR Code Statuses . description string Charge description. Only alphanumeric characters and spaces. Max 41 characters.
Response Example JSON
{
"txid": "01ARZ3NDEKTSV4RRFFQ69G5FA",
"pixCopyAndPaste": "00020101021226830014BR.GOV.BCB.PIX2561api-h.rendimento.com.br/q/v2/aeafe31da3ef48c295e6353d703415da5204000053039865802BR5915Teste-automacao6009SAO PAULO61081125553262070503***6304BE8A",
"pixKey": "b57c7b3c-976b-41f6-a5f6-7cccd86549bd",
"qrCodeImage": null,
"amount": 50.00,
"status": "Active",
"description": "Filial 2 Terminal 4"
}
Check immediate billing through a specific txid.
Request Fields Name Located in Description Mandatory Type apikey header API Key yes string x-timestamp header Date/time of the request (used to prevent replay attacks) yes string x-request-id header Random ID used to identify the request yes string x-hmac-signature header HMAC signature generated by combining the request parameters: Example: HMAC-SHA256( apikey + x-timestamp + requestBody + URL) yes string Authorization header Bearer token for authentication yes string (bearerToken) txid path Transaction Id yes string returnQrCodeImage query Indicator whether QrCode should be generated in base64 or not no boolean
Response Fields Field Type Description expiration integer QRcode expiration time in seconds amount decimal Charge amount additionalInfo array Additional information provided additionalInfo.name string Title of information additionalInfo.value string Content of information pixKey string Account's Pix Key txid string Transaction ID location string Location of the generated QRCode qrCodeImage string Base64 image of the QRcode (null if returnQrCodeImage=false) status string Transaction status. See Transaction Statuses . pixCopyAndPaste string Copy and paste code from Pix createdAt DateTime (ISO 8601) Date and time of creation pix array Array of payment confirmations pix.endToEndId string End to End of payment confirmation pix.amount decimal Payment amount pix.pixKey string Pix key used pix.confirmedAt DateTime (ISO 8601) Date and time of confirmation pix.reverses array Array of reversals/refunds pix.reverses.txid string Refund transaction ID pix.reverses.endToEndId string End to End of refund pix.reverses.amount decimal Refunded amount pix.reverses.confirmedAt DateTime (ISO 8601) Date and time of refund pix.reverses.status string Status of the refund. See Refund Statuses . holdSettlemet boolean Indicates if settlement is on hold inconsistencyReproval integer Inconsistency reproval code (can be null)
Response Example JSON
{
"expiration": 3600,
"amount": 18.92,
"additionalInfo": [
{
"name": "Title of information",
"value": "Content of information"
}
],
"pixKey": "b57c7b3c-976b-41f6-a5f6-7cccd86549bd",
"txid": "ALzljVvS6DWp9ubnflS3nnCdeVBg7AxVt2p",
"location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002",
"qrCodeImage": null,
"status": "ATIVA",
"pixCopyAndPaste": "00020101021226830014BR.GOV.BCB.PIX2561api-h.rendimento.com.br/q/v2/aeafe31da3ef48c295e6353d703415da5204000053039865802BR5915Teste-automacao6009SAO PAULO61081125553262070503***6304BE8A",
"createdAt": "2025-06-06T04:32:06.055Z",
"pix": [
{
"endToEndId": "EDARFlxoxT0zBhFBqEIC6c2QQCo2d54U",
"amount": 231.39,
"pixKey": "b57c7b3c-976b-41f6-a5f6-7cccd86549bd",
"confirmedAt": "2025-06-06T04:32:06.055Z",
"reverses": [
{
"txid": "DLzljVvS6DWp9ubnflS3nnCdeVBg7AxVt2h",
"endToEndId": "D12345678202009091000abcde123456",
"amount": 231.39,
"confirmedAt": "2025-06-06T04:32:06.055Z",
"status": "DEVOLVIDO"
}
]
}
],
"holdSettlemet": false,
"inconsistencyReproval": null
}
Retrieve a static QR code by its transaction ID.
Request Fields Name Located in Description Mandatory Type apikey header API Key yes string x-timestamp header Date/time of the request (used to prevent replay attacks) yes string x-request-id header Random ID used to identify the request yes string x-hmac-signature header HMAC signature generated by combining the request parameters: Example: HMAC-SHA256( apikey + x-timestamp + requestBody + URL) yes string Authorization header Bearer token used for authentication yes string (bearerToken) txid path Transaction ID. Alphanumeric, no spaces, max 25 characters. yes string returnQrCodeImage query Indicator whether QrCode should be generated in base64 or not no boolean
Response Fields Field Type Description txid string Transaction ID. Alphanumeric, no spaces, max 25 characters. pixCopyAndPaste string Copy and paste code from Pix pixKey string Account's Pix Key qrCodeImage string Base64 image of the QR Code (null if returnQrCodeImage = false) amount decimal Charge amount status string QR Code status. See Static QR Code Statuses . description string Charge description. Only alphanumeric characters and spaces. Max 41 characters.
Response Example JSON
{
"txid": "01ARZ3NDEKTSV4RRFFQ69G5FA",
"pixCopyAndPaste": "00020101021226830014BR.GOV.BCB.PIX2561api-h.rendimento.com.br/q/v2/aeafe31da3ef48c295e6353d703415da5204000053039865802BR5915Teste-automacao6009SAO PAULO61081125553262070503***6304BE8A",
"pixKey": "b57c7b3c-976b-41f6-a5f6-7cccd86549bd",
"qrCodeImage": null,
"amount": 50.00,
"status": "Active",
"description": "Filial 2 Terminal 4"
}
Cancel immediate charge.
Request Fields Name Located in Description Mandatory Type apikey header API Key yes string x-timestamp header Date/time of the request (used to prevent replay attacks) yes string x-request-id header Random ID used to identify the request yes string x-hmac-signature header HMAC signature generated by combining the request parameters: Example: HMAC-SHA256( apikey + x-timestamp + requestBody + URL) yes string Authorization header Bearer token for authentication yes string (bearerToken) txid path yes string
Cancel a static QR code.
Request Fields Name Located in Description Mandatory Type apikey header API Key yes string x-timestamp header Date/time of the request (used to prevent replay attacks) yes string x-request-id header Random ID used to identify the request yes string x-hmac-signature header HMAC signature generated by combining the request parameters: Example: HMAC-SHA256( apikey + x-timestamp + requestBody + URL) yes string Authorization header Bearer token used for authentication yes string (bearerToken) txid path Transaction ID. Alphanumeric, no spaces, max 25 characters. yes string
Check the list of immediate charges using parameters such as start, end, CPF, CNPJ and status.
Request Fields Name Located in Description Mandatory Type apikey header API Key yes string x-timestamp header Date/time of the request (used to prevent replay attacks) yes string x-request-id header Random ID used to identify the request yes string x-hmac-signature header HMAC signature generated by combining the request parameters: Example: HMAC-SHA256( apikey + x-timestamp + requestBody + URL) yes string Authorization header Bearer token used for authentication yes string (bearerToken) startDate query Start date to filter the query yes DateTime (ISO 8601) endDate query End date to filter the query yes DateTime (ISO 8601) pixKey query Account Pix Key no string documentNumber query CNPJ number no string status query Status of the transaction. See Transaction Statuses . no string pagination.currentPage query Current Page yes int pagination.pageSize query Page Size yes int
Response Fields Property Type Description results.txid string Pix charge unique identifier results.location string Payloads location results.qrCodeImage string Base64 of the QrCode image results.status string (enum) Status of the pix charge. See Transaction Statuses . results.amount decimal Amount of the pix charge (BRL) results.pixCopyAndPaste string Copy and paste code results.pixKey string Internal pix key of the account results.expiration int Lifetime of the pix charge before expiration, specified in seconds results.createdAt DateTime (ISO 8601) Date and time of creation results.pix.confirmedAt DateTime (ISO 8601) Date and time of confirmation results.pix.endToEndId string Unique end to end id for the pix charge results.pix.amount decimal Amount of the payment (BRL) results.pix.pixKey string Pix key of the receiver pix.inconsistencyReproval enum In case of reproval by the inconsistency prevention engine, this field will be populated with the following value: 1 - Inconsistency results.pix.reverses.txid string Refunds unique identifier results.pix.reverses.endToEndId string Unique end to end id for the refund results.pix.reverses.amount decimal Refunded amount (BRL) results.pix.reverses.confirmedAt DateTime (ISO 8601) Date and time of refund results.pix.reverses.status string Status of the refund. See Refund Statuses . pagination.currentPage int Current page retrieved pagination.pageSize int Current page size pagination.totalPages int Total pages to be retrieved pagination.totalItems int Total items to be retrieved criteria.startDate DateTime (ISO 8601) Filter transactions after this date and time criteria.endDate DateTime (ISO 8601) Filter transactions before this date and time criteria.pixKey string Pix key of the account criteria.documentNumber string Document number of the account criteria.status string Status of the transaction. See Transaction Statuses .
Response Example JSON
{
"criteria": {
"startDate": "2020-04-01T00:00:00Z",
"endDate": "2020-04-01T17:00:00Z",
"pixKey": "b57c7b3c-976b-41f6-a5f6-7cccd86549bd",
"documentNumber": "27574383000168",
"status": "ATIVA"
},
"results": [
{
"expiration": 3600,
"amount": 18.92,
"additionalInfo": [
{
"name": "Title of information",
"value": "Content of information"
}
],
"pixKey": "b57c7b3c-976b-41f6-a5f6-7cccd86549bd",
"txid": "ALzljVvS6DWp9ubnflS3nnCdeVBg7AxVt2p",
"location": "pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002",
"qrCodeImage": null,
"status": "ATIVA",
"pixCopyAndPaste": "00020101021226830014BR.GOV.BCB.PIX2561api-h.rendimento.com.br/q/v2/aeafe31da3ef48c295e6353d703415da5204000053039865802BR5915Teste-automacao6009SAO PAULO61081125553262070503***6304BE8A",
"createdAt": "2025-06-06T04:35:23.707Z",
"pix": [
{
"endToEndId": "EDARFlxoxT0zBhFBqEIC6c2QQCo2d54U",
"amount": 231.39,
"pixKey": "b57c7b3c-976b-41f6-a5f6-7cccd86549bd",
"confirmedAt": "2025-06-06T04:35:23.707Z",
"reverses": [
{
"txid": "DLzljVvS6DWp9ubnflS3nnCdeVBg7AxVt2h",
"endToEndId": "D12345678202009091000abcde123456",
"amount": 231.39,
"confirmedAt": "2025-06-06T04:35:23.707Z",
"status": "DEVOLVIDO"
}
]
}
],
"holdSettlemet": false,
"inconsistencyReproval": null
}
],
"pagination": {
"currentPage": 1,
"pageSize": 1,
"totalPages": 1,
"totalItems": 1
}
}
Request a refund.
Request Fields Name Located in Description Mandatory Type apikey header API Key yes string x-timestamp header Date/time of the request (used to prevent replay attacks) yes string x-request-id header Random ID used to identify the request yes string x-hmac-signature header HMAC signature generated by combining the request parameters: Example: HMAC-SHA256( apikey + x-timestamp + requestBody + URL) yes string Authorization header Bearer token used for authentication yes string (bearerToken) endToEndId path End to end transaction code yes string txid path Transaction Id yes string amount body Transaction amount yes decimal
Request Example
Response Fields Field Type Description txid string Refund transaction ID endToEndId string End to End transaction code amount decimal Refunded amount confirmedAt DateTime (ISO 8601) Date and time of refund processing status string Status of the refund. See Refund Statuses .
Response Example JSON
{
"txid": "DLzljVvS6DWp9ubnflS3nnCdeVBg7AxVt2h",
"endToEndId": "D12345678202009091000abcde123456",
"amount": 231.39,
"confirmedAt": "2025-06-06T04:37:07.173Z",
"status": "EM_PROCESSAMENTO"
}
Check return using a Pix End To End ID and return ID.
Request Fields Name Located in Description Mandatory Type apikey header API Key yes string x-timestamp header Date/time of the request (used to prevent replay attacks) yes string x-request-id header Random ID used to identify the request yes string x-hmac-signature header HMAC signature generated by combining the request parameters: Example: HMAC-SHA256( apikey + x-timestamp + requestBody + URL) yes string Authorization header Bearer token used for authentication yes string (bearerToken) endToEndId path Payment End To End Code yes string txid path Transaction Id yes string
Response Fields Field Type Description txid string Refund transaction ID endToEndId string End to End transaction code amount string Refunded amount confirmedAt DateTime (ISO 8601) Date and time of refund completion status string Status of the refund. See Refund Statuses .
Response Example JSON
{
"txid": "DLzljVvS6DWp9ubnflS3nnCdeVBg7AxVt2h",
"endToEndId": "D12345678202009091000abcde123456",
"amount": "231.39",
"confirmedAt": "2025-06-06T04:40:25.725Z",
"status": "DEVOLVIDO"
}
Block the pix charge settlement until it's unblocked.
Request Fields Name Located in Description Mandatory Type apikey header API Key yes string x-timestamp header Date/time of the request (used to prevent replay attacks) yes string x-request-id header Random ID used to identify the request yes string x-hmac-signature header HMAC signature generated by combining the request parameters: Example: HMAC-SHA256( apikey + x-timestamp + requestBody + URL) yes string Authorization header Bearer token used for authentication yes string txid path Charge unique identifier yes string
Allows the pix charge to be settled in the next settlement window.
Request Fields Name Located in Description Mandatory Type apikey header API Key yes string x-timestamp header Date/time of the request (used to prevent replay attacks) yes string x-request-id header Random ID used to identify the request yes string x-hmac-signature header HMAC signature generated by combining the request parameters: Example: HMAC-SHA256( apikey + x-timestamp + requestBody + URL) yes string Authorization header Bearer token used for authentication yes string txid path Charge unique identifier yes string
List all payments (confirmed Pix receipts) associated with a given transaction ID, with optional date range filtering and pagination.
Request Fields Name Located in Description Mandatory Type apikey header API Key yes string x-timestamp header Date/time of the request (used to prevent replay attacks) yes string x-request-id header Random ID used to identify the request yes string x-hmac-signature header HMAC signature generated by combining the request parameters: Example: HMAC-SHA256( apikey + x-timestamp + requestBody + URL) yes string Authorization header Bearer token used for authentication yes string (bearerToken) txid path Transaction unique identifier. Max 25 characters. yes string startDate query Start date to filter the query no DateTime (ISO 8601) endDate query End date to filter the query no DateTime (ISO 8601) pagination.currentPage query Current page yes int pagination.pageSize query Page size yes int
Response Fields Property Type Description criteria.txid string Transaction ID used as filter criteria.startDate DateTime (ISO 8601) Filter payments after this date and time criteria.endDate DateTime (ISO 8601) Filter payments before this date and time pix array List of payment confirmations pix.endToEndId string End to End of payment confirmation pix.amount decimal Payment amount (BRL) pix.pixKey string Account Pix key pix.confirmedAt DateTime (ISO 8601) Date and time of confirmation pix.reverses array List of reversals/refunds associated with the payment pix.reverses.txid string Refund transaction ID pix.reverses.endToEndId string End to End of refund pix.reverses.amount decimal Refunded amount (BRL) pix.reverses.confirmedAt DateTime (ISO 8601) Date and time of refund pix.reverses.status string Status of the refund. See Refund Statuses . pagination.currentPage int Current page retrieved pagination.pageSize int Current page size pagination.totalPages int Total pages to be retrieved pagination.totalItems int Total items to be retrieved
Response Example JSON
{
"criteria": {
"txid": "01ARZ3NDEKTSV4RRFFQ69G5FA",
"startDate": "2020-04-01T00:00:00Z",
"endDate": "2020-04-01T17:00:00Z"
},
"pix": [
{
"endToEndId": "EDARFlxoxT0zBhFBqEIC6c2QQCo2d54U",
"amount": 231.39,
"pixKey": "b57c7b3c-976b-41f6-a5f6-7cccd86549bd",
"confirmedAt": "2025-06-06T04:35:23.707Z",
"reverses": [
{
"txid": "DLzljVvS6DWp9ubnflS3nnCdeVBg7AxVt2h",
"endToEndId": "D12345678202009091000abcde123456",
"amount": 231.39,
"confirmedAt": "2025-06-06T04:35:23.707Z",
"status": "DEVOLVIDO"
}
]
}
],
"pagination": {
"currentPage": 1,
"pageSize": 1,
"totalPages": 1,
"totalItems": 1
}
}
Request Fields Name Located in Description Mandatory Type apikey header API Key yes string x-timestamp header Date/time of the request (used to prevent replay attacks) yes string x-request-id header Random ID used to identify the request yes string x-hmac-signature header HMAC signature generated by combining the request parameters: Example: HMAC-SHA256( apikey + x-timestamp + requestBody + URL) yes string Authorization header Bearer token used for authentication yes string (bearerToken) startDate query Start date to filter the query yes DateTime (ISO 8601) endDate query End date to filter the query yes DateTime (ISO 8601) pixKey query Account Pix Key no string documentNumber query CNPJ number no string status query Status of the transaction. See Transaction Statuses . no string pagination.currentPage query Current Page yes int pagination.pageSize query Page Size yes int
Response Fields Property Type Description criteria.startDate DateTime (ISO 8601) Filter transactions after this date and time criteria.endDate DateTime (ISO 8601) Filter transactions before this date and time criteria.pixKey string Pix key informed in request criteria criteria.documentNumber string Document number of the account criteria.status string Status of the transaction. See Transaction Statuses . results array List of due date charges results.status string Status of the charge. See Transaction Statuses . results.createdAt DateTime (ISO 8601) Date and time of creation results.txid string Unique transaction identifier results.pixKey string Account pix key used in the charge results.pixCopyAndPaste string Pix copy and paste payload results.pix array List of payment confirmations (can be null) results.pix.endToEndId string End to End of payment confirmation results.pix.amount decimal Payment amount results.pix.pixKey string Pix key used results.pix.confirmedAt Date (yyyy-MM-dd) Date of confirmation results.pix.discount decimal Discount applied to the payment results.pix.reduction decimal Reduction applied to the payment results.pix.penalty decimal Penalty applied to the payment results.pix.interest decimal Interest applied to the payment results.pix.reverses array Array of reversals/refunds results.pix.reverses.txid string Refund transaction ID results.pix.reverses.endToEndId string End to End of refund results.pix.reverses.amount decimal Refunded amount results.pix.reverses.confirmedAt Date (yyyy-MM-dd) Date of refund results.pix.reverses.status string Status of the refund. See Refund Statuses . results.additionalInfo array Additional information attached to the charge results.additionalInfo.name string Additional information label results.additionalInfo.value string Additional information value results.holdSettlemet boolean Indicates if settlement is on hold results.inconsistencyReproval integer Inconsistency reproval code (can be null) results.calendar object Due date calendar information results.calendar.dueDate Date (yyyy-MM-dd) Charge due date results.calendar.validDaysAfterDueDate integer Valid days after due date results.charge object Charge financial data results.charge.amount decimal Original charge amount results.charge.interest object Interest settings results.charge.interest.modality integer Interest modality. See Interest Modalities . results.charge.interest.value decimal Interest value results.charge.reduction object Reduction settings results.charge.reduction.modality integer Reduction modality results.charge.reduction.value decimal Reduction value results.charge.penalty object Penalty settings results.charge.penalty.modality integer Penalty modality results.charge.penalty.value decimal Penalty value results.charge.discount object Discount settings results.charge.discount.modality integer Discount modality. See Discount Modalities . results.charge.discount.value decimal Discount value results.charge.discount.fixedDate array Fixed discount dates results.charge.discount.fixedDate.date Date (yyyy-MM-dd) Deadline date for discount results.charge.discount.fixedDate.value decimal Discount value applied for the fixed date results.debtor object Debtor data results.debtor.name string Debtor full name results.debtor.document string Debtor document (CPF/CNPJ) results.debtor.address string Debtor address results.debtor.city string Debtor city results.debtor.postalCode string Debtor postal code results.debtor.state string Debtor state results.location string Charge location extracted from the Pix payload pagination.currentPage int Current page retrieved pagination.pageSize int Current page size pagination.totalPages int Total pages to be retrieved pagination.totalItems int Total items to be retrieved
Response Example JSON
{
"criteria": {
"startDate": "2026-03-01T00:00:00.000-03:00",
"endDate": "2026-03-30",
"pixKey": null,
"documentNumber": null,
"status": null
},
"results": [
{
"status": "REMOVIDA_PELO_USUARIO_RECEBEDOR",
"createdAt": "2026-03-18T16:10:14.975-03:00",
"txid": "9a73b1d964b34f3c982412280dda5df5",
"pixKey": "4957049f-133f-444a-839b-bb4883f81bf7",
"pixCopyAndPaste": "00020101021226880014BR.GOV.BCB.PIX2566api-h.rendimento.com.br/q/v2/cobv/09867eb9c5d543fd8a642d310a0292e65204000053039865802BR5925PORTO NOVO COMERCIO DE MO6009SAO PAULO61081125553262070503***630462DE",
"pix": [
{
"endToEndId": "E1234567820260318161014abcdef1234",
"amount": 250.0,
"pixKey": "4957049f-133f-444a-839b-bb4883f81bf7",
"confirmedAt": "2026-03-18",
"discount": 20.0,
"reduction": 1.75,
"penalty": 2.0,
"interest": 20.0,
"reverses": [
{
"txid": "DLzljVvS6DWp9ubnflS3nnCdeVBg7AxVt2h",
"endToEndId": "D12345678202009091000abcde123456",
"amount": 231.39,
"confirmedAt": "2026-03-18T16:10:14.975-03:00",
"status": "DEVOLVIDO"
}
]
}
],
"additionalInfo": [
{
"name": "Recebedor",
"value": "PORTO NOVO COMERCIO DE MOVEIS LTDA"
},
{
"name": "Sabor do pastel",
"value": "Berinjela"
}
],
"holdSettlemet": false,
"inconsistencyReproval": 4,
"calendar": {
"dueDate": "2026-04-01",
"validDaysAfterDueDate": 15
},
"charge": {
"amount": 250.0,
"interest": {
"modality": 1,
"value": 20.0
},
"reduction": {
"modality": 2,
"value": 1.75
},
"penalty": {
"modality": 2,
"value": 2.0
},
"discount": {
"modality": 1,
"value": 2.0,
"fixedDate": [
{
"date": "2026-03-22",
"value": 20.0
},
{
"date": "2026-03-20",
"value": 30.0
}
]
}
},
"debtor": {
"name": "Lindomar Lindo",
"document": "38958998000104",
"address": "Alameda das Raposas, 1250",
"city": "São Paulo",
"postalCode": "01310100",
"state": "SP"
},
"location": "api-h.rendimento.com.br/q/v2/cobv/09867eb9c5d543fd8a642d310a0292e6"
}
],
"pagination": {
"currentPage": 1,
"pageSize": 20,
"totalPages": 1,
"totalItems": 1
}
}
Request Fields Name Located in Description Mandatory Type apikey header API Key yes string x-timestamp header Date/time of the request (used to prevent replay attacks) yes string x-request-id header Random ID used to identify the request yes string x-hmac-signature header HMAC signature generated by combining the request parameters: Example: HMAC-SHA256( apikey + x-timestamp + requestBody + URL) yes string Authorization header Bearer token used for authentication yes string (bearerToken) txid path Charge identifier. Alphanumeric only, with 26 to 35 characters. yes string returnQrCodeImage query Indicates whether the QR Code image should be returned in base64 format. no boolean
Response Fields Property Type Description status string Status of the charge. See Transaction Statuses . createdAt DateTime (ISO 8601) Date and time of creation txid string Unique transaction identifier qrCodeImage string Base64 image of the QR Code (null when not requested) pixKey string Account pix key used in the charge pixCopyAndPaste string Pix copy and paste payload pix array List of payment confirmations (can be null) pix.endToEndId string End to End of payment confirmation pix.amount decimal Payment amount pix.pixKey string Pix key used pix.confirmedAt DateTime (ISO 8601) Date and time of confirmation pix.reverses array Array of reversals/refunds pix.reverses.txid string Refund transaction ID pix.reverses.endToEndId string End to End of refund pix.reverses.amount decimal Refunded amount pix.reverses.confirmedAt DateTime (ISO 8601) Date and time of refund pix.reverses.status string Status of the refund. See Refund Statuses . pix.discount decimal Discount applied to the payment pix.reduction decimal Reduction applied to the payment pix.penalty decimal Penalty applied to the payment pix.interest decimal Interest applied to the payment additionalInfo array Additional information attached to the charge additionalInfo.name string Additional information label additionalInfo.value string Additional information value holdSettlemet boolean Indicates if settlement is on hold inconsistencyReproval integer Inconsistency reproval code (can be null) calendar object Due date calendar information calendar.dueDate Date (yyyy-MM-dd) Charge due date calendar.validDaysAfterDueDate integer Valid days after due date charge object Charge financial data charge.amount decimal Original charge amount charge.interest object Interest settings charge.interest.modality integer Interest modality. See Interest Modalities . charge.interest.value decimal Interest value charge.reduction object Reduction settings charge.reduction.modality integer Reduction modality charge.reduction.value decimal Reduction value charge.penalty object Penalty settings charge.penalty.modality integer Penalty modality charge.penalty.value decimal Penalty value charge.discount object Discount settings charge.discount.modality integer Discount modality. See Discount Modalities . charge.discount.value decimal Discount value charge.discount.fixedDate array Fixed discount dates charge.discount.fixedDate.date Date (yyyy-MM-dd) Deadline date for discount charge.discount.fixedDate.value decimal Discount value applied for the fixed date debtor object Debtor data debtor.name string Debtor full name debtor.document string Debtor document (CPF/CNPJ) debtor.address string Debtor address debtor.city string Debtor city debtor.postalCode string Debtor postal code debtor.state string Debtor state location string Charge location extracted from the Pix payload
Response Example JSON
{
"status": "REMOVIDA_PELO_USUARIO_RECEBEDOR",
"createdAt": "2026-03-18T16:10:14.975-03:00",
"txid": "9a73b1d964b34f3c982412280dda5df5",
"qrCodeImage": null,
"pixKey": "4957049f-133f-444a-839b-bb4883f81bf7",
"pixCopyAndPaste": "00020101021226880014BR.GOV.BCB.PIX2566api-h.rendimento.com.br/q/v2/cobv/09867eb9c5d543fd8a642d310a0292e65204000053039865802BR5925PORTO NOVO COMERCIO DE MO6009SAO PAULO61081125553262070503***630462DE",
"pix": [
{
"endToEndId": "E1234567820260318161014abcdef1234",
"amount": 250.0,
"pixKey": "4957049f-133f-444a-839b-bb4883f81bf7",
"confirmedAt": "2026-03-18T16:12:01.000-03:00",
"discount": 20.0,
"reduction": 1.75,
"penalty": 2.0,
"interest": 20.0,
"reverses": [
{
"txid": "DLzljVvS6DWp9ubnflS3nnCdeVBg7AxVt2h",
"endToEndId": "D12345678202003181610abcde123456",
"amount": 50.0,
"confirmedAt": "2026-03-18T16:12:01.000-03:00",
"status": "COMPLETED"
}
]
}
],
"additionalInfo": [
{
"name": "Recebedor",
"value": "PORTO NOVO COMERCIO DE MOVEIS LTDA"
},
{
"name": "Sabor do pastel",
"value": "Berinjela"
}
],
"holdSettlemet": false,
"inconsistencyReproval": 4,
"calendar": {
"dueDate": "2026-04-01",
"validDaysAfterDueDate": 15
},
"charge": {
"amount": 250.0,
"interest": {
"modality": 1,
"value": 20.0
},
"reduction": {
"modality": 2,
"value": 1.75
},
"penalty": {
"modality": 2,
"value": 2.0
},
"discount": {
"modality": 1,
"value": 2.0,
"fixedDate": [
{
"date": "2026-03-22",
"value": 20.0
},
{
"date": "2026-03-20",
"value": 30.0
}
]
}
},
"debtor": {
"name": "Lindomar Lindo",
"document": "38958998000104",
"address": "Alameda das Raposas, 1250",
"city": "São Paulo",
"postalCode": "01310100",
"state": "SP"
},
"location": "api-h.rendimento.com.br/q/v2/cobv/09867eb9c5d543fd8a642d310a0292e6"
}
Simulates the payment of a pix charge in the sandbox environment.
Request Fields Name Located in Description Mandatory Type apikey header API Key yes string x-timestamp header Date/time of the request (used to prevent replay attacks) yes string x-request-id header Random ID used to identify the request yes string x-hmac-signature header HMAC signature generated by combining the request parameters: Example: HMAC-SHA256( apikey + x-timestamp + requestBody + URL) yes string Authorization header Bearer token for authentication yes string (bearerToken) qrCode body Pix charge copy and paste code (QRCode) yes string amount body Amount to be paid. Used in QR Code static. no decimal Parameters body Payer Document specific no object
Request Example JSON
{
"qrCode": "00020101021226830014BR.GOV.BCB.PIX2561api-h.rendimento.com.br/q/v2/28d1eeb09673415ea5ad1c3c2793fbc45204000053039865802BR5914QRCOeAccount6009SAO PAULO61081125553262070503***6304AE83",
"amount": 250.0,
"Parameters": {
"PayerName":"PayerName",
"PayerAgency":"0000",
"PayerAccountNumber":"0000",
"PayerDocument":"24659620000",
"AccountStatus":"1",
"PendingTransaction":"false",
"CurrentBalance":"0"
}
}
Transaction Statuses Value Description ATIVA PENDING CONCLUIDA CONFIRMED REMOVIDA_PELO_USUARIO_RECEBEDOR CANCELLED REMOVIDA_PELO_PSP CANCELLED
Static QR Code Statuses Value Code Active 1 Inactive 0
Refund Statuses Value Description DEVOLVIDO Refunded NAO_REALIZADO Not Completed EM_PROCESSAMENTO Processing
Interest Modalities Value Description 1 Fixed amount (calendar days) 2 Percentage per day (calendar days) 3 Percentage per month (calendar days) 4 Percentage per year (calendar days) 5 Fixed amount (business days) 6 Percentage per day (business days) 7 Percentage per month (business days) 8 Percentage per year (business days)
Discount Modalities Value Description 1 Fixed amount up to the specified date 2 Percentage up to the specified date 3 Fixed amount per calendar day in advance 4 Fixed amount per business day in advance 5 Percentage per calendar day in advance 6 Percentage per business day in advance
Error Codes Error Description 96 The settlement schedule date is less than the current date 153 The account for this pix key is not active 157 This charge does not have a fee amount 158 Account not found 167 Account suspended for billing processing 193 The charge cannot be null or negative 259 The split value cannot be negative.
