Skip to main content
API docs by Redocly

Convenient Checkout WebHooks (v2)

Download OpenAPI specification:Download

CCGLeads: CCGLeads@ds.uhc.com Terms of Service

Convenient Checkout Gateway WebHooks provide real-time notifications for payment events and payment method management. These webhooks enable merchant systems to stay synchronized with customer payment activities, allowing for immediate response to payment lifecycle events and facilitating seamless integration with your business systems.

Payment

Webhooks related to payment events, such as payment success, failure, or cancellation. These events allow for real-time monitoring of payment lifecycle status changes and enable immediate actions based on payment outcomes.

PAYMENT_SUCCEEDED Webhook

This webhook is triggered when a payment is successfully completed. It provides comprehensive details about the payment transaction, including transaction ID, amount, currency, payment method used, and customer information.

  • Applicability:
    • Payment Methods: CARD, BANK_ACCOUNT
    • Payment Type: SALE, PRE-AUTH

Merchants can use this notification to update order status, trigger fulfillment processes, send customer confirmations, and reconcile payment records in their systems.

Authorizations:
OAuth2JWTAuth
Request Body schema: application/json

Payload containing details of the successful payment event, including transaction identifiers, payment amounts, timestamps, payment method details, and relevant customer information needed for reconciliation and fulfillment processes.

name
string
Value: "PAYMENT_SUCCEEDED"
source
string

Indicates the X-source header value received in API request

object

Responses

Request samples

Content type
application/json
{
  • "name": "PAYMENT_SUCCEEDED",
  • "source": "string",
  • "payload": {
    }
}

PAYMENT_AUTHORIZED Webhook

This webhook is triggered when a payment is authorized but not yet captured. It provides details about the authorization event, including transaction ID, authorized amount, currency, payment method used, and customer information.

  • Applicability:
    • Payment Methods: CARD
    • Payment Type: PRE-AUTH

Merchants can use this notification to prepare for order fulfillment, update authorization records, and manage inventory based on authorized transactions.

Authorizations:
OAuth2JWTAuth
Request Body schema: application/json

Payload containing details of the payment authorization event, including transaction identifiers, authorized amounts, timestamps, payment method details, and relevant customer information needed for order preparation and inventory management.

name
string
Value: "PAYMENT_AUTHORIZED"
source
string

Indicates the X-source header value received in API request

object

Responses

Request samples

Content type
application/json
{
  • "name": "PAYMENT_AUTHORIZED",
  • "source": "string",
  • "payload": {
    }
}

PAYMENT_CANCELLED Webhook

This webhook is triggered when a payment is cancelled. It provides details about the cancellation event, including transaction ID, amount, currency, payment method used, and customer information.

  • Applicability:
    • Payment Methods: CARD, BANK_ACCOUNT
    • Payment Type: SALE, PRE-AUTH

Merchants can use this notification to update order status, reverse inventory allocations, notify customers of the cancellation, and reconcile payment records in their systems.

Authorizations:
OAuth2JWTAuth
Request Body schema: application/json

Payload containing details of the payment cancellation event, including transaction identifiers, amounts, timestamps, payment method details, and relevant customer information needed for order updates and inventory management.

name
string
Value: "PAYMENT_CANCELLED"
source
string

Indicates the X-source header value received in API request

object

Responses

Request samples

Content type
application/json
{
  • "name": "PAYMENT_CANCELLED",
  • "source": "string",
  • "payload": {
    }
}

PAYMENT_ACCEPTED Webhook

This webhook is triggered when a payment is accepted for processing. It provides details about the acceptance event, including transaction ID, amount, currency, payment method used, and customer information.

  • Applicability:
    • Payment Methods: BANK_ACCOUNT
    • Payment Type: SALE
Authorizations:
OAuth2JWTAuth
Request Body schema: application/json

Payload containing details of the payment acceptance event, including transaction identifiers, amounts, timestamps, payment method details, and relevant customer information needed for order updates and fulfillment preparation.

name
string
Value: "PAYMENT_ACCEPTED"
source
string

Indicates the X-source header value received in API request

object

Responses

Request samples

Content type
application/json
{
  • "name": "PAYMENT_ACCEPTED",
  • "source": "string",
  • "payload": {
    }
}

PAYMENT_FAILED Webhook

This webhook is triggered when a payment fails. It provides details about the failure event, including transaction ID, amount, currency, payment method used, timestamp, customer information, and failure reason.

  • Applicability:
    • Payment Methods: CARD, BANK_ACCOUNT
    • Payment Type: SALE, PRE-AUTH

Merchants can use this notification to update order status, notify customers of the failure, and take corrective actions such as retrying the payment or requesting alternative payment methods.

Authorizations:
OAuth2JWTAuth
Request Body schema: application/json

Payload containing details of the payment failure event, including transaction identifiers, amounts, timestamps, payment method details, failure reasons, and relevant customer information needed for order updates and customer notifications.

name
string
Value: "PAYMENT_FAILED"
source
string

Indicates the X-source header value received in API request

object

Responses

Request samples

Content type
application/json
{
  • "name": "PAYMENT_FAILED",
  • "source": "string",
  • "payload": {
    }
}

Refund

Webhooks related to refund events, such as successful refunds, refund failures, or refund pending. These notifications help merchants track the status of refunds and update customer accounts accordingly.

REFUND_SUCCESS Webhook

This webhook is triggered when a refund is successfully processed. It provides details about the refunded transaction, including transaction ID, amount refunded, currency, timestamp, and customer information.

  • Applicability:
    • Payment Methods: CARD, BANK_ACCOUNT

Merchants can use this notification to update order status, notify customers of successful refunds, and reconcile financial records in their systems.

Authorizations:
OAuth2JWTAuth
Request Body schema: application/json

Payload containing details of the successful refund event, including transaction identifiers, refund amounts, timestamps, and relevant customer information needed for reconciliation and customer communication.

name
string
Value: "REFUND_SUCCESS"
source
string

Indicates the X-source header value received in API request

object

Responses

Request samples

Content type
application/json
{
  • "name": "REFUND_SUCCESS",
  • "source": "string",
  • "payload": {
    }
}

REFUND_PARTIAL_SUCCESS Webhook

This webhook is triggered when a refund transaction has mixed results - one refund succeeds while the other fails. It provides transaction details including successful and failed refund amounts. Merchants can use this to update order status and notify customers of the partial refund outcome.

  • Applicability:
    • Payment Methods: CARD, BANK_ACCOUNT

Merchants can use this notification to update order status, notify customers of successful refunds, and reconcile financial records in their systems.

Authorizations:
OAuth2JWTAuth
Request Body schema: application/json

Payload containing details of the partial successful refund event, including transaction identifiers, refund amounts, timestamps, and relevant customer information needed for reconciliation and customer communication.

name
string
Value: "REFUND_PARTIAL_SUCCESS"
source
string

Indicates the X-source header value received in API request

object

Responses

Request samples

Content type
application/json
{
  • "name": "REFUND_PARTIAL_SUCCESS",
  • "source": "string",
  • "payload": {
    }
}

REFUND_FAILED Webhook

This webhook is triggered when a refund fails to process. It provides details about the failed refund attempt, including transaction ID, failure reason, timestamp, and customer information.

  • Applicability:
    • Payment Methods: CARD, BANK_ACCOUNT

Merchants can use this notification to handle refund failures and update customer records accordingly.

Authorizations:
OAuth2JWTAuth
Request Body schema: application/json

Payload containing details of the failed refund event, including transaction identifiers, failure details, timestamps, and relevant customer information.

name
string
Value: "REFUND_FAILED"
source
string

Indicates the X-source header value received in API request

object

Responses

Request samples

Content type
application/json
{
  • "name": "REFUND_FAILED",
  • "source": "string",
  • "payload": {
    }
}

REFUND_PENDING Webhook

This webhook is triggered when a refund is in pending status. It provides details about the pending refund, including transaction ID, pending reason, timestamp, and customer information.

  • Applicability:
    • Payment Methods: CARD, BANK_ACCOUNT

Merchants can use this notification to track refund status and communicate with customers about processing delays.

Authorizations:
OAuth2JWTAuth
Request Body schema: application/json

Payload containing details of the pending refund event, including transaction identifiers, pending status details, timestamps, and relevant customer information.

name
string
Value: "REFUND_PENDING"
source
string

Indicates the X-source header value received in API request

object

Responses

Request samples

Content type
application/json
{
  • "name": "REFUND_PENDING",
  • "source": "string",
  • "payload": {
    }
}

Dispute

Webhook is related to when a dispute is initiated, updated, or resolved. It provides comprehensive details about the dispute case, including dispute ID, amount disputed, currency, reason for the dispute, status updates, timestamp, and involved customer information. Merchants can use this notification to manage their dispute resolution processes, update case statuses, communicate with customers, and maintain accurate records in their systems.

DISPUTE_INITIATED Webhook

This state indicates that a dispute has been recently opened or filed against a transaction. At this stage, necessary details about the transaction and the reason for the dispute are collected.

This is the initial phase where the merchant is notified and can begin gathering evidence or information to respond to the dispute.

Authorizations:
OAuth2JWTAuth
Request Body schema: application/json
eventType
string
Value: "DISPUTE_INITIATED"
object (DisputeWebhookResponse)

Responses

Request samples

Content type
application/json
{
  • "eventType": "DISPUTE_INITIATED",
  • "payload": {
    }
}

DISPUTE_WON Webhook

This state signifies that the dispute has been resolved in favor of the merchant. The merchant's evidence and arguments were successfully able to counter the claims of the dispute, leading to a decision that upholds the original transaction. As a result, the disputed amount is not returned to the customer, and the case is closed.

Authorizations:
OAuth2JWTAuth
Request Body schema: application/json
eventType
string
Value: "DISPUTE_WON"
object (DisputeWebhookResponse)

Responses

Request samples

Content type
application/json
{
  • "eventType": "DISPUTE_WON",
  • "payload": {
    }
}

DISPUTE_LOST Webhook

This state indicates that the dispute has been resolved in favor of the customer. Despite the merchant's efforts to contest the dispute, the decision was made to refund the disputed amount to the customer. This resolution might require the merchant to make adjustments in their records and possibly review internal processes to prevent future disputes.

Authorizations:
OAuth2JWTAuth
Request Body schema: application/json
eventType
string
Value: "DISPUTE_LOST"
object (DisputeWebhookResponse)

Responses

Request samples

Content type
application/json
{
  • "eventType": "DISPUTE_LOST",
  • "payload": {
    }
}