API Documentation
Get Fiat Order List
1 min
this api returns list of orders matching the query parameters this api requires access token that can be generated using access token docid\ lq v6ff 2i h1o3xd5kka api { "name" "get order list", "method" "get", "url" "https //your hostname pay3 app/v2/client/fiat orders?useraddress=email\@address com\>e=2024 07 15\<e=2024 07 15", "description" "get order details by query parameters", "tab" "examples", "examples" { "languages" \[ { "id" "3ljxgjcqzzkeicmdoi23s", "language" "curl", "code" "curl location 'https //your hostname pay3 app/v2/client/fiat orders?useraddress=email%40address com\>e=2024 07 15\<e=2024 07 15' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n header 'access token access token in jwt'\\\\\n header 'client id your client id' \\\\", "customlabel" "" } ], "selectedlanguageid" "3ljxgjcqzzkeicmdoi23s" }, "results" { "languages" \[ { "id" "gc lbeev7jo hgfni1chk", "language" "200", "customlabel" "", "code" "{\n \\"message\\" \\"records found, successful\\",\n \\"fiattransactions\\" \[\n {\n \\"orderstatus\\" \\"completed\\",\n \\"requestid\\" \\"00837830 5854 47c4 9361 3921abc6e831\\",\n \\"clientid\\" \\"your client id\\",\n \\"exchangecurid\\" \\"brl bz\\",\n \\"exchangeamount\\" \\"2 02\\",\n \\"updatedts\\" 1721020103515,\n \\"createdts\\" 1721020103515,\n \\"orderid\\" \\"5d6a9682 1938 4a6f a252 61378f67dac9\\",\n \\"useraddress\\" \\"email\@address com\\",\n \\"ordertype\\" \\"payout\\",\n \\"paymentstatus\\" \\"completed\\",\n \\"paymentinstrument\\" \\"pix\\"\n },\n {\n \\"orderstatus\\" \\"failed\\",\n \\"requestid\\" \\"40204\\",\n \\"clientid\\" \\"your client id\\",\n \\"exchangecurid\\" \\"brl bz\\",\n \\"exchangeamount\\" \\"2 00\\",\n \\"updatedts\\" 1721223117912,\n \\"createdts\\" 1721222981384,\n \\"orderid\\" \\"795581c9 a0ce 4473 a001 cc89aff33f50\\",\n \\"useraddress\\" \\"email\@address com\\",\n \\"ordertype\\" \\"checkout\\",\n \\"paymentstatus\\" \\"cancelled\\",\n \\"paymentinstrument\\" \\"credit card\\"\n }\n ]\n}" }, { "id" "ybev9li4twgz n2zw 919", "language" "401", "customlabel" "", "code" "{\\"error\\" \\"client verification failed\\"}" } ], "selectedlanguageid" "gc lbeev7jo hgfni1chk" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "useraddress", "kind" "required", "type" "string", "description" "email address/user id/userid used while creating the transaction ", "" "email address/user id/userid used while creating the transaction " }, { "name" "gte", "kind" "required", "type" "string", "description" "transaction created on or after this date date in yyyy mm dd format ", "children" \[] }, { "name" "lte", "kind" "required", "type" "string", "description" "transaction created on or before this date date in yyyy mm dd format ", "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" \[] }, { "name" "client id", "kind" "required", "type" "string", "description" "client id", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } }