post
https://stagingglobal.decentro.tech/v1/payout
Request body details for initiating a settlement or payout to a beneficiary.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Overview
This API allows the platform to request a settlement/payout from the specified Virtual Currency Account to the specified beneficiary and payment address (optional).
Settlement can only be initiated against the available balance of the target Virtual Currency Account.
EligibiltyThis feature is available only for collections undertaken through the Virtual Currency Accounts.
Flow
- The platform receives funds from its payers/end-customers into the virtual currency accounts created using the create Virtual Currency Account API.
- The platform maps a beneficiary and payment address against the virtual currency account.
- The platform receives the Beneficiary URN and Payment Address URN from Decentro
- The platform can now initiate settlements/payouts against the available balance using this API.
- Decentro validates the following details before processing the settlement request:
- Balance available in the virtual account
- Status of the beneficiary (active/inactive)
- Status of the payment address (active/inactive)
- If all checks are passed successfully, the payout is initiated.
- The platform will receive the confirmation of the settlement status from Decentro via the Settlement Status webhook.
API Endpoints
Below are the API endpoints to be used by the platform basis the environments.
| Environment | API Endpoint |
|---|---|
| Staging | https://stagingglobal.decentro.tech/v1/payout |
| Production | https://global.decentro.tech/v1/payout |
Currency UnitsAll amounts should be propagated in the base currency unit (example: Cents, Pence, Paisa, Centavos). Kindly convert primary currency unit into the base currency unit based on the table below.
Currency Code Decimal Places United States Dollar USD 2 EURO EUR 2 Pound Sterling GBP 2 Japanese Yen JPY 0 Indian Rupee INR 2 Singapore Dollars SGD 2 Australian Dollars AUD 2 Hong Kong Dollars HKD 2 Indonesian Rupiah IDR 2 Canadian Dollar CAD 2 New Zealand Dollar NZD 2 Malaysian Ringgit MYR 2 Vietnamese Dong VND 0 Thai Baht THB 2 Chinese Yuan CNY 2 South Korean Won KRW 0 United Arab Emirates Dirham AED 2 Brazilian Real BRL 2 Philippine Peso PHP 2 Nepalese Rupee NPR 2