API Reference

Charge

Explaining Charges: PIX, Credit Card, and Refunds

PIX Charges

PIX is an instant payment system developed by the Central Bank of Brazil that allows for quick and easy money transfers.

Key Points:

Instant Payments: Transfers occur in real-time, usually within seconds.
Availability: Available 24/7, including weekends and holidays.
Security: Uses encryption and other security measures to ensure the safety of transactions.
Cost-Effective: Often cheaper than traditional bank transfers.

Example Scenario:

A customer wants to make a payment for a service. They initiate a PIX payment using their smartphone, scanning a QR code generated by the merchant. The funds are instantly transferred from the customer's bank account to the merchant's account.

Credit Card Charges

Credit card payments are a widely used method for transactions, allowing customers to pay using their credit cards.

Key Points:

Deferred Payment: Customers can make purchases and pay for them later, usually on a monthly billing cycle.
Widely Accepted: Accepted by most merchants and service providers worldwide.
Security: Includes features such as fraud detection and chargebacks to protect customers.
Installments: In some regions, customers can pay in installments.

Example Scenario:
A customer purchases a product online. They enter their credit card details, and the amount is charged to their card. The customer then pays the credit card bill at the end of the billing cycle.

Refunds

Refunds are the process of returning funds to a customer after a transaction has been completed. This might occur due to product returns, service cancellations, or errors in the original transaction.

Key Points:

Reversal of Charges: The amount paid by the customer is returned to their account.
Timely Process: Refunds are typically processed within a few business days, although the exact time may vary.
Reason for Refund: A reason for the refund is usually provided, such as "product return" or "service cancellation".
Full or Partial: Refunds can be for the full amount or a partial amount of the original transaction.

Example Scenario:

A customer decides to return a product they purchased online. They request a refund, and once the return is processed, the funds are credited back to their original payment method.

Payment Links

A payment link is a URL that directs a customer to a web page where they can complete a payment. It simplifies the payment process by providing an easy, accessible way for customers to pay for goods or services.

Key Points:

Ease of Use: Customers can click on the link to access a secure payment page where they can enter their payment details and complete the transaction.
Flexibility: Payment links can support multiple payment methods, including credit cards, pix. Customers may also choose the number of installments if the option is available.
Customizable: Businesses can customize payment links to include specific transaction details, such as the amount, description, and due date.
Security: Payment links are typically hosted on secure servers, ensuring that customer payment information is encrypted and protected from unauthorized access.
Convenience: Payment links can be generated quickly and sent to customers through various communication channels, making it a convenient option for both businesses and customers.

Example Scenario:

A business sells products online and wants to offer customers a flexible way to pay. By generating a payment link, the business can send this link to the customer via email. When the customer clicks on the link, they are directed to a secure payment page where they can select their preferred payment method, choose the number of installments, and complete the payment.