E-Collect Transaction Status Update Webhook

post

https://stagingglobal.decentro.tech/customendpoint-1

This webhook service is used by Decentro to trigger the status of a collection transaction to the 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 transaction's status updates without having to poll for it from their end, thus reducing the computational burden and making it more efficient to propagate the status to the payer.

This callback allows a platform to receive the status of an incoming fund transfer to a Virtual Currency Account.

Points to Note

This callback is triggered 3 times per transaction.
This callback is triggered when a transaction status moves to a terminal state (SUCCESS, FAILURE).

Currency Units
All amounts are shared in the base currency unit (example: Cents, Pence, Paisa, Centavos). Kindly convert the base currency into the primary currency unit (Dollar, Pounds, Rupees) as per your technical and business requirements.

Currency 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

Currency	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

Body Params

callback_attempt

integer

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.

original_callback_txn_id

string

required

Unique identifier mapped to the first callback attempt.

decentro_txn_id

string

required

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

consumer_urn

string

required

A unique identifier assigned to client's by Decentro during On boarding.

payment_channel

string

required

The collection channel (E-Collect) through which the payment was accepted.

virtual_currency_account_number

string

required

Denotes the account number to which the funds are credited.

virtual_currency_account_urn

string

required

Denotes the URN of the virtual currency account (VCA) to which the funds are credited.

opening_balance

integer

required

Denotes the balance of the VCA before the credit, expressed in base currency units (e.g., Cents, Pence, Paisa).

closing_balance

integer

required

Denotes the balance of the VCA after the credit, expressed in base currency units (e.g., Cents, Pence, Paisa).

payment_instrument

string

required

The specific payment rails through which the credit was received. Ex: SWIFT, SEPA, RTGS.

swift_uetr

string

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

remitter_bank_reference_number

string

The unique transaction reference number generated by the remitting bank.

transfer_advice_decentro_txn_id

string

Propagated only if the platform informed us of the incoming transfer via the Transfer Advice API.

transaction_status

string

required

The Status of the incoming credit. Possible Values: SUCCESS, FAILED, REVERSED.

transaction_status_description

string

required

Descriptive message for the corresponding transaction status value.

received_amount

integer

required

The amount credited to the VCA, expressed in base currency units (e.g., Cents, Pence, Paisa).

received_currency

string

required

The 3-letter ISO currency code (e.g., USD, EUR, GBP) corresponding to the received amount.

transaction_credit_date_time

string

required

The timestamp at which the amount was credited to the VCA.

purpose_message

string

Echoes the remarks/purpose message sent by the remitter/payer.

remitter_name

string

The name of the remitter/payer as per the details received against the credit transaction.

remitter_account_number

string

required

The bank account number of the remitter/payer as per the details received against the credit transaction.

remitter_country_code

string

required

The country of origin of the remitter/payer as per the details received against the credit transaction.

remitter_bic

string

required

The bank identification code of the remitting bank as per the details received against the credit transaction.

remitter_bank_name

string

The name of the remitting bank as per the details received against the credit transaction.

instructed_amount

integer

The amount sent by the remitter/payer as per the details received against the credit transaction, expressed in base currency units (e.g., Cents, Pence, Paisa).

instructed_currency

string

The 3-letter ISO currency code (e.g., USD, EUR, GBP) corresponding to the instructed amount.

applied_fx_rate

integer

The forex conversion factor, where applicable.

bank_deducted_charges

integer

The total fee or handling charges deducted by correspondent or remitting banks during the transfer, expressed in base currency units (e.g., Cents, Pence, Paisa).

bank_deducted_charges_currency

string

The 3-letter ISO currency code (e.g., USD, EUR, GBP) corresponding to the deducted bank charges.

charge_bearer

string

Specifies which party absorbs the transfer and intermediary bank fees under international SWIFT standards. Possible values: BEN (Beneficiary), OUR (Payer/Remitter), or SHA (Shared).

transaction_initiation_date

string

The timestamp or date when the payment transfer was initiated by the remitter at their bank.

remitter_address

string

The street address or full physical address details of the remitter/payer as provided by the ordering institution.

intermediary_bank_bic

string

The Business Identifier Code (BIC/SWIFT code) of the intermediary or correspondent bank through which the funds were routed.

intermediary_bank_name

string

The legal name of the intermediary or correspondent bank involved in routing the incoming transfer.

error_key

string

A unique error code returned by Decentro when an incoming transaction fails or is reversed.
Note: Not propagated for SUCCESS transactions.

error_key_description

string

A detailed, human-readable explanation of the error key explaining why the transaction failed or was reversed.

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

Currency Units

200

400Bad Request