POST requests from the TransactBridge server. Authorization headers are also included so that partners can authenticate that the request originated from the TransactBridge server.
Merchants can configure the Webhook URL from the TransactBridge Admin Panel to start receiving webhook events.
Admin Panel for Sandbox Navigate to callback Url’s section under the Account settings tab to configure the Webhook URL for sandbox environment.Admin Panel for Production Navigate to callback Url’s section under the Account settings tab to configure the Webhook URL for production environment.
Callback Response
Partners must respond to the webhook with the following JSON response and an HTTP200 status code:
- Only the above response with an HTTP 200 status code will be treated as a successful acknowledgement of the webhook.
- If the merchant does not acknowledge the webhook, TransactBridge will retry sending the webhook. A maximum of 3 attempts will be made.
- If the partner fails to acknowledge the webhook after all 3 attempts, TransactBridge will stop sending subsequent retries for that event.
- Partners can also resend the webhook from the Partner Dashboard if required.
Signature Verification
TransactBridge uses the same method to generate the signature that is included in the authorization headers. Partners should verify the signature before processing the webhook to ensure that the request originated from the TransactBridge server and that the payload has not been modified.Sample Session Status
This webhook event is sent to the configured partner URL when the session has a status change. Session status can be CREATED , STARTED, CLOSED, EXPIRED, FAILED.There are other conditional parameters in the billing session api, which can be passed by the merchant at the time of session creation. And these parameters will be sent back to the merchant in the webhook response.
Sample Transaction Status
This webhook event is sent to the configured partner URL whenever the transaction status changes. The transaction can have one of the following statuses:PENDING, PROCESSING, SUCCESS, or FAILED.
Session Status
- CREATED: A session has been created but the link has not been used by the customer to initiate the payment window.
- STARTED: When the customer opens the payment link and proceeds with accepting TnC.
- CLOSED: Payment has been successfully done by the customer and an invoice has been created.
- EXPIRED: In case of non-payment, the link will be expired after a configured interval. Partners can pass the expiry date at the time of session creation. The default expiry date is 24 hours from the time of the creation of the session.
- REJECTED: This status needs to be enabled by the Admin Team, once done, if a customer clicks on “Back to Shopping” on the payment page then the billing session will be marked REJECTED and no further attempts will be allowed.
- FAILED: If Payment has failed in case where isSingleAttempt is passed as true in create session api only the session will be marked as failed.
- If the transaction status is processing or pending in that case the session will be marked as STARTED.
- Merchant should rely on session status.