It allows you to order a two-step withdrawal to the address we choose. The first step allows you to create a payout to get information about commissions and the final amount that will be paid out. The second step allows you to enter the destination payout address, after which the payout is processed. In order to be able to make withdrawals, this option must be unlocked in the Security tab at a specific store. Otherwise, we will receive the message: FORBIDDEN. You should also pay attention to the appropriate precision for a given currency. If the number of decimal places is exceeded, an error response will be returned.
Response details:
Key | Type | Description |
|---|---|---|
status | String | Status for the made payment: ok / fail. |
data | array | Default: null. |
outgoingPaymentId | UUID | The ID of the payout you created. |
expirationTimestamp | Unix Timestamp | Payout expiration time (the time until when you can provide an address - perform the second step). |
sourceCurrency | String | Source currency. |
destinationCurrency | String | Destination currency. |
channelName | String | Channel through which the |
sourcePrice | decimal | The initial value of the funds in the source currency. |
transferPrice | decimal | Source currency value of funds to be debited from the wallet. |
chargePrice | decimal | The value of the commission for making a withdrawal. |
destinationTransferAmount | decimal | The amount of funds needed to complete the withdrawal. |
amountToWithdraw | decimal | The amount of funds that will be received. |