Overview

Payments represent essential transactions within the Inspire platform, signifying financial entries. There are several possibilities when it comes to making payments:

One-Time Payment with No Products: Tenant users have the option to create one-time payments that do not involve specific products. In such cases, these payments must be executed using a credit card as the payment method.

Payment for Existing Invoices or Orders: Payments can be made for existing Invoices or Orders. Subscriptions do not have a direct payment mechanism; instead, their payments are facilitated through an associated Invoice. In this scenario, payments can occur in two ways:

• Automatic Payment: Payment is made using a credit card, and it is linked to the respective Order or Invoice. Details of these payments can be found on the Order or Invoice's detail page.
• Manual Payment: Payment is made at the hosted checkout using any available payment method. The payment is then linked to the corresponding Order or Invoice, and its details are accessible on the Order or Invoice detail page.

Payment via Hosted Checkout with a Payment Link: Payments can also be initiated through the hosted checkout using a payment link. In some cases, these payments may generate an Order, Subscription, or Invoice. Similar to the previous methods, payment details are recorded and made available on the related Invoice or Order detail page.

Payments also offer the functionality to be refunded, either partially or in full when they are in the "succeeded" status. This capability allows for the management of refunds when necessary, providing flexibility in financial transactions.

In addition to the previously mentioned information, payments within the Inspire platform support multiple currencies, including the US Dollar and the Brazilian Real. This multi-currency functionality allows users to conduct transactions in their preferred currency, enhancing flexibility and convenience.

Furthermore, when viewing the details of a payment, tenant users have access to information regarding the exchange rate or currency conversion that was applied during the payment. This transparency ensures clarity in financial transactions involving different currencies.

It's important to note that each payment may incur fees, which are determined and entered by the account manager, who holds Super User privileges. These fees can vary based on several factors, including the payment processor, payment method, number of installments, and the specific brand of credit card used for the payment. This dynamic fee structure allows for precise and customized fee management tailored to the unique characteristics of each payment, ensuring accurate financial processing.

Possible statuses for a Payment:

1. Succeeded: A payment in the "Succeeded" status indicates that the payment has been successfully sent to the payment API, and the payment processor has approved it. When a payment returns as "Succeeded," it signifies a completed and successful transaction. Moreover, this status triggers updates to related entities such as Invoices, Orders, and Subscriptions to reflect the successful payment.
2. Failed: "Failed" status denotes that the payment was indeed sent to the payment API, but it was denied by the payment processor for specific reasons. Often, the precise reason for the payment refusal may not be displayed in the system. Customers seeking more information about why their payment was declined are advised to contact their bank or credit card company for further clarification. This status represents an unsuccessful payment attempt.
3. Pending: Payments in the "Pending" status indicates that the payment has neither been confirmed nor denied by the payment processor. Typically, payments made using methods like PIX or bank slips may remain in this status for a brief period, as the payment confirmation is not instantaneous. It represents a temporary holding state until the payment processor completes the verification process.