Orders Tab

An order is a more complex version of the Payment link since it involves sub-operations. The sub-operations occur in the underpaid and overpaid scenarios.

Payment links have a requested amount (1 ETH, for example). When the end user pays it, it gets closed. It doesn't matter if the end user payed 0.1 ETH, 1ETH or 10ETH, the end result is the same.

Orders, on the other hand, have mechanisms in place to ensure that the amount you requested is met. If you enter 5 BTC but the end user pays less, it is marked as "Underpaid". If they pay more, it is marked as "overpaid". Additional operations are executed to fix this.

Orders are created on "Payment links". When creating a payment link, click on the toggle button to set it as "Order". To know more about creating orders on "Payment links", click here.

The Exchange history table displays the following information:

Name	Description
ID	Displays the unique code that identifies the order on the platform.
Asset	Displays the selected crypto currency used to execute the operation.
Order amount	Displays the amount of the "Asset" requested on the operation.
Paid amount	Displays the amount of the "Asset" used on the operation.
Outstanding amount	Displays the amount of the "Asset" expected to achieve the "Order amount" requested on the operation.
Status	Displays the current status of the operation: Created, Pending, Processing, Paid, Underpaid, Overpaid, Expired, Failed, Refunded, Partially_refunded, Refunding, Deactivated.
Type	Displays the type of operation (order).
Creation Date	Displays the date and time the order was created.
Details	Button that allows you to open the order details pop-up card or to get the payment link associated with the order. The details button is hidden and is only visible when the row is hovered over.

See Orders

1. Hover over the desired order row on the Orders table and click on the "Options" button:

   

2. Click on "Details" from the drop-down menu:

   

3. The "Order details" pop-up card is displayed:

   

Filter the "Orders" Table

There are two ways of filtering the "Orders" table:

• Search bar:

1. Click on the Search icon:

   

2. Insert the desired title into the search bar:

   

   You can search by Order ID, Suboperation ID or Hash.

3. The table displays only the entries that match the inserted text:

   

• Filter selection:

1. In the top-left corner of the screen you have three drop-down menus:

   

2. Click on the desired asset from the drop-down menu.

3. Click on the desired status from the drop-down menu.

4. Click on the desired period from the drop-down menu.

5. The table only displays the entries that match the selected filters.

Click the title of the desired column to sort the table in ascending or descending order based on that column’s values.

Get a Payment Link

1. Hover over the desired order row on the Orders table and click on the "Options" button:

   

2. Click on "Payment link" from the drop-down menu:

   

3. A notification is displayed in the bottom-left corner of the screen:

   

4. Click on the "Copy link" button on the notification.

5. You can paste the link to send it to the desired user.

   If the order has the status "underpaid" and you want to request a new payment again, click on "Payment link". The new payment link requests only the amount still pending to reach the "Paid" status.

Setting an Order as Paid

1. Hover over the desired order row on the Orders table and click on the "Options" button:

   

2. Click on "Mark as paid" from the drop-down menu:

   

3. The order is closed and marked as "paid".

Refund an Order

1. Hover over the desired order row on the Orders table and click on the "Options" button:

   

2. Click on "Refund" or "Partially refunded" from the drop-down menu:

   

If an order is fully refunded, the status displayed is "Refunded". The order is closed and "Refunded" is its final status.

If and order is underpaid and you click on "Refund", the customer is fully refunded. This way, the customer receives all the money back and the order is closed as "refunded".

If an order is overpaid and you click on "Refund", the customer can either be fully refunded or partially refunded. You can select:

• Fully refunded: Means that the customer receives all the money back and the order is closed as "refunded".
• Partially refunded: Means that the customer receives the overpaid money and order receives status "partially refunded". After checking if everything is ok, the status is set "Paid".

Order via API

Orders can be created on the Portal and via API as well. Via API, you can use the Create a Order Link endpoint or the Create a Order Deposit endpoint.

To create an Order with a Payment Link:

1. Use the Order create endpoint (link).
2. Make sure the isSinglePayment parameter is set to False.
3. Fill in all the required fields (and any optional field you want) and submit the request to proceed.
4. An order is created and a payment link attached to it.
5. The payment link is displayed on the response body of the endpoint request.
6. You can copy the payment link and send it to the customer.

   The Payment Link only becomes active once the end user acesses it, which means that the expiration time of 30 minutes doesn't start until this happens.

To create an Order with a Deposit:

1. Use the Create an Order Deposit endpoint (link).
2. Fill in all the required fields (and any optional field you want) and submit the request to proceed.
3. An Order is created with a deposit attached to it.
4. The Response details allows you to either:
   • Provide the end user with the deposit address.
   • Use any implementation you want to visualize the Terminal for payment.

   The Deposit becomes active immediately, which means that the expiration time of 30 minutes begins counting.

Handling scenarios:

• Mark orders as Paid: You can mark any Order as “PAID” no matter its current status, via the Complete Order endpoint (link).

• Partially refund orders: You can refund an “OVERPAID” order, returning only the amount that was received above the expected with the Refund an overpaid order endpoint (link).

• Create a Deposit By requesting a follow-up Deposit (link) for an underpaid Order, the response details can be used to provide the deposit address to the customer (or use any implementation you want to visualize the terminal for payment).