The payment order is the center of our payment process, as the vehicle for payment information and the link between the organization, the user, the payment methods and the transaction.
We simplify all the processes in the payment order, an entity that allows the product, the price and the user to be linked in the same element and direct the payment to its final transaction.
A payment order has a life cycle shown in the image below:
First of all, a payment order must be created. After it has been created, it can take on different states depending on the action that is performed on it:
- Create a Payment Order
- Pay a Payment Order vía Payment Form or vía API (reuse a payment method)
- Cancel a Payment Order
- Make a partially Refund
- Make a Refund
Payment order status
|AVAILABLE||The initial status of a Payment Order after it has been created. This Payment Order can be expired, canceled or paid.|
|EXPIRED||A Payment Order is expired if the expiry period (24 hours by default) has passed and the payment on it has not been made. Once the Payment Order has expired it cannot be paid.|
|CANCELLED||A Payment Order with AVAILABLE status may be canceled. After we canceled the Payment Order it cannot be paid.|
|PAID||Only after we confirm or execute a Payment the Payment Order status would be PAID.|
|PARTIALLY_REFUNDED||A Payment Order is in this status if we make a refund for an amount less than the total after having been paid.|
|REFUNDED||The amount associated with the Payment Order which was previously paid has been completely refunded. To be able to proceed to a refund, the Payment Order must be in PAID or PARTIALLY_REFUNDED status.|
Please refer to the API reference to view the attributes of each parameter.
Did this page help you?