API Documentation
Execute Crypto Payout Order
2 min
this api is used to execute a payout order and complete the user’s withdrawal it accepts token , requestid and clientid call this api after generating token from create crypto payout order docid ma9ywvaybfe7qkrhqhwg { "name" "execute crypto payout order", "method" "post", "url" "https //your hostname pay3 app/v1/client/crypto payout/execute", "description" "execute an order with payout details from application's backend", "tab" "examples", "examples" { "languages" \[ { "id" "nyfshp7j nrsuqth3fw7t", "language" "curl", "code" "curl location 'https //api dev pay3 app/v1/client/crypto payout/execute' \\\\\n header 'signature {{signature}}' \\\\\n header 'access token {dynamic access toke}' \\\\\n header 'content type application/json' \\\\\n data '{\n \\"token\\" \\"a003d60c d0ae 40e5 a7cb 2634ab607253\\",\n \\"requestid\\" \\"a1d4a50e 5577 4581 a980 98b03bc76260\\",\n \\"clientid\\" \\" \\"\n}'\n", "customlabel" "" } ], "selectedlanguageid" "nyfshp7j nrsuqth3fw7t" }, "results" { "languages" \[ { "id" "vqyrchsr38ubbehatupjh", "language" "200", "code" "{\n \\"txnhash\\" \\" \\",\n \\"ordertype\\" \\"payout\\",\n \\"orderid\\" \\"3b5a941c efef 4125 9237 3216ddd6f607\\",\n \\"requestid\\" \\"a1d4a50e 5577 4581 a980 98b03bc76260\\",\n \\"status\\" \\"order payment processing\\"\n}", "customlabel" "" }, { "id" "tivoqbuskgnrqallvndvq", "language" "401", "code" "{\n error {\n code '7001',\n message 'order already exists for given requestid'\n }\n}", "customlabel" "" } ], "selectedlanguageid" "vqyrchsr38ubbehatupjh" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "name" "token", "kind" "required", "type" "string", "description" "the token received from the create crypto payout order api with mode=createestimate", "" "the token received from the create crypto payout order api with mode=createestimate" }, { "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 pass the same id used while creating payout order ", "" "identifier that is created by application's backend this will be passed in relevant events and webhooks from pay3 to application pass the same id used while creating payout order " }, { "name" "clientid", "kind" "required", "type" "string", "description" "client id application's identifier ", "" "client id application's identifier " } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" }, "hastryitout" false, "response" \[ { "name" "orderid", "kind" "optional", "type" "string", "description" "the unique identifier generated by pay3 for this payout order this id can be used for referencing the payout in logs, dashboard views, api queries, and webhook events ", "children" \[] }, { "name" "requestid", "kind" "optional", "type" "string", "description" "the same requestid provided during payout creation and execution returned here for consistency, allowing applications to correlate the execution response with the original payout request ", "children" \[] }, { "name" "txnhash", "kind" "optional", "type" "string", "description" "the blockchain transaction hash generated after the payout is broadcasted to the network this can be used to track the payout on the respective blockchain explorer this can be null if the order is still processing " }, { "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" "current status of the payout order possible values may include states such as completed, failed, or order payment processing, depending on the payout result and blockchain processing ", "children" \[] } ] }