API Documentation
Execute Fiat Payout Order
2 min
this api is used to execute a fiat payout order and complete the user’s withdrawal it accepts header access token , token , requestid and clientid call this api after generating token from docid\ cz cutnjfgefe eokawio this api requires access token that can be generated using docid\ lq v6ff 2i h1o3xd5kka api { "name" "execute fiat payout order", "method" "post", "url" "https //your hostname pay3 app/v1/client/payout/execute", "description" "create an order with payout details from application's backend", "tab" "examples", "examples" { "languages" \[ { "id" "exhyhl9rwxfgu lg6oq1q", "language" "curl", "code" "curl location 'https //your hostname pay3 app/v1/client/payout/create order' \\\\\n header 'signature' \\"generated signature\\"\\\\\n header 'access token' \\"dynamic access token\\" \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n data '{\n \\"token\\" \\"45452aae 581d 49db 94be ac0973e39e86\\",\n \\"requestid\\" \\"239e667a 3a54 4928 a265 09c003d7ec73\\",\n \\"clientid\\" \\" \\"\n}'", "customlabel" "" } ], "selectedlanguageid" "exhyhl9rwxfgu lg6oq1q" }, "results" { "languages" \[ { "id" "vqyrchsr38ubbehatupjh", "language" "200", "code" "{\n \\"requestid\\" \\"239e667a 3a54 4928 a265 09c003d7ec73\\",\n \\"orderid\\" \\"776cd238 0d49 4a6b b5e0 a8ca245036a2\\",\n \\"ordertype\\" \\"payout\\",\n \\"status\\" \\"order payment initiated\\"\n}", "customlabel" "" }, { "id" "66dvgm2ssfyrrj4nnmnj1", "language" "400", "code" "{\n error {\n code '7001',\n message 'order already exists for given requestid'\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", "children" \[] }, { "name" "token", "kind" "required", "type" "string", "description" "a unique token returned after creating the payout/verification order this token must be passed to the execute api to complete the processing flow ", "" "required" } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "response" \[ { "name" "requestid", "kind" "optional", "type" "string", "description" "identifier that is created by application's backend this will be passed in relevant events and webhooks from pay3 to application " }, { "name" "orderid", "kind" "optional", "type" "string", "description" "the internal pay3 generated identifier for this payout order this can be used for tracking, reconciliation, and fetching detailed order information through the order details api ", "children" \[] }, { "name" "ordertype", "kind" "optional", "type" "string", "description" "indicates the type of order being processed for this api, the value will always be \\"payout\\", confirming that the request corresponds to a withdrawal operation ", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" "indicates the current stage or final outcome of the payout execution the possible statuses include \n\n order payment initiated the payout has been triggered and processing has begun \n failed the payout could not be processed due to an error from the partner, bank, or network \n", "children" \[] } ] }