API Reference
Get StartedExport API CollectionSupport

Settlement Status Callback/Webhook

post
https://your.custom.endpoint.com/settlement_status/customendpoint

This callback is used by Decentro to trigger the status of a settlement to pre-configured endpoint of the platform.

Overview

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

  • Virtual account-based collection

The platform can share the endpoint for configuring this callback before going live at [email protected].

Points to Note

Key points to note.

  • This callback is triggered 3 times per transaction.
  • This callback only propagates the transaction status
  • 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

Below is the flow for using the callback capability as part of Decentro

  • The platform has collected funds using Decentro using any of the modes supported.
  • The platform requests a settlement using the Request settlements API or settlements are auto-triggered by Decentro as per the commercial agreement with the platform.
  • The platform receives this callback on its pre-configured endpoint, including the settlement details like UTR, etc.
Body Params
string
required

The transaction amount.

string
required

The unique transaction reference number from the bank partner

string
required

Number of times the callback has been attempted.

string
required

Timestamp of the callback. Not the timestamp of the transaction.

string
required

Unique identifier mapped to the callback attempt.

string
required

The unique transaction identifier, passed against the payment request, by Decentro at the time of transaction initiation.

string

Unique identifier mapped to the first callback attempt.

string

The ifsc of the account number against which settlement has been processed.

string

The account number against which settlement has been processed.

string

The settlement account urn mapped against the settlement account.

string
required

The status of the transaction.

string

The message description of the settlement status

string

The settlement_urn received during requesting the settlements.

string

The transfer type of the settlement transaction. Possible values: RTGS, IMPS, NEFT

string

The updated balance of in the Decfin system after settlements.

string

The virtual account number against which the settlement was triggered by Decentro.

Headers
string
required

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

string
required

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

Response

Updated over 1 year ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 1 year ago