API Documentation
Get CryptoOrder Details
1 min
api that returns clients crypto orders matching the requestid this api requires access token that can be generated using access token docid\ lq v6ff 2i h1o3xd5kka api the response is a list of crypto orders which matches the given criteria orderid orderstatus for list of possible status please refer webhooks docid zgiyfgasxs2uqr272qa updatedts last order updated timestamp in epoch milliseconds ordertype type of order can be checkout/payout requestid unique id passed during order creation clientid client id paymentstatus for list of possible payment status please refer webhooks docid zgiyfgasxs2uqr272qa receivedamount actual amount received in supported currency payersemail email of the user settlementstatus status of the settlement txnhash on chain transaction hash cryptocurid name of the currency supported cryptoamount currency amount errorreason contains errorcode and errordesc will be received only in case if status is failed list of possible sdk errors docid\ upvtc67wkwgncscjvaq0v { "name" "get order details", "method" "get", "url" "https //your hostname pay3 app/v1/client/crypto 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/crypto 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\\" \\"5616750d 4829 4099 aacb 16deadf36cde\\",\n \\"orderstatus\\" \\"completed\\",\n \\"updatedts\\" 1725261631603,\n \\"ordertype\\" \\"cryptopayin\\",\n \\"requestid\\" \\"nlnwevw 5e449b97\\",\n \\"clientid\\" \\"5e449b97 c53b 4ed0 ac00 7b50e2f2406b\\",\n \\"paymentstatus\\" \\"completed\\",\n \\"receivedamount\\" \\"0 00018900\\",\n \\"payersemail\\" \\"satoshi\@email com\\",\n \\"settlementstatus\\" \\"not required\\",\n \\"txnhash\\" \\"08930348ce4d928694889a\\",\n \\"cryptocurid\\" \\"btc bitcoin\\",\n \\"cryptoamount\\" \\"0 000173\\",\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" } }