Get Settlement Details

api that returns settlement details for a client’s crypto orders this api requires access token that can be generated using access token docid\ hccakrqi4shqrffpcboir api a settlement represents the consolidation of one or more completed crypto orders based on the agreed settlement cycle (e g , daily, weekly, or any other agreed frequency) it includes the total order value and, once processed, the corresponding bank transfer details for the settlement settlementid unique id of the settlement clientid client id status status of the settlement possible values are created , processing , completed , failed , rejected netreceivedamount final amount received in the client’s bank account after applicable bank transfer fees fiatcurrencyid currency in which the settlement was transferred to the client’s bank account example aed ae transferfee bank transfer fee deducted from the settlement amount this will be 0 if no bank fee was applied transferreferenceid bank transfer reference id for the settlement transfertriggeredts \ timestamp at which the settlement bank transfer was initiated orderlist list of crypto orders included in the settlement errorreason contains errorcode and errordesc will be received only in case if status is failed list of possible sdk errors docid 94kyvqwbrsg1dfmljddbs { "name" "get settlement details", "method" "get", "url" "https //your hostname pay3 app/v1/client/exchange settlement/{settlementid}", "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/exchange settlement/{settlementid}' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n header 'client id {}'\n header 'access token access token in jwt'", "customlabel" "" } ], "selectedlanguageid" "3ljxgjcqzzkeicmdoi23s" }, "results" { "languages" \[ { "id" "gc lbeev7jo hgfni1chk", "language" "200", "code" "{\n \\"settlementid\\" \\"\\",\n \\"clientid\\" \\"\\",\n \\"status\\" \\"\\", // created, processing, completed, failed, rejected\n \\"fiatcurrencyid\\" \\"aed ae\\", // fiat currency id \n \\"transferdetails\\" {\n \\"transferfee\\" \\"\\", // transfer fee in fiat currency\n \\"netreceivedamount\\" \\"\\",\n \\"transferreferenceid\\" \\"\\",\n \\"transfertriggeredts\\" \\"\\",\n },\n \\"orderlist\\" \[\n {\n \\"requestid\\" \\"nlnwevw 5e449b97\\",\n \\"orderid\\" \\"5616750d 4829 4099 aacb 16deadf36cde\\",\n \\"orderstatus\\" \\"completed\\",\n \\"createdts\\" \\"2024 09 02t10 20 31 603z\\",\n \\"ordertype\\" \\"cryptopayin\\",\n \\"clientid\\" \\"abc\\",\n \\"paymentstatus\\" \\"completed\\",\n \\"receivedamount\\" \\"1 36\\",\n \\"userid\\" \\"satoshi\@email com\\",\n \\"txnhash\\" \\"08930348ce4d928694889a\\",\n \\"cryptocurid\\" \\"usdc ethereum\\",\n \\"cryptoamount\\" \\"1 36\\",\n \\"fiatcurrencyid\\" \\"aed ae\\",\n \\"fiatamount\\" \\"5 00\\"\n }\n ]\n}", "customlabel" "" }, { "id" "ybev9li4twgz n2zw 919", "language" "401", "code" "{\\"error\\" \\"client verification failed\\"}", "customlabel" "" } ], "selectedlanguageid" "gc lbeev7jo hgfni1chk" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "settlementid", "kind" "required", "type" "string", "description" "unique id of the settlement ", "" "unique id of the settlement " } ], "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" "clientid", "kind" "required", "type" "string", "description" "client id", "" "client id" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" }, "hastryitout" false, "autogeneratedanchorslug" "get settlement details", "legacyhash" "s47prcosdcg6c9bw46jeg" }