Execute Crypto Payout Order

2 min

This API is used to execute a crypto payout order and complete the user’s withdrawal. It accepts token , requestId and clientId

Call this api after generating token from Crypto Payout Order with mode=createEstimate

Execute an order with payout details from application's backend

POST

https://your-hostname.pay3.app/v1/client/crypto-payout/execute

Header Parameters

tokenstringrequired
Description
The token received from the Create Crypto Payout Order API with mode=createEstimate
requestIdstringrequired
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.
clientIdstringrequired
Description
Client id. Application's identifier.

Response

orderIdstring
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.
requestIdstring
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.
txnHashstring
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.
orderTypestring
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.
statusstring
Description
Indicates the current stage or final outcome of the payout execution. The possible statuses include: - ORDER_PAYMENT_PROCESSING: The payout request is under process. You will receive status updates via Webhook. Please call the Crypto Order Details api for details. - FAILED: The payout could not be processed.

curl

curl --location 'https://api.dev.pay3.app/v1/client/crypto-payout/execute' \
--header 'signature: {{signature}}' \
--header 'access-token: {dynamic-access-toke}' \
--header 'Content-Type: application/json' \
--data '{
    "token":"a003d60c-d0ae-40e5-a7cb-2634ab607253",
    "requestId":"a1d4a50e-5577-4581-a980-98b03bc76260",
    "clientId":"...."
}'

200

{
    "txnHash": "...",
    "orderType": "PAYOUT",
    "orderId": "3b5a941c-efef-4125-9237-3216ddd6f607",
    "requestId": "a1d4a50e-5577-4581-a980-98b03bc76260",
    "status": "ORDER_PAYMENT_PROCESSING"
}

401

{
    error: {
      code: '7001',
      message: 'Order already exists for given requestId'
    }
}

Execute Crypto Payout Order

﻿