Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

10. Available Webhooks

This platform uses webhooks to notify your application for the following action categories

  1. Onboarding: You will receive webhooks when a merchant is created and updated, as well as when there is a change in the onboarding status. Additionally, webhooks will be sent for the initiation of bank account micro-deposits, when the account is ready for verification, and for both successful and failed verification attempts. For specific event names and sample payload examples, please consult the documentation located here.

  2. Gateway: Webhooks will be triggered when a gateway is created, updated, or deleted for a merchant. These events help keep your system in sync with changes to gateway configurations, such as enabling/disabling a gateway or modifying gateway-specific settings. For specific event names and sample payload examples, please consult the documentation located here.

  3. Transaction processing: this platform sends numerous webhook events for various types of transactions, including authorization, voiding, credit card sales, capture, transaction failures, refunds, credit transactions, ACH sales, and device sale. For specific event names and sample payload examples, please consult the documentation located here.

  4. Payment Links: Webhooks will be sent for the payment link creation, updating and cancellation. Refer here for the payload examples.

  5. Subscriptions: Similar to payment links, you will receive the webhooks for the creation, updating and cancellation of the subscriptions. Please consult the documentation located here for the payload examples.

  6. Batch: When the payment batch is generated, BATCH_GENERATED webhook will be sent. Please refer here for the payload example.

  7. Dispute management: The platform will send a dispute_created webhook when the transaction is disputed and dispute_information_updated when the information is updated. Please refer here for the details

Following are all the webhook events available:

1. Onboarding

Following are the webhook events for various onboarding activities

MERCHANT_CREATED

After a merchant is created, the platform will send a MERCHANT_CREATED webhook event

{
  event_uid: '220489c0dfa263d19ee1796973cdc9f6',
  event: 'MERCHANT_CREATED',
  data: {
    id: 'c404d923-226f-4aae-92da-22c1ef370434',
    account_id: 'e90c1de6-4e87-4c9e-bcbc-c535d6e349ec',
    merchant_id: 'c404d923-226f-4aae-92da-22c1ef370434'
  }
}

b. MERCHANT_UPDATED

When a merchant’s fee schedule is updated, this webhook event will include the following fields:

  • fee_schedule_id – The ID of the newly assigned fee schedule.

  • old_fee_schedule_id – The ID of the previous fee schedule before the change.

c. MERCHANT_STATUS_CHANGED

d. MICRO_DEPOSIT_INITIATED

e. MICRO_DEPOSIT_READY_FOR_VERIFICATION

f. MICRO_DEPOSIT_VERIFIED

g. MICRO_DEPOSIT_VERIFICATION_FAILED

h. MERCHANT_FEE_UPDATED

When the fee schedule is changed, below webhook event is sent

Gateway Configuration

Below is a list of webhook events related to gateway configuration. These events are triggered when a gateway is created, updated, or deleted for a merchant account.

1. GATEWAY_CREATED

Triggered when a new gateway is successfully configured for a merchant.

Sample Payload

2. GATEWAY_UPDATED

Triggered when an existing gateway’s configuration or status (e.g., enabled/disabled) is updated.

Sample Payload

3. GATEWAY_DELETED

Triggered when a gateway is removed or deactivated from a merchant’s configuration.

Sample Payload

Transactions

Below is a list of webhook events for different types of transactions

1. PAYMENT_AUTH

Triggered when an authorization transaction is created (Refer here on auth transaction).

2. PAYMENT_AUTH_FAILED

Triggered when the authorization transaction fails, indicating that the payment authorization could not be completed.

3. PAYMENT_VOIDED

Triggered when a payment transaction is successfully voided, meaning the transaction is canceled before processing or settlement. (Refer here for instructions on how to void a transaction)

4. PAYMENT_VOIDED_FAILED

Triggered when an attempt to void a payment fails, indicating that the transaction cancellation could not be completed.

5. PAYMENT_CAPTURED

Triggered when a payment authorization is successfully captured (Refer here for details on capturing a transaction)

6. PAYMENT_CAPTURE_FAILED

Triggered when a capture transaction fails

7. PAYMENT_SALE

Triggered when a sale transaction is created, indicating that the payment has been successfully authorized and captured in a single operation

8. PAYMENT_FAILED

Triggered for any auth/sale request failure. For example if you trigger a TTP transaction and it is cancelled at the device you will receive this webhook or if card is declined while while processing this webhook is triggered.

9. DEVICE_SALE_CANCEL

Triggered when a device sale transaction is canceled

10. PAYMENT_ACH

Triggered when an ACH payment is processed

11. PAYMENT_REFUNDED

Triggered when a transaction is successfully refunded

12.PAYMENT_ACH_REFUNDED

Triggered when an ACH sale transaction is refunded.

13. ADJUSTMENT_RECEIVED

Triggered when settlement files are processed and any kind of adjustment to the payout is made by processor.

14. ACH_CREDIT_ISSUED (deprecated)

15. OFFLINE_SALE

Triggered when an offline sale request is successfully completed.

16. TRANSACTION_STATUS_CHANGED

Triggered when transaction status is changed after processing. It is applicable to mainly ACH transaction where after initial authorization the funding failed

Payment Links

Following webhook events are sent after payment link is created, updated, cancelled and paid

a. PAYMENTLINK_CREATED

b. PAYMENTLINK_CANCELLED

c. PAYMENTLINK_UPDATED

d. PAYMENTLINK_PAID

e. PAYMENTLINK_TOKEN_CREATED

This webhook is triggered only when tokenize_only is set to true and the type is payment_session during payment link creation

Sample for bank token

Subscriptions

Following are the webhook events for various subscription related actions

a. SUBSCRIPTION_CREATED

b. SUBSCRIPTION_CANCELLED

c. SUBSCRIPTION_UPDATED

BATCH_GENERATED

When the payment batch is generated, below webhook event is sent

Dispute Management

Following webhook events are sent related to the disputes

a. DISPUTE_CREATED

b. DISPUTE_INFORMATION_UPDATED

PAYOUT_GENERATED

When the payout is generated, below webhook event is sent

Previous9. Available Web-ComponentsNextOverview

Last updated