Execute Fiat Settlement - Submit Invoice
1 min
this api is used to submit invoice details for a specific fiat order and subsequently trigger the settlement process this api is required only for certain geographies or currencies where merchants must submit invoice details for each order to comply with local regulatory and compliance requirements whether invoice submission is required for your integration will be communicated by the pay3 team during the integration process this api requires access token that can be generated using access token docid\ lq v6ff 2i h1o3xd5kka api { "name" "fiat settlement submit invoice", "method" "post", "url" "https //your hostname pay3 app/client/fiat settlement/submit invoice", "description" "submit an invoice for any fiat order using the same requestid which was used during the order creation ", "tab" "examples", "examples" { "languages" \[ { "id" "nyfshp7j nrsuqth3fw7t", "language" "curl", "code" "curl location 'https //api pprod pay3 app/v1/client/fiat settlement/submit invoice' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n header 'access token eyjrawqioiixymi5nja1yzm2zvrcwkjmoh' \\\\\n data '{\n \\"requestid\\" \\"2544743810\\",\n \\"clientid\\" \\"82e024d1 8e43 4252 88d4 f3222e4f113b\\",\n \\"countryoforigin\\" \\"usa\\",\n \\"importername\\" \\"john\\",\n \\"importeraddress\\" {\n \\"address\\" \\"321 elm street, suite 3\\",\n \\"country\\" \\"usa\\",\n \\"city\\" \\"los angeles, ca\\",\n \\"pincode\\" \\"90401\\"\n },\n \\"billername\\" \\"pay3\\",\n \\"billeraddress\\" {\n \\"address\\" \\"123 space center blvd\\",\n \\"country\\" \\"usa\\",\n \\"city\\" \\"houston\\",\n \\"pincode\\" \\"77058\\"\n },\n \\"invoicedate\\" \\"2027 01 01\\",\n \\"ordersno\\" \\"123123\\",\n \\"invoicetotal\\" \\"400 00\\",\n \\"invoicenumber\\" \\"234234\\",\n \\"items\\" \[\n {\n \\"itemdescription\\" \\"shoes\\",\n \\"price\\" \\"250 00\\",\n \\"quantity\\" \\"1\\",\n \\"taxpercentage\\" \\"0\\",\n \\"taxamount\\" \\"0 00\\",\n \\"itemtotalprice\\" \\"250 00\\"\n },\n {\n \\"itemdescription\\" \\"watch\\",\n \\"price\\" \\"150 00\\",\n \\"quantity\\" \\"1\\",\n \\"taxpercentage\\" \\"0\\",\n \\"taxamount\\" \\"0 00\\",\n \\"itemtotalprice\\" \\"150 00\\"\n }\n ]\n}'", "customlabel" "" } ], "selectedlanguageid" "nyfshp7j nrsuqth3fw7t" }, "results" { "languages" \[ { "id" "vqyrchsr38ubbehatupjh", "language" "200", "code" "{\n \\"id\\" \\"237690bb f311 4a3e 9fbe d36711ad5bfa\\",\n \\"status\\" \\"review queued\\",\n \\"requestmetadata\\" {\n \\"clientid\\" \\"82e024d1 8e43 4252 88d4 f3222e4f113b\\",\n \\"requestid\\" \\"2544743810\\",\n \\"countryoforigin\\" \\"usa\\",\n \\"importername\\" \\"john\\",\n \\"importeraddress\\" {\n \\"address\\" \\"321 elm street, suite 3\\",\n \\"city\\" \\"los angeles, ca\\",\n \\"country\\" \\"usa\\",\n \\"pincode\\" \\"90401\\"\n },\n \\"billername\\" \\"pay3\\",\n \\"billeraddress\\" {\n \\"address\\" \\"123 space center blvd\\",\n \\"city\\" \\"houston\\",\n \\"country\\" \\"usa\\",\n \\"pincode\\" \\"77058\\"\n },\n \\"invoicedate\\" \\"2027 01 01\\",\n \\"invoicetotal\\" \\"400 00\\",\n \\"ordersno\\" \\"123123\\",\n \\"invoicenumber\\" \\"234234\\",\n \\"items\\" \[\n {\n \\"itemdescription\\" \\"shoes\\",\n \\"hscode\\" null,\n \\"price\\" \\"250 00\\",\n \\"quantity\\" \\"1\\",\n \\"taxpercentage\\" \\"0\\",\n \\"taxamount\\" \\"0 00\\",\n \\"itemtotalprice\\" \\"250 00\\"\n },\n {\n \\"itemdescription\\" \\"watch\\",\n \\"hscode\\" null,\n \\"price\\" \\"150 00\\",\n \\"quantity\\" \\"1\\",\n \\"taxpercentage\\" \\"0\\",\n \\"taxamount\\" \\"0 00\\",\n \\"itemtotalprice\\" \\"150 00\\"\n }\n ]\n },\n \\"createdts\\" \\"2026 07 08t10 42 51 307292+00 00\\",\n \\"updatedts\\" \\"2026 07 08t10 42 51 307292+00 00\\"\n}", "customlabel" "" }, { "id" "tivoqbuskgnrqallvndvq", "language" "401", "code" "{\n \\"code\\" \\"7001\\",\n \\"error\\" {\n \\"code\\" \\"500\\",\n \\"message\\" \\"no route found for subscription\\"\n }\n}\n\n{\n \\"code\\" \\"7001\\",\n \\"error\\" {\n \\"code\\" \\"500\\",\n \\"message\\" \\"invalid value for interval daily1\\"\n }\n}", "customlabel" "" } ], "selectedlanguageid" "vqyrchsr38ubbehatupjh" }, "request" { "pathparameters" \[], "queryparameters" \[], "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" \[ { "name" "requestid", "kind" "required", "type" "string", "description" "identifier that is created by application's backend this will be passed in relevant events and webhooks from pay3 to application", "" "identifier that is created by application's backend this will be passed in relevant events and webhooks from pay3 to application" }, { "name" "clientid", "kind" "required", "type" "string", "description" "client id application's identifier", "" "required" }, { "name" "countryoforigin", "kind" "required", "type" "string", "description" "this parameter accepts a string for country of origin ", "" "required" }, { "name" "importername", "kind" "required", "type" "string", "description" "name of the importer/end user \n", "" "required" }, { "name" "importeraddress", "kind" "required", "type" "object", "description" "address of the importer/end user this object accepts following params \n", "" "required", "children" \[ { "name" "address", "kind" "optional", "type" "string", "description" "" }, { "name" "country", "kind" "optional", "type" "string", "description" "" }, { "name" "city", "kind" "optional", "type" "string", "description" "" }, { "name" "pincode", "kind" "optional", "type" "string", "description" "" } ], "schema" \[ { "name" "address", "kind" "optional", "type" "string", "description" "" }, { "name" "country", "kind" "optional", "type" "string", "description" "" }, { "name" "city", "kind" "optional", "type" "string", "description" "" }, { "name" "pincode", "kind" "optional", "type" "string", "description" "" } ] }, { "name" "billername", "kind" "required", "type" "string", "description" "name of the merchant eg \\"abc private limited\\"", "" "required" }, { "name" "billeraddress", "kind" "required", "type" "object", "description" "address of the merchant this object accepts following params ", "" "required", "children" \[ { "name" "address", "kind" "optional", "type" "string", "description" "" }, { "name" "country", "kind" "optional", "type" "string", "description" "" }, { "name" "city", "kind" "optional", "type" "string", "description" "" }, { "name" "pincode", "kind" "optional", "type" "string", "description" "" } ], "schema" \[ { "name" "address", "kind" "optional", "type" "string", "description" "" }, { "name" "country", "kind" "optional", "type" "string", "description" "" }, { "name" "city", "kind" "optional", "type" "string", "description" "" }, { "name" "pincode", "kind" "optional", "type" "string", "description" "" } ] }, { "name" "invoicedate", "kind" "required", "type" "string", "description" "date of the invoice", "" "required" }, { "name" "invoicetotal", "kind" "required", "type" "integer", "description" "this parameter is the sum of all the \\"itemtotalprice\\" from the \\"items\\" object ", "" "required" }, { "name" "ordersno", "kind" "required", "type" "string", "description" "order serial number ", "" "required" }, { "name" "invoicenumber", "kind" "required", "type" "string", "description" "the invoice number of the order ", "" "required" }, { "name" "items", "kind" "required", "type" "object", "description" "this parameter accepts array of objects using this multiple details can be submitted for different item \neach object inside this accepts following parameters \n", "" "this parameter accepts array of objects using this multiple details can be submitted for different item \neach object inside this accepts following parameters \n", "children" \[ { "name" "itemdescription", "kind" "optional", "type" "string", "description" "small description of the item eg \\"shoes\\" , \\"watch\\" etc " }, { "name" "price", "kind" "optional", "type" "integer", "description" "price of the item " }, { "name" "quantity", "kind" "optional", "type" "integer", "description" "quantity of the item " }, { "name" "taxpercentage", "kind" "optional", "type" "string", "description" "tax percentage applicable on the item " }, { "name" "taxamount", "kind" "optional", "type" "integer", "description" "calculated tax amount as per the \\"taxpercentage\\" " }, { "name" "itemtotalprice", "kind" "optional", "type" "integer", "description" "total price of the item inclusive of tax " } ], "schema" \[ { "name" "itemdescription", "kind" "optional", "type" "string", "description" "small description of the item eg \\"shoes\\" , \\"watch\\" etc " }, { "name" "price", "kind" "optional", "type" "integer", "description" "price of the item " }, { "name" "quantity", "kind" "optional", "type" "integer", "description" "quantity of the item " }, { "name" "taxpercentage", "kind" "optional", "type" "string", "description" "tax percentage applicable on the item " }, { "name" "taxamount", "kind" "optional", "type" "integer", "description" "calculated tax amount as per the \\"taxpercentage\\" " }, { "name" "itemtotalprice", "kind" "optional", "type" "integer", "description" "total price of the item inclusive of tax " } ] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "autogeneratedanchorslug" "fiat settlement submit invoice", "legacyhash" "706eujtsnefgkfl4kkq4s" }