API Reference
Get StartedExport API CollectionSupport

Account Balance Callback/Webhook

post
https://your.custom.endpoint.com/account_balance/clientcustomendpoint

Overview

The platform can use this callback to receive the updated balance of the consumer (receiving entity) after a successful credit or when a debit happens towards a refund or settlement. This callback helps the platform maintain a running balance after each transaction. If you are looking only for the latest balance, you can also use Decentro's merchant dashboard against a consumer to see the latest balance.

A balance callback due to a credit transaction can be received for the below scenarios.

A balance callback due to a debit transaction can be received for the below scenarios.

  • Refund API
  • Settlement-related debit to the platform's bank account

Flow

Below is the flow for receiving the callback.

  • The platform asks Decentro to configure an endpoint against which the balance callbacks will be triggered by dropping a mail at [email protected]
  • The platform creates a payment request, and a successful transaction is processed through any of the support models mentioned above
  • Decentro triggers a balance callback to the configured endpoint after the Terminal Transaction Status Callback/Webhook is triggered with type = CREDIT.
  • The platform initiates a refund request against a transaction using the Refund API. The callback is also triggered with type = DEBIT in such a scenario.
  • Decentro initiates a settlement to the platform's bank account per the settlement schedule. The callback is also triggered with type = DEBIT in such a scenario.

The platform can use the decentroTxnId parameter from the original transaction initiation to map the balance at its end.

Body Params
string
required

Number of times the callback has been attempted.

string
required

Unique identifier mapped to the callback attempt.

string
required

Unique urn assigned to client that they pass in request payload for creating a payment link, collect request or dynamic QR.

string
required

Timestamp of the Callback. Not the transaction itself.

string
required

Unique identifier mapped to the callback.

string
required

Possible values = Credit or Debit

string
required

The updated balance of the account mapped to consumer URN

string
required

The method of collection. Describes whether the funds were received via a payment link, dynamic QR, collect request, or a static QR. Only applicable for collection transactions.

string
required

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

string
required

The transaction amount.

string

Possible values: MAIN or COMMISSION

string

The internal account number where the funds are collected.

string

The account IFSC of the payee account number

string

Description message to be shown after the completion of payment.

string

Values: IMPS, RTGS, NEFT. Only passed in virtual account based collections.

string

decentro_txn_id of the transaction that is already in terminal state.

string

Account number of the payer/remitter. Passed only for virtual account based collections if provided by the bank partner.

Headers
string

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

string

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

Responses

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