Webhook (S2S)

post

https://example.com/tnc/{clientUri}

Checkout provides webhook calls for latest transaction updates. User can register for webhook based on events. Refer list of allowed webhook events. Webhook calls are available for payment transactions, capture transactions and refund transactions.

In response of webhook, checkout expects 200 OK as HTTP status and a valid JSON body as acknowledgement from the receiving server. If acknowledgement is not provided or it is not in the mentioned format, then webhook call will be re-attempted. It will be re-attempted for 7 times with an increasing delay every time. These re-attempts last till approx. 38 hours starting from the original attempt.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientUri

string

required

The payment gateway for which the webhook is being sent. This should match the gateway used in the transaction.

Body Params

Schema for auth, purchase, or capture transaction webhook payload

transactionUtr

string

required

length ≤ 45

^txn[_0-9A-Za-z]+

Unique transaction reference (UTR) number generated by checkout for original auth/purchase transaction

captureUtr

string

length ≤ 45

^cptr[_0-9A-Za-z]+

Unique transaction reference (UTR) number generated by checkout for original capture transaction. Present only if it is capture transaction.

refundUtr

string

length ≤ 45

^rfnd[_0-9A-Za-z]+

Unique transaction reference (UTR) number generated by checkout for refund transaction. Present only if it is a refund transaction.

transactionStatus

string

required

length ≤ 45

Reflects the latest status of the transaction. Refer Checkout Transaction Status.

gatewayUtr

string

required

length ≤ 45

Unique transaction reference (UTR) number received from the PG

bankUtr

string

length ≤ 45

^[0-9]+$

Unique transaction reference (UTR) number received from the issuer bank. C – If available from processor.

amount

string

required

length ≤ 20

^[0-9]+$

Amount which is processed by vendor for this transaction.

currency

string

required

length ≤ 3

^[A-Z]{3}$

Currency in which transaction is done. It is in ISO 4217 describing three-letter codes for currency. e.g. USD, EUR, AED, INR etc.

appUtr

string

required

length between 5 and 25

^[a-zA-Z0-9]+$

App UTR echoed back from original transaction request.

orderId

string

length ≤ 18

^[0-9A-Za-z]+$

Order Id echoed back from original transaction request.

refundedAmount

string

length ≤ 20

^[0-9]+$

The amount which is refunded by processor for this transaction. C – Present only if the transactionType is REFUND.

refundedOn

date-time

^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

Datetime when transaction is refunded. C – Present only if the transactionType is REFUND and it is refunded successfully. Format: yyyy-MM-dd HH:mm:ss.

externalCustomerReference

string

length ≤ 20

^[A-Za-z0-9]+$

External customer reference supplied by merchant. C – If available from processor.

authUtr

string

length ≤ 25

^[a-zA-Z0-9]+$

Auth code provided by PG.

paymentChannel

string

length ≤ 25

Payment channel using which payment has been completed. If PG is not providing this detail, then payment method submitted while creating the transaction will be echoed back which could be ALL as well.

paymentMode

string

enum

length ≤ 25

Payment mode using which payment has been completed. If PG is not providing this detail then payment method submitted while creating the transaction will be echoed back.

Allowed:

settlementDate

date-time

^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

Present only if transaction is settled. Format: yyyy-MM-dd HH:mm:ss

instrumentDetails

object

Details of the user instrument. C – If available from processor.

gatewayDetails

object

Details of the processor/gateway. C – If available from processor.

additionalDetails

object

Additional metadata of the transaction. C – If available from processor.

authenticationDetails

object

Transaction authorization details. C – If available from processor.

riskDetails

object

Details on transaction risks. C – Post transaction authorization, if available from processor.

customerDetails

object

Customer details including address. M.

billingCurrency

string

length ≤ 3

^[A-Z]{3}$

Currency in which transaction is processed. It is in ISO 4217 describing three-letter codes for currency. e.g. USD, EUR, AED, INR etc. C – Post transaction authorization, if value is available will be provided in webhook call.

billingAmount

string

length ≤ 20

^[0-9]+$

Billing amount of the currency if transaction has been processed in different currency. C – Post transaction authorization, if value is provided by processor.

emiDetails

object

Additional info for EMI details. C – If available from processor.

transactionType

string

required

length ≤ 25

^(PURCHASE|AUTH|CAPTURE|REFUND)$

Type of the transaction

timestamp

date-time

required

^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

Format: yyyy-MM-dd HH:mm:ss

Response

200Successful acknowledgement of the webhook