> ## Documentation Index > Fetch the complete documentation index at: https://docs.wepayout.co/llms.txt > Use this file to discover all available pages before exploring further. # Get Unique Charge > Get details of a specific charge by ID # Get Unique Charge Get details of a specific charge by ID. ## Path Parameters The charge ID to retrieve. Example: `32457` ## Response Returns a single charge object with all details. WEpayment's auto generated id, use this id to perform conciliation or perform queries via API / Dashboard. Merchant object. Id of the WE account that created the payin. Name of the WE account that created the payin. WEpayments auto generated hash, use this hash to send your user to the payment page. The WEpayments payment page is the place where you will redirect the end customer to pay the bill. The bank identification number. Your identification number. The url where we will submit the callbacks. Payment method that will be used in payin. Values: `pix`, `boleto` Currency object. Currency id. Currency name. Currency code (ISO 4217). Currency symbol. The payin total amount in cents. The total amount of the payin paid. Amount refunded from this charge. Only pix payment\_method. Instructions that will be displayed to the user. The person you are charging object. The buyer name. Buyer's email. The buyer document object. Document type (CPF, CNPJ). Document number. The buyer's address object. Country code. City name. Street name. Street number. Address complement. ZIP/Postal code. District/Neighborhood. State code. Final Beneficiary object. The final beneficiary name to appear in the payin. The tax ID to appear in the charge. Website, e-mail address or other customer channel to appear in the payin. Pix QRCode specific instructions object (when payment\_method is pix). Expiration date in format YYYY-MM-DDTHH:MM:SS. Type of refund mode. QRCode Pix / Copy and paste that will be used by your end customer to make the payin payment. QR Code URL. Unique identifier for a transaction. Fine when the expiration date is reached. Discount when a certain date is reached. Boleto specific instructions object (when payment\_method is boleto). Expiration date in format YYYY-MM-DD. Typed boleto line that will be used by your end customer to pay payin. Barcode number for the boleto. Extra data for billet rendering. Fine when the expiration date is reached. Discount when a certain date is reached. Status object. Status id. Status name. Status History object. Status object. Status update date. Sub status object. The Id of the substatus. The substatus meaning. Reason for the payin cancellation (only appears if the payin was cancelled). The ID cancellation in our database. Possible values: * `1` - Canceled By Processor * `2` - Canceled By Client The cancellation meaning. Possible values: * `Canceled By Processor` * `Canceled By Client` Know your customer object. The KYC ID in our database. Refund object. Refund id. Current status of the refund. Refund amount. Free field to inform the reason for the refund. Refund created date. Refund update date. Automatic Pix configuration (if enabled). Cash-in created date. Cash-in update date. ## Request Example ```bash cURL theme={null} curl --request GET \ --url https://api.sandbox.wepayout.com.br/v2/payin/payments/32457 \ --header 'Accept: application/json' \ --header 'Authorization: Bearer 123' ``` ```javascript JavaScript theme={null} async function getChargeById(id) { const response = await fetch( `https://api.sandbox.wepayout.com.br/v2/payin/payments/${id}`, { headers: { 'Accept': 'application/json', 'Authorization': 'Bearer 123' } } ); return await response.json(); } // Usage const charge = await getChargeById(32457); console.log('Charge:', charge); ``` ```python Python theme={null} import requests def get_charge_by_id(charge_id): url = f'https://api.sandbox.wepayout.com.br/v2/payin/payments/{charge_id}' headers = { 'Accept': 'application/json', 'Authorization': 'Bearer 123' } response = requests.get(url, headers=headers) return response.json() # Usage charge = get_charge_by_id(32457) print('Charge:', charge) ``` ```json 200 OK - Pix Charge theme={null} { "id": 51644, "merchant": { "id": 477, "name": "Merchant Name" }, "hash": "bf0976019f5349567a315262cdb4d54e98842061fa26ed0a844c8384a40a58ee", "payment_page": "https://pagar.sandbox.goboleto.com/?hash=bf0976019f5349567a315262cdb4d54e98842061fa26ed0a844c8384a40a58ee", "our_number": "30858", "invoice": "YOUR-INVOICE-1234", "notification_url": "https://your-webhook-url.com/notify", "payment_method": "pix", "amount": 3000, "paid_amount": null, "refunded_amount": 0, "currency": { "id": 19, "name": "Reais", "code": "BRL", "symbol": "R$" }, "description": "Descrição", "created_at": "2025-11-14T17:35:33.000000Z", "updated_at": "2025-11-14T17:35:36.000000Z", "buyer": { "name": "Customer Name", "email": "customer@example.com", "document": { "type": "cnpj", "number": "99999919999979" }, "address": { "country": "BR", "city": null, "street": null, "number": null, "complement": null, "zipcode": null, "district": null, "state_code": null } }, "originator_legal_entity": { "name": "Empresa X", "document": "56251499000164", "helpdesk": "wepayments.com.br" }, "pix": { "expire_date": "2025-12-31 23:59:59", "refund_mode": "FULL_REFUND_MERCHANT", "qr_code": "00020126910014BR.GOV.BCB.PIX2569api-pix-h.bancobs2.com.br/spi/v2/7cc95f1a-743e-4f4a-a3ad-e2ba14f5f6f8520400005303986540510.005802BR5908Wepayout6014Belo Horizonte61083038040362070503***63049F6B", "end_to_end": null, "fine": { "percent": null, "amount": null, "date": null }, "discount": { "percent": null, "amount": null, "date": null } }, "status": { "id": 1, "name": "Created" }, "status_history": [ { "status": { "id": 1, "name": "Created" }, "updated_at": "2025-11-14T17:35:36.000000Z" } ], "substatus": null, "refunds": [], "automatic_pix": null } ``` ```json 200 OK - Canceled Charge theme={null} { "id": 51615, "merchant": { "id": 507, "name": "Merchant Name" }, "hash": "a014e4043acf0631c29dbce842a11a2120ecd8fec71aa8ad72979b0efd26f14a", "payment_page": "https://pagar.sandbox.goboleto.com/?hash=a014e4043acf0631c29dbce842a11a2120ecd8fec71aa8ad72979b0efd26f14a", "our_number": "30831", "invoice": "YOUR-INVOICE-4567", "notification_url": "https://your-webhook-url.com/notify", "payment_method": "pix", "amount": 96728, "paid_amount": null, "refunded_amount": 0, "currency": { "id": 19, "name": "Reais", "code": "BRL", "symbol": "R$" }, "description": "Bill collection", "created_at": "2025-11-14T08:10:29.000000Z", "updated_at": "2025-11-14T08:20:38.000000Z", "buyer": { "name": "Customer Name", "email": "customer@example.com", "document": { "type": "cpf", "number": "34960826312" }, "address": { "country": "BR", "city": null, "street": null, "number": null, "complement": null, "zipcode": null, "district": null, "state_code": null } }, "originator_legal_entity": { "name": "Company Name", "document": "34960826312", "helpdesk": "https://www.company-website.com/" }, "pix": { "expire_date": "2025-11-15 16:10:29", "refund_mode": "FULL_REFUND_MERCHANT", "qr_code": "00020126910014BR.GOV.BCB.PIX2569api-pix-h.bancobs2.com.br/spi/v2/7cc95f1a-743e-4f4a-a3ad-e2ba14f5f6f8520400005303986540510.005802BR5908Wepayout6014Belo Horizonte61083038040362070503***63049F6B", "end_to_end": null, "fine": { "percent": null, "amount": null, "date": null }, "discount": { "percent": null, "amount": null, "date": null } }, "status": { "id": 2, "name": "Canceled" }, "status_history": [ { "status": { "id": 1, "name": "Created" }, "updated_at": "2025-11-14T08:10:31.000000Z" }, { "status": { "id": 2, "name": "Canceled" }, "updated_at": "2025-11-14T08:20:38.000000Z" } ], "substatus": null, "reason_canceled": { "id": 1, "name": "Canceled By Processor" }, "refunds": [], "automatic_pix": null } ``` ```json 404 Not Found theme={null} { "message": "Charge not found" } ``` ## Use Cases Monitor the payment status of a specific charge: ```javascript theme={null} async function checkPaymentStatus(chargeId) { const charge = await getChargeById(chargeId); console.log(`Charge ${charge.invoice}:`); console.log(`Status: ${charge.status.name}`); console.log(`Amount: R$ ${charge.amount / 100}`); console.log(`Paid: R$ ${charge.paid_amount / 100}`); return charge.status.id === 4; // 4 = Pago } ``` Retrieve the Pix QR Code for display: ```javascript theme={null} async function getPixQRCode(chargeId) { const charge = await getChargeById(chargeId); if (charge.payment_method !== 'pix') { throw new Error('Not a Pix charge'); } return { qrCode: charge.pix.qr_code, qrCodeUrl: charge.pix.qr_code_url, expiresAt: charge.pix.expire_date }; } ``` Retrieve boleto payment details: ```javascript theme={null} async function getBoletoDetails(chargeId) { const charge = await getChargeById(chargeId); if (charge.payment_method !== 'boleto') { throw new Error('Not a Boleto charge'); } return { digitableLine: charge.boleto.digitable_line, barCode: charge.boleto.bar_code_number, expiresAt: charge.boleto.expire_date, ourNumber: charge.our_number }; } ``` View the complete status history of a charge: ```javascript theme={null} async function getStatusHistory(chargeId) { const charge = await getChargeById(chargeId); console.log(`Status history for charge ${charge.invoice}:`); charge.status_history.forEach(history => { console.log(`${history.updated_at}: ${history.status.name}`); }); return charge.status_history; } ``` Verify if a charge has been paid: ```javascript theme={null} async function verifyPayment(chargeId) { const charge = await getChargeById(chargeId); const isPaid = charge.status.id === 4; const paidAmount = charge.paid_amount; const expectedAmount = charge.amount; return { isPaid, paidAmount, expectedAmount, fullyPaid: isPaid && paidAmount >= expectedAmount }; } ``` ## Best Practices **ID Lookup**: Use the numeric charge ID to retrieve charge details. **Status Monitoring**: Check the `status_history` array to see the complete timeline of status changes for the charge. **QR Code Expiration**: For Pix charges, always check the `expire_date` before displaying the QR Code to ensure it hasn't expired.