API Documentation
Get Order Details
1 min
api that returns clients orders matching the requestid this api requires access token that can be generated using access token docid\ gi jr7m modsx5dxyfrw api the response is a list of orders which matches the given criteria orderid orderstatus for list of possible status please refer webhooks docid 0qhizcduboky8qj163x2f useraddress user's email address updatedts last order updated timestamp in epoch milliseconds partner downstream partner id ordertype type of order can be checkout/payout requestid unique id passed during order creation clientid client id exchangecurid name of the currency supported exchangeamount currency amount paymentmethod payment method specified for order errorreason contains errorcode and errordesc will be received only in case if status is failed list of possible sdk errors docid\ hpvtdmjhhdvuxdy6pd3 a name get order details method get url https your hostname pay3 app v1 client orders?requestid your request id clientid your client id description get order details by client s request id tab examples examples languages id 3ljxgjcqzzkeicmdoi23s language curl code curl location https your hostname pay3 app v1 client orders?requestid your request id clientid your client id n header accept application json n header content type application json n header access token access token in jwt customlabel selectedlanguageid 3ljxgjcqzzkeicmdoi23s results languages id gc lbeev7jo hgfni1chk language 200 customlabel code n data n n orderid 4073be54 5903 47c8 820f 17aa12964ba8 n orderstatus failed n useraddress user email com n updatedts 1706610264546 n partner xyz n ordertype checkout n requestid 900531 n clientid your client id n exchangecurid brl bz n exchangeamount 2 00 n paymentmethod pix n errorreason n errorcode 9004 n errordesc error occurred while the payment was processed by the payment partner n n n n id ybev9li4twgz n2zw 919 language 401 customlabel code error client verification failed selectedlanguageid gc lbeev7jo hgfni1chk request pathparameters queryparameters name requestid kind required type string description request id is the unique id that was passed by your application while creating the order children name clientid kind required type string description client id children headerparameters name access token kind required type string description access token received from access token api you can reuse the access token across multiple api calls till it is expired children bodydataparameters formdataparameters currentnewparameter label header parameter value headerparameters