When you make a request to our API using the POST method, it generates a transaction that is categorized as either a payment or a payout.
Below, we explain in detail each status that a transaction can have.
Transaction
Status | Description |
---|---|
open | When using the API /transaction/checkout, the initial status of the transaction is open. It means that a transaction has been initiated but the requester has not yet assigned a payment method on our page. |
pending | When using the API /payment or /payout, the initial status of the transaction is pending. It means that a transaction has been initiated and automatically assigned (as sent in the payload) a payment or payout method. |
paid | When a transaction is successfully completed and processed, the transaction status is paid. |
canceled | When a transaction fails for any reason, the transaction status becomes canceled |
The types of transactions, also known as sub-transactions, work almost like a log of the transaction's evolution. Below is a brief description of each status and a flowchart of the evolution of the statuses.
Payment
Status | Description |
---|---|
pending | All payment-type transactions have the pending status as the initial status. |
paid | When a payment is successfully completed and processed, the transaction status is paid. |
denied | When a payment does not meet our payment policies, it is denied, and therefore our status becomes denied. |
expired | Whenever a payment order is opened, it has a period for payment. When the period is reached, the order expires, making it no longer possible to pay. |
chargeback | Whenever a payment order is paid, then the customer requests a chargeback in their bank, this status symbolizes that the value of this transactions is no longer available |
blocked | This status symbolizes that the value of this transaction is blocked for various reasons. Examples:
For more information, contact the administration. |
Payout
Status | Description |
---|---|
pending | All payout-type transactions have the pending status as the initial status |
onhold | When the payout request is sent for processing, it receives the onhold status, meaning it is waiting for the bank to make the payment to proceed with success or failure |
success | When a payout is successfully completed and processed, the transaction status is success. |
failed | When a payout does not meet our payment policies or we cannot process it due to various problems, it fails, and therefore our status becomes failed. |
blocked | This status symbolizes that the value of this transaction is blocked for various reasons. Examples:
For more information, contact the administration. |
returned | In some cases, the banking institution returns the received amount, in which case the status becomes returned. |
refunded | In some cases, the customer returns the received amount, in which case the status becomes refunded. |