Settlement Status Updates Webhook

post

https://stagingglobal.decentro.tech/customendpoint

This webhook service is used by Decentro to trigger the status of a settlement/payout to pre-configured endpoint of the platform.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

This callback allows the platform to proactively receive a settlement's status to their pre-configured endpoint. The settlement transaction can be initated against any collection mode.

Points to Note

This callback is triggered 3 times per transaction.
This callback only propagates the status of the settlement transaction/payout
This callback is triggered when a transaction status moves to one of SUCCESS or FAILURE.
Note: This callback is not triggered by Decentro if the settlement request itself fails due to an invalid payload, beneficiary details being incorrect, etc.

Flow

The platform has collected funds via Decentro using any of the supported collection channels.
Settlements are auto-triggered by Decentro as per the commercial agreement with the platform or the platform requests a payout against the funds deposited into a Virtual Currency Account.
The platform receives this callback on its pre-configured endpoint, including the settlement details.

Body Params

callback_attempt

string

required

Number of times the callback has been attempted.

callback_timestamp

string

required

Timestamp when the callback was triggered. Not the timestamp of the transaction

callback_txn_id

string

required

Unique identifier mapped to the callback attempt.

decentro_txn_id

string

required

A unique identifier, passed against the settlement payout, by Decentro at the time of transaction initiation.

original_callback_txn_id

string

required

Unique identifier mapped to the first callback attempt.

settlement_account_bic

string

required

The bank identification code of the beneficiary account to which settlement has been processed.

settlement_account_urn

string

required

The unique reference number mapped against the settlement account in the Decentro system.

settlement_status

string

required

The status of the transaction.

settlement_status_message

string

required

The message description of the settlement status

settlement_urn

string

required

The unique reference number in Decentro's system, used to track the settlement.

settlement_type

string

required

The collection channel (LRS, e-Collect, APMs) against which the settlement payout was initiated.

transfer_type

string

required

The transfer type of the settlement transaction. Possible values: SWIFT.

failure_reason

string

The message description outlining the reason for the settlement failure.

bank_error_code

string

The error/reject code propagated by our bank partners for the settlement failure.

gross_settlement_amount

string

required

The total amount collected against the collection channel (settlement_type) during the settlement cycle.

refund_amount

string

required

The amount deducted from the gross amount for refunds initiated during the settlement cycle.

chargeback_amount

string

required

The amount deducted from the gross amount for chargebacks accepted during the settlement cycle.

lien_amount

string

required

The amount deducted from the gross amount against any active liens against the platform in Decentro's system.

net_settlement_amount

string

required

The net payable amount which will be settled with the platform.

currency

string

required

The currency in which the funds were settled.

swift_uetr

string

required

A Unique End-to-End Transaction Reference (UETR) alphanumeric code assigned to every international SWIFT payment to track its status across the entire banking network

virtual_currency_account_number

string

Only applicable for payout requests against a virtual currency account. Denotes the account number against which the settlement/payout was requested.

updated_balance

string

Only applicable for payout requests against a virtual currency account. Denotes the updated balance of the virtual account.

retry_count

string

Only applicable for failed settlements. Denotes the number of payout attempts performed by Decentro against the settlement_urn. Our system will attempt to complete the payout 3 times.

next_retry_at

string

Only applicable for failed settlements. Denotes the timestamp at which our system will attempt the next 'retry'.

Headers

your_custom_key_1

string

The header token shared by you should not contain any unsanitized values like @ # $ % ^ & * ! ; : ' " ~ ` ? = + ) (

your_custom_key_2

string

The header token shared by you should not contain any unsanitized values like @ # $ % ^ & * ! ; : ' " ~ ` ? = + ) (

Responses

Overview

Points to Note

Flow

200

400Bad Request