Create a chargeback [Early Access]

Please note that this an Early Access phase. <br><br> Use this endpoint to record a chargeback for a specific payment via the payment connector. The payment connector calls it when the payment gateway (e.g. Adyen) reports a dispute for a payment. <br><br> It supports two stages of chargebacks: <br> - first – records a first chargeback (initial dispute). For Cleeng-managed subscriptions, a refund is triggered if the payment has not already been refunded. <br> - second – records a second chargeback (dispute lost). No refund is triggered, and a first chargeback must already exist for the same payment. <br><br> Each stage can be recorded only once per payment; a duplicate request for the same stage is rejected.

post/payments/{paymentId}/chargeback

Request

  • Base URL
    https://api.sandbox.cleeng.com/3.1
  • URL
    https://api.sandbox.cleeng.com/3.1/payments/{paymentId}/chargeback
  • Auth
    API key in header X-Publisher-Token

Path parameters

paymentIdinteger required

ID of the payment the chargeback applies to.

Headers

Content-Typestring

Request body

typestring required

The stage of the chargeback. Accepted values: first (initial dispute) or second (dispute lost).

occurredAtinteger required

The exact time the dispute event occurred at the payment gateway (currently supported: Adyen), represented as a positive Unix timestamp in seconds.

externalIdstring

An external reference for the dispute (e.g. an Adyen dispute ID). Maximum length: 64 characters.

Response

Created

object required

Changes

No recorded changes to this operation across all 1 revision of this API.