API Reference
DocumentationSupport

Request Settlement/Payout to Beneficiary

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
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

This API allows the platform to request a settlement/payout from the specified Virtual Currency Account to the specified beneficairy and payment address (optional).

Settlement can only be initated against the available balance of the targer Virtual Currency Account.

Eligibilty

This feature is available only for collections undertaken through the Virtual Currenct 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 succesfully, the payout is intaited.
  • The platform will receive the confirmation of the settlement status from Decentro via the Settlement Status webhook.
Body Params
string
required

A unique identifier assigned by the merchant/client platform for every API request.

string
required

A unique identifier assigned by Decentro during onboarding.

string
required

The unique reference number for the target beneficiary. Received from Decentro in the Create Beneficiary Profile API response

string

Conditional Mandatory: The unique reference number for the target payment address. Received from Decentro in the Map Payment Address API response. This value is only mandatory when there is no default payment address mapped to a beneficiary or if you want to transfer funds to a specific payment address.

string

Conditional Mandatory: The Virtual Account number is mandatory only when the beneficiary was not mapped to a specific VA during the beneficiary creation process. If the beneficiary was mapped to a VA during the creation process, Decentro will debit the funds from that VA.

string
required

The transfer amount, up to 2 decimal places. The source currency will always be defined by the currency of the virtual account utilised for the settlement/payour

string
required

Text field which can be used for narrating the purpose of the fund transfer. Min length: 5 characters, Max length: 50 characters. Only alphanumeric characters are allowed.

Headers
string
required

The client identifier assigned by Decentro during onboarding.

string
required

The authorisation secret assigned by Decentro during onboarding.

Responses

Updated 1 day ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 day ago

Did this page help you?