API_Description

<p><strong>1. CancelOrder</strong></p> <p><strong>Interface Description</strong></p> <p>Cancel the Order</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>If mandatory? (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>OrderId</p> </td> <td> <p>String</p> </td> <td> <p><strong>true</strong></p> </td> <td> <p>Order ID (UUID), which comes from OrderBean</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>2. CancelOrderDetail</strong></p> <p><strong>Interface Description</strong></p> <p>Cancel the Order Details.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>If mandatory? (true/false)</strong></p> </td> <td> <p><strong>参数描述</strong></p> </td> <td> <p><strong>备注</strong></p> </td> </tr> <tr> <td> <p>OrderId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Order ID (UUID), which comes from OrderBean</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OrderDetailId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Order Detail ID(UUID), which comes from OrderDetailBean.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>3. ConfirmPayment</strong></p> <p><strong>Interface Description</strong></p> <p>Confirm Payment:</p> <p>(1)Confirm Payment, determine account balance.</p> <p>(2)Call payment interface to pay debit / coupon.</p> <p>(3)Determine payment results.</p> <p>(4)If the payment has been submitted successfully, then release payment success message via MQ channel. The provider will implement the order base on the payment result.</p> <p>(5)Return the payment result.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>If mandatory? (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>OrderId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Order ID (UUID), which comes from OrderBean</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CouponId</p> </td> <td> <p>Long</p> </td> <td> <p>false</p> </td> <td> <p>Coupon ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>OrderStatus</p> </td> <td> <p>Order Status</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ProductCode</p> </td> <td> <p>String</p> </td> <td> <p>Product Code</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>4. CreateOrder</strong></p> <p><strong>Interface Description</strong></p> <p>Create Order</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>If mandatory? (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Region ID(UUID), which comes from &nbsp;RegioBean</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CreateResourceInfo</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Create Order Resuource information</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Type</p> </td> <td> <p>OrderType</p> </td> <td> <p>true</p> </td> <td> <p>Order Type</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Remark</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Order remarks</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ResourceType</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Resource Type</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PayOrder</p> </td> <td> <p>boolean</p> </td> <td> <p>false</p> </td> <td> <p>Payment indicator</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>CouponId</p> </td> <td> <p>Long</p> </td> <td> <p>false</p> </td> <td> <p>Coupon ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>OrderId</p> </td> <td> <p>String</p> </td> <td> <p>Order ID(UUID)</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>5. GetOrderDetail</strong></p> <p><strong>Interface Description</strong></p> <p>Get the Order Details Base on the Order ID (UUID)</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>If mandatory? (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Order ID (UUID), which comes from OrderBean</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Order</p> </td> <td> <p>OrderBean</p> </td> <td> <p>Order Details</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>6. ListOrderDetail</strong></p> <p><strong>Interface Description</strong></p> <p>List the Order Details</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>If mandatory? (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Order ID (UUID), which comes from OrderBean</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Order</p> </td> <td> <p>OrderBean</p> </td> <td> <p>Order Details</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>7. ListOrders</strong></p> <p><strong>Interface Description</strong></p> <p>Get Order List by Query</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>If mandatory? (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ProductId</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Product Id</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Type</p> </td> <td> <p>OrderType</p> </td> <td> <p>false</p> </td> <td> <p>Order Type, refer to Enum Types &ldquo;OrderType&rdquo;</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>OrderStatus</p> </td> <td> <p>false</p> </td> <td> <p>Order Status, refer to Enum Types &ldquo;OrderStatis</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Begin</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Start Time, Time Format &quot;yyyy-mm-dd&quot;</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>End</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>End Time, Time Format &quot;yyyy-mm-dd&quot;</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>false</p> </td> <td> <p>Page Number</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageSize</p> </td> <td> <p>Integer</p> </td> <td> <p>false</p> </td> <td> <p>Page Size</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OrderBy</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Order sorting option ID, createTime</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OrderType</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Order sorting Type DESC, ASC</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ResouceName</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Resource Name, which comes from OrderBean</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Total Number of Orders</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Orders</p> </td> <td> <p>List&lt;OrderBean&gt;</p> </td> <td> <p>Order List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table>
Did the above content solve your problem? Yes No
Please complete information!

Call us

400-151-8800

Email us

cloud@pingan.com

Online customer service

Instant reply

Technical Support

cloud products