Get Settlement List

api that returns a list of settlements for the client this api requires access token that can be generated using access token docid\ hccakrqi4shqrffpcboir api a settlement represents the final amount transferred to the client’s bank account for one or more completed crypto orders each settlement object includes the following fields settlementid unique id of the settlement clientid client id minordercreatets this is the created timestamp of the oldest order part of this settlement maxordercreatets this is the created timestamp of the most recent order part of this settlement status status of the settlement possible values are created , processing , completed , failed , rejected fiatcurrencyid currency in which the settlement was transferred to the client’s bank account example aed ae grossamount total settlement amount transferfee bank transfer fee deducted from the settlement amount this will be 0 if no bank fee was applied netreceivedamount final amount received in the client’s bank account after applicable bank transfer fees transferreferenceid bank transfer reference id for the settlement transfertriggeredts \ timestamp at which the settlement bank transfer was initiated 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/list?settlementid={}\&requestid={}\&gte=2024 07 15\&lte=2024 07 15", "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/list?settlementid={}\&requestid={}\&fromdate=2024 07 15\&todate=2024 07 15' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n header 'client id zyx' \\\\\n header 'access token access token in jwt'", "customlabel" "" } ], "selectedlanguageid" "3ljxgjcqzzkeicmdoi23s" }, "results" { "languages" \[ { "id" "gc lbeev7jo hgfni1chk", "language" "200", "code" "{\n\\"exchange settlements\\" \[{\n \\"settlementid\\" \\"1234\\",\n \\"clientid\\" \\"zyx\\",\n \\"minordercreatets\\" \\" \\",\n \\"maxordercreatets\\" \\" \\" ,\n \\"status\\" \\"\\", // created, processing, completed, failed, rejected\n \\"fiatcurrencyid\\" \\"aed ae\\", \n \\"netreceivedamount\\" \\" \\",\n \\"grossamount\\" \\" \\",\n \\"transferfee\\" \\"\\",\n \\"transferreferenceid\\" \\"\\",\n \\"transfertriggeredts\\" \\"\\"\n },\n {\n \\"settlementid\\" \\"7896\\",\n \\"clientid\\" \\"zyx\\",\n \\"minordercreatets\\" \\" \\",\n \\"maxordercreatets\\" \\" \\" ,\n \\"status\\" \\"\\", // created, processing, completed, failed, rejected\n \\"fiatcurrencyid\\" \\"aed ae\\", \n \\"netreceivedamount\\" \\"\\", \n \\"grossamount\\" \\" \\",\n \\"transferfee\\" \\"\\",\n \\"transferreferenceid\\" \\"\\",\n \\"transfertriggeredts\\" \\"\\"\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" "optional", "type" "string", "description" "unique id of the settlement ", "" "optional" }, { "name" "requestid", "kind" "optional", "type" "string", "description" "request id is the unique id that was passed by your application while creating the order ", "" "request id is the unique id that was passed by your application while creating the order " }, { "name" "fromdate", "kind" "optional", "type" "string", "description" "return settlements created on or after this date format yyyy mm dd ", "" "fromdate" }, { "name" "todate", "kind" "optional", "type" "string", "description" "return settlements created on or before this date format yyyy mm dd ", "" "todate" } ], "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", "" "required" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" }, "hastryitout" false, "autogeneratedanchorslug" "get settlement details", "legacyhash" "2o562owt8ss21ufvydq3t" }