Skip to content

Suggested

Dashboard
Transaction status webhook

Signed payload Conomy sends to your configured webhook URL when a transaction status changes.

Objects

Webhook configuration object

Default webhook URL.

defaultcvu.staticcvu.dynamic
defaultcvu.staticcvu.dynamic

Per-flavor webhook URLs keyed by flavor.

Webhook event object

payment.createdpayment.authorizedpayment.capturedpayment.receivedpayment.settledpayment.unsettledpayment.expiredpayment.failedpayment.refundedpayment.requiresReviewpayment.attemptedpayment.amountMismatchpayment.underpaidpayment.overpaidpayment.pendingAssignmentpayment.reviewApprovedpayment.reviewRejectedpayment.reviewResolvedpayment.refund.createdpayment.refund.settledpayment.refund.failedcustomer.levelChangedpayment.statusChanged

Optional raw discriminator that produced the eventType, for example attempted, settled, or refundCreated.

Transaction snapshot included in a webhook delivery.

idstringrequired

Unique identifier of the Conomy transaction.

externalIdstring

External identifier provided by the merchant or provider.

totalAmountstring

Total amount processed for the transaction.

currencystring

Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., CLP, ARS, MXN). Go to the currencies page for the complete list of supported values.

productstring

Canonical purchaseCurrency:currency pair for the transaction, for example ARS:ARS or ARS:USDT.

purchaseAmountstring

Amount paid by the payer in purchaseCurrency.

purchaseCurrencystring

Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., CLP, ARS, MXN). Go to the currencies page for the complete list of supported values.

statusstringrequired
CREATEDATTEMPTPENDINGAUTHORIZEDPENDING_CAPTUREDCAPTUREDRECEIVEDSETTLEDUNSETTLEDEXPIREDFAILEDREQUIRES_REVIEWREFUNDED
typestring
descriptionstring

Transaction description when provided by the payment flow.

parentPaymentIdstring
relatedPaymentIdstring
settledAtstringdate-time
expiredAtstringdate-time
unsettledAtstringdate-time
unsettledReasonstring
settlementBatchIdstring
documentationStatusstring
PENDING_UPLOADUPLOADEDAPPROVEDREJECTEDSENT
customerIdstring
originatorobject

Payer/originator details. For CVU deposits, bankAccount and cvu carry the payer-side account number when the originating rail provides it. clearinghouseId is optional and may appear on any rail that exposes a clearinghouse reference; availability depends on the rail.

idstring
emailstringemail

Webhook transaction object

Unique identifier of the Conomy transaction.

External identifier provided by the merchant or provider.

Total amount processed for the transaction.

Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., CLP, ARS, MXN). Go to the currencies page for the complete list of supported values.

Canonical purchaseCurrency:currency pair for the transaction, for example ARS:ARS or ARS:USDT.

Amount paid by the payer in purchaseCurrency.

Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., CLP, ARS, MXN). Go to the currencies page for the complete list of supported values.

CREATEDATTEMPTPENDINGAUTHORIZEDPENDING_CAPTUREDCAPTUREDRECEIVEDSETTLEDUNSETTLEDEXPIREDFAILEDREQUIRES_REVIEWREFUNDED

Transaction description when provided by the payment flow.

PENDING_UPLOADUPLOADEDAPPROVEDREJECTEDSENT

Payer/originator details. For CVU deposits, bankAccount and cvu carry the payer-side account number when the originating rail provides it. clearinghouseId is optional and may appear on any rail that exposes a clearinghouse reference; availability depends on the rail.

Signed payload Conomy sends to your configured webhook URL when a transaction status changes. This callback is delivered to your application; you do not call this endpoint against the Conomy API. If you configured a secretKey, verify the X-Webhook-Signature header before processing the event.

WEBHOOKtransactionStatusChanged
Conomy → your URL

HMAC-SHA256 hex digest of the raw request body, present when a secretKey is configured.

Transaction status event delivered to the client webhook URL.

payment.createdpayment.authorizedpayment.capturedpayment.receivedpayment.settledpayment.unsettledpayment.expiredpayment.failedpayment.refundedpayment.requiresReviewpayment.attemptedpayment.amountMismatchpayment.underpaidpayment.overpaidpayment.pendingAssignmentpayment.reviewApprovedpayment.reviewRejectedpayment.reviewResolvedpayment.refund.createdpayment.refund.settledpayment.refund.failedcustomer.levelChangedpayment.statusChanged

Optional raw discriminator that produced the eventType, for example attempted, settled, or refundCreated.

Transaction snapshot included in a webhook delivery.

idstringrequired

Unique identifier of the Conomy transaction.

externalIdstring

External identifier provided by the merchant or provider.

totalAmountstring

Total amount processed for the transaction.

currencystring

Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., CLP, ARS, MXN). Go to the currencies page for the complete list of supported values.

productstring

Canonical purchaseCurrency:currency pair for the transaction, for example ARS:ARS or ARS:USDT.

purchaseAmountstring

Amount paid by the payer in purchaseCurrency.

purchaseCurrencystring

Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., CLP, ARS, MXN). Go to the currencies page for the complete list of supported values.

statusstringrequired
CREATEDATTEMPTPENDINGAUTHORIZEDPENDING_CAPTUREDCAPTUREDRECEIVEDSETTLEDUNSETTLEDEXPIREDFAILEDREQUIRES_REVIEWREFUNDED
typestring
descriptionstring

Transaction description when provided by the payment flow.

parentPaymentIdstring
relatedPaymentIdstring
settledAtstringdate-time
expiredAtstringdate-time
unsettledAtstringdate-time
unsettledReasonstring
settlementBatchIdstring
documentationStatusstring
PENDING_UPLOADUPLOADEDAPPROVEDREJECTEDSENT
customerIdstring
originatorobject

Payer/originator details. For CVU deposits, bankAccount and cvu carry the payer-side account number when the originating rail provides it. clearinghouseId is optional and may appear on any rail that exposes a clearinghouse reference; availability depends on the rail.

idstring
emailstringemail
200Return any 2xx response after accepting the event. The response body is ignored.