Documentation

Webhook Events

📘

This section describes the available events in the Ecart Pay webhook integrations platform. These events are automatically triggered when relevant actions occur in enabled modules.

Available Modules

  • Billing
  • Direct Debits
  • Subscription
  • Transfer
  • Orders
  • Withdrawals

Events Table

EventDescription
billing_information.updatedEmitted when a client's billing information is created or updated.
billing_information.deletedEmitted when a client's billing information is deleted.
billings.createEmitted when a CFDI invoice is created through a Billing Provider (like Factura.com).
direct_debit.createdEmitted when a direct debit is created.
direct_debit.activatedEmitted when a direct debit is activated and ready for payments.
direct_debit.validation_approvedEmitted when direct debit validation (STP or KYC) is approved.
direct_debit.validation_rejectedEmitted when direct debit validation (STP or KYC) is rejected.
direct_debit.charge_createdEmitted when a manual charge is created on a variable direct debit.
direct_debit.payment_successEmitted when a direct debit payment is processed successfully.
direct_debit.payment_failedEmitted when a direct debit payment attempt fails.
direct_debit.pendingEmitted when a single-charge direct debit reaches max retry attempts.
direct_debit.cancelledEmitted when a direct debit is cancelled.
subscription.createdEmitted when a subscription is created.
subscription.payment_successEmitted when a suscription payment is processed succesfully.
subscription.payment_failedEmitted after two unsuccessful payment attempts.
subscription.pausedEmitted after five unsuccessful payment attempts.
subscription.cancelledEmitted when the subscription has been cancelled
transfer.createdEmitted when a payment transfer to a merchant is complete.
orders.confirmationEmitted when an order is paid for.
orders.createEmitted when an order is created
orders.updateEmitted when an order status changes.
withdrawals.processingEmitted when a withdrawal is created (default status).
withdrawals.paidEmitted when a withdrawal completes successfully.
withdrawals.cancelled

Billing module events

billing_information.updated

This event is triggered when a client creates or updates their billing information.

Payload Example

{
  "event": "billing_information.updated",
  "data": {
    "id": "67a3be71c388eff4563a0aa8",
    "provider_client_id": "67a3be71596b3124a992774a",
    "user_id": "1849",
    "provider_id": "62ab6f2172362c74e1328109",
    "account_id": "5d2d436e3199ae000449065b",
    "active": true,
    "billing_information": {
      "country_code": "ES",
      "email": "[email protected]",
      "name": "Sociedad 2",
      "business_type": "Persona Física",
      "taxid": "B02717973",
      "postal_code": "62210",
      "address1": "Camino al monte",
      "address2": "2",
      "state_code": "ES.PV.AA",
      "state_name": "Álava (ES-VI)",
      "city": "Ciudad 1",
      "provider_client_id": "67a3be71596b3124a992774a",
      "vat_info": {
        "error": "The VAT number is invalid.",
        "valid": false
      }
    },
    "created_at": "2025-02-05T19:39:29.587Z",
    "default": true,
    "updated_at": "2025-02-05T22:11:48.210Z",
    "raw": "Sociedad 2"
  }
}

billing_information.deleted

This event is triggered upon deleting the billing information.

Payload Example

{
  "event": "billing_information.deleted",
  "data": {
    "id": "67a3be71c388eff4563a0aa8",
    "provider_client_id": "67a3be71596b3124a992774a",
    "user_id": "1849",
    "provider_id": "62ab6f2172362c74e1328109",
    "account_id": "5d2d436e3199ae000449065b",
    "active": true,
    "billing_information": {
      "country_code": "ES",
      "email": "[email protected]",
      "name": "Sociedad 2",
      "business_type": "Persona Física",
      "taxid": "B02717973",
      "postal_code": "62210",
      "address1": "Camino al monte",
      "address2": "2",
      "state_code": "ES.PV.AA",
      "state_name": "Álava (ES-VI)",
      "city": "Ciudad 1",
      "provider_client_id": "67a3be71596b3124a992774a",
      "vat_info": {
        "error": "The VAT number is invalid.",
        "valid": false
      }
    },
    "created_at": "2025-02-05T19:39:29.587Z",
    "default": true,
    "updated_at": "2025-02-05T22:11:48.210Z",
    "raw": "Sociedad 2"
  }
}

billings.create

This event is triggered when a CFDI invoice is created through a Billing Provider (like Factura.com)..

Payload Example

{
  "status": "created",
  "id": "68e80ea38fc95d173f3aa440",
  "order_id": "68e7df0e788c6655fe08cb76",
  "link": "http://localhost:9000/billing?order_id=68e7df0e788c6655fe08cb76"
}

Direct Debit module events

direct_debit.created

This event is triggered when a new direct debit is created via the API.

Payload Example

{
  "event": "direct_debit.created",
  "data": {
    "message": "A new direct debit has been created.",
    "direct_debit_id": "682123abc456def789012345",
    "reference": 1234567,
    "status": "created",
    "currency": "MXN",
    "amount": 500.00,
    "is_recurring": true,
    "is_fixed_amount": true,
    "validation_level": 1,
    "customer_id": "64b2c3d4e5f67890abcdef12",
    "interval": "monthly",
    "concept": "Cargo por domiciliación"
  }
}


direct_debit.activated

This event is triggered when the direct debit has been activated and is ready to process payments. This can happen when:

  • The customer acknowledges and the payment method is already verified
  • An STP/CEP validation callback confirms the payment method
  • A KYC verification is approved (level 2)

Payload Example

{
  "event": "direct_debit.activated",
  "data": {
    "message": "The direct debit has been activated.",
    "direct_debit_id": "682123abc456def789012345",
    "reference": 1234567,
    "status": "active",
    "currency": "MXN",
    "amount": 500.00,
    "is_recurring": true,
    "is_fixed_amount": true,
    "validation_level": 1,
    "customer_id": "64b2c3d4e5f67890abcdef12",
    "payment_method_id": "64c3d4e5f67890abcdef1234",
    "interval": "monthly",
    "next_payment_date": "2026-06-01T00:00:00.000Z",
    "concept": "Cargo por domiciliación",
    "activation_source": "acknowledge",
    "activated_at": "2026-05-12T16:30:00.000Z"
  }
}



direct_debit.validation_approved

This event is triggered when a direct debit validation has been approved. This covers both STP (CLABE/CEP) validation and KYC (SumSub) identity verification.

Payload Example (STP validation)

{
  "event": "direct_debit.validation_approved",
  "data": {
    "message": "A direct debit validation has been approved.",
    "direct_debit_id": "682123abc456def789012345",
    "reference": 1234567,
    "status": "created",
    "currency": "MXN",
    "amount": 500.00,
    "is_recurring": true,
    "is_fixed_amount": true,
    "validation_level": 1,
    "customer_id": "64b2c3d4e5f67890abcdef12",
    "payment_method_id": "64c3d4e5f67890abcdef1234",
    "validation_type": "stp",
    "clave_rastreo": "MBAN020126051200001",
    "cep_url": "https://www.banxico.org.mx/cep/descarga.do?q=abc123",
    "validated_at": "2026-05-12T16:30:00.000Z"
  }
}

Payload Example (KYC validation)

{
  "event": "direct_debit.validation_approved",
  "data": {
    "message": "A direct debit validation has been approved.",
    "direct_debit_id": "682123abc456def789012345",
    "reference": 1234567,
    "status": "created",
    "currency": "MXN",
    "amount": 500.00,
    "is_recurring": true,
    "is_fixed_amount": true,
    "validation_level": 2,
    "customer_id": "64b2c3d4e5f67890abcdef12",
    "payment_method_id": "64c3d4e5f67890abcdef1234",
    "validation_type": "kyc",
    "verification_id": "64d4e5f67890abcdef123456",
    "kyc_review_answer": "GREEN",
    "kyc_review_status": "completed",
    "validated_at": "2026-05-12T16:30:00.000Z"
  }
}



direct_debit.validation_rejected

This event is triggered when a direct debit validation has been rejected. This covers both STP (CLABE/CEP) validation failures and KYC (SumSub) identity verification rejections.

Payload Example (STP rejection)

{
  "event": "direct_debit.validation_rejected",
  "data": {
    "message": "A direct debit validation has been rejected.",
    "direct_debit_id": "682123abc456def789012345",
    "reference": 1234567,
    "status": "created",
    "currency": "MXN",
    "amount": 500.00,
    "is_recurring": true,
    "is_fixed_amount": true,
    "validation_level": 1,
    "customer_id": "64b2c3d4e5f67890abcdef12",
    "payment_method_id": "64c3d4e5f67890abcdef1234",
    "validation_type": "stp",
    "clave_rastreo": "MBAN020126051200001",
    "rejected_at": "2026-05-12T16:30:00.000Z",
    "rejection_reason": "RFC mismatch"
  }
}

Payload Example (KYC rejection)

{
  "event": "direct_debit.validation_rejected",
  "data": {
    "message": "A direct debit validation has been rejected.",
    "direct_debit_id": "682123abc456def789012345",
    "reference": 1234567,
    "status": "created",
    "currency": "MXN",
    "amount": 500.00,
    "is_recurring": true,
    "is_fixed_amount": true,
    "validation_level": 2,
    "customer_id": "64b2c3d4e5f67890abcdef12",
    "payment_method_id": "64c3d4e5f67890abcdef1234",
    "validation_type": "kyc",
    "verification_id": "64d4e5f67890abcdef123456",
    "kyc_review_answer": "RED",
    "kyc_review_status": "completed",
    "rejected_at": "2026-05-12T16:30:00.000Z",
    "rejection_reason": "Document verification failed"
  }
}



direct_debit.charge_created

This event is triggered when a merchant creates a manual (variable) charge on an active direct debit via the API.

Payload Example

{
  "event": "direct_debit.charge_created",
  "data": {
    "message": "A new charge has been created on the direct debit.",
    "direct_debit_id": "682123abc456def789012345",
    "reference": 1234567,
    "status": "active",
    "currency": "MXN",
    "amount": 500.00,
    "is_recurring": true,
    "is_fixed_amount": false,
    "validation_level": 1,
    "customer_id": "64b2c3d4e5f67890abcdef12",
    "payment_method_id": "64c3d4e5f67890abcdef1234",
    "interval": "monthly",
    "concept": "Cargo por domiciliación",
    "order_id": "682abc123def456789012345",
    "order_amount": 750.00,
    "order_currency": "MXN",
    "scheduled_for": "2026-06-01T00:00:00.000Z",
    "source": "manual",
    "created_at": "2026-05-12T16:30:00.000Z"
  }
}



direct_debit.payment_success

This event is triggered when the bank (Santander) response file confirms that a pending payment order was collected successfully from the customer's account.

Payload Example

{
  "event": "direct_debit.payment_success",
  "data": {
    "message": "Direct debit payment processed successfully.",
    "direct_debit_id": "682123abc456def789012345",
    "reference": 1234567,
    "status": "active",
    "currency": "MXN",
    "amount": 500.00,
    "is_recurring": true,
    "is_fixed_amount": true,
    "validation_level": 1,
    "customer_id": "64b2c3d4e5f67890abcdef12",
    "payment_method_id": "64c3d4e5f67890abcdef1234",
    "interval": "monthly",
    "concept": "Cargo por domiciliación",
    "order_id": "682abc123def456789012345",
    "order_amount": 500.00,
    "order_currency": "MXN",
    "payment_status": "paid",
    "paid_at": "2026-05-12T18:00:00.000Z",
    "attempts_count": 1
  }
}



direct_debit.payment_failed

This event is triggered when the bank (Santander) response file indicates that a pending payment order could not be collected. This also fires when no response is received from the bank for a given order (treated as a failure with error code 99).

Payload Example

{
  "event": "direct_debit.payment_failed",
  "data": {
    "message": "A direct debit payment attempt has failed.",
    "direct_debit_id": "682123abc456def789012345",
    "reference": 1234567,
    "status": "active",
    "currency": "MXN",
    "amount": 500.00,
    "is_recurring": true,
    "is_fixed_amount": true,
    "validation_level": 1,
    "customer_id": "64b2c3d4e5f67890abcdef12",
    "payment_method_id": "64c3d4e5f67890abcdef1234",
    "interval": "monthly",
    "concept": "Cargo por domiciliación",
    "order_id": "682abc123def456789012345",
    "order_amount": 500.00,
    "order_currency": "MXN",
    "payment_status": "failed",
    "error_code": "04",
    "error_message": "Insufficient funds",
    "max_attempts_reached": false,
    "attempts_count": 1,
    "failed_at": "2026-05-12T18:00:00.000Z"
  }
}


direct_debit.pending

This event is triggered when a single-charge (non-recurring) direct debit payment fails and the maximum number of retry attempts has been reached. The direct debit awaits merchant intervention to retry or cancel.

Note: This event is always preceded by a direct_debit.payment_failed event for the same direct debit.

Payload Example

{
  "event": "direct_debit.pending",
  "data": {
    "message": "The direct debit is pending after failed payment attempts.",
    "direct_debit_id": "682123abc456def789012345",
    "reference": 1234567,
    "status": "pending",
    "currency": "MXN",
    "amount": 500.00,
    "is_recurring": false,
    "is_fixed_amount": true,
    "validation_level": 1,
    "customer_id": "64b2c3d4e5f67890abcdef12",
    "payment_method_id": "64c3d4e5f67890abcdef1234",
    "reason": "max_attempts_reached"
  }
}


direct_debit.cancelled

This event is triggered when the merchant cancels the direct debit via the API update endpoint. Cancellation is only allowed when there are no pending payment orders.

Payload Example

{
  "event": "direct_debit.cancelled",
  "data": {
    "message": "The direct debit has been cancelled.",
    "direct_debit_id": "682123abc456def789012345",
    "reference": 1234567,
    "status": "cancelled",
    "currency": "MXN",
    "amount": 500.00,
    "is_recurring": true,
    "is_fixed_amount": true,
    "validation_level": 1,
    "customer_id": "64b2c3d4e5f67890abcdef12",
    "payment_method_id": "64c3d4e5f67890abcdef1234",
    "interval": "monthly",
    "concept": "Cargo por domiciliación",
    "cancelled_at": "2026-05-12T16:30:00.000Z",
    "cancelled_by": "merchant",
    "cancellation_reason": "Customer requested cancellation"
  }
}

Subscription module events

subscription.created

This event is triggered when a subscription is created.

Payload Example

{
  "message": "A new subscription has been created.",
  "account_id": "68a4c3150b28a9584305a2a6",
  "authorization_id": "68a4c3150b28a9584305a2aa",
  "customer_id": "68dea001d3d53b7a568e2686",
  "card_ids": [],
  "status": "active",
  "service": "Food delivery 2: Envíos a tu Oficina!",
  "amount": 599,
  "currency": "MXN",
  "interval": "weekly",
  "frequency": 1,
  "trial_period_days": 7,
  "billing_cycle": {
    "day": 28,
    "month": 1
  },
  "merchant_management": false,
  "attempts": 0,
  "benefits": [
    "1 comida al día de lunes a viernes",
    "Incluye bebida fría",
    "Salsa verde y roja",
    "Comida diferente cada día",
    "280 gramos de proteína por comida"
  ],
  "errors": [],
  "_id": "68debb0903dd1dc99eeb0f06",
  "created_at": "2025-10-02T17:48:57.780Z",
  "updated_at": "2025-10-02T17:48:57.780Z",
  "__v": 0
}

subscription.payment_success

This event is triggered when a suscription payment is processed succesfully.

Payload Example

{
  "message": "The subscription payment was processed successfully after previous attempts.",
  "id": "68cdcfa92ebbd864ef059459",
  "account_id": "68a4c3150b28a9584305a2a6",
  "authorization_id": "68a4c3150b28a9584305a2aa",
  "customer_id": "68cdcfa92ebbd864ef059453",
  "card_ids": [
    "68cdd0632ebbd864ef059474",
    "68cdd0a02ebbd864ef0594a0"
  ],
  "status": "active",
  "service": "Tacos diario",
  "amount": 150,
  "currency": "MXN",
  "interval": "daily",
  "frequency": 1,
  "trial_period_days": 0,
  "attempts": 1,
  "benefits": [
    "Salsa verde",
    "Salsa roja",
    "Cilantro",
    "Cebolla",
    "Coca de uva"
  ],
  "errors": [
    "AMEX is not active, try another card. | amex 3998"
  ],
  "created_at": "2025-09-19T21:48:25.509Z",
  "updated_at": "2025-09-19T21:52:33.007Z",
  "__v": 0,
  "account_customer_id": "68cdcffb2ebbd864ef059465"
}

subscription.payment_failed

This event is triggered after two unsuccessful payment attempts.

Payload Example

{
  "message": "A subscription payment attempt has failed.",
  "_id": "68dec61703dd1dc99eeb0fa3",
  "account_id": "68a4c3150b28a9584305a2a6",
  "authorization_id": "68a4c3150b28a9584305a2aa",
  "customer_id": "68cdcfa92ebbd864ef059453",
  "card_ids": [
    "68dec65f4fc15f2238b34906",
    "68dec6404fc15f2238b348c8"
  ],
  "status": "active",
  "service": "Food delivery 4: Envíos a tu Oficina!",
  "amount": 599,
  "currency": "MXN",
  "interval": "weekly",
  "frequency": 1,
  "trial_period_days": 0,
  "billing_cycle": {
    "day": 28,
    "month": 1
  },
  "merchant_management": false,
  "attempts": 1,
  "benefits": [
    "1 comida al día de lunes a viernes",
    "Incluye bebida fría",
    "Salsa verde y roja",
    "Comida diferente cada día",
    "280 gramos de proteína por comida"
  ],
  "errors": [
    "Problema al procesar el pago, pruebe con otra tarjeta. | mastercard 3456"
  ],
  "created_at": "2025-10-02T18:36:07.096Z",
  "updated_at": "2025-10-02T18:37:19.591Z",
  "__v": 0,
  "account_customer_id": "68cdcffb2ebbd864ef059465"
}

subscription.paused

This event is triggered after five unsuccessful payment attempts.

Payload Example

{
  "message": "The subscription has been paused after multiple failed payment attempts.",
  "id": "68cdd4284ebbd864ef059570",
  "account_id": "68a4c3150b28a9584305a2a6",
  "authorization_id": "68a4c3150b28a9584305a2aa",
  "customer_id": "68cdcfa92ebbd864ef059453",
  "card_ids": [
    "68cdd3022ebbd864ef05958c",
    "68cdd5122ebbd864ef0596bd",
    "68cdd5b62ebbd864ef0596e9",
    "68cdd5ed2ebbd864ef059717",
    "68cdd6052ebbd864ef059742"
  ],
  "status": "active",
  "service": "Tacos cada mes",
  "amount": 200,
  "currency": "MXN",
  "interval": "daily",
  "frequency": 1,
  "trial_period_days": 0,
  "attempts": 4,
  "benefits": [
    "Tortillas extra",
    "Salsa verde",
    "Salsa roja",
    "Salsa guacamole",
    "Sal",
    "Limón"
  ],
  "errors": [
    "Problema al procesar el pago, pruebe con otra tarjeta. | discover 0842",
    "AMEX is not active, try another card. | amex 3998",
    "Problema al procesar el pago, pruebe con otra tarjeta. | jcb 0000",
    "Problema al procesar el pago, pruebe con otra tarjeta. | visa 3705"
  ],
  "created_at": "2025-09-19T22:00:36.182Z",
  "updated_at": "2025-09-19T22:15:34.266Z",
  "__v": 0,
  "account_customer_id": "68cdcffb2ebbd864ef059465"
}

subscription.cancelled

This event is triggered when the subscription has been cancelled

Payload Example

{
  "message": "The subscription has been cancelled.",
  "_id": "68debb0903dd1dc99eeb0f06",
  "account_id": "68a4c3150b28a9584305a2a6",
  "authorization_id": "68a4c3150b28a9584305a2aa",
  "customer_id": "68dea001d3d53b7a568e2686",
  "card_ids": [
    "68dec27a4fc15f2238b3476c"
  ],
  "status": "cancelled",
  "service": "Food delivery 2: Envíos a tu Oficina!",
  "amount": 599,
  "currency": "MXN",
  "interval": "weekly",
  "frequency": 1,
  "trial_period_days": 7,
  "billing_cycle": {
    "day": 28,
    "month": 1
  },
  "merchant_management": false,
  "attempts": 0,
  "benefits": [
    "1 comida al día de lunes a viernes",
    "Incluye bebida fría",
    "Salsa verde y roja",
    "Comida diferente cada día",
    "280 gramos de proteína por comida"
  ],
  "errors": [],
  "created_at": "2025-10-02T17:48:57.780Z",
  "updated_at": "2025-10-02T18:21:04.494Z",
  "__v": 0,
  "account_customer_id": "68dea146d3d53b7a568e2779",
  "next_payment_date": "2025-10-09T18:20:42.554Z",
  "trial_end_date": "2025-10-09T18:20:42.554Z"
}

Transactions module events

transactions.paid

This event is triggered when a transaction status changes to paid.

Payload Example

{
  "event": "transactions.paid",
  "data": {
    "message": "The transaction has been completed successfully.",
    "account_id": "68a4c3150b28a9584305a2a6",
    "authorization_id": "68a4c3150b28a9584305a2aa",
    "activity_id": "69b4530dd47ff53bb5798809",
    "customer_id": "68cdcbfed75e4961c7188672",
    "transfer_id": "69b4530ed47ff53bb5798811",
    "transaction_id": "TR0000021219",
    "type": "payment",
    "status": "paid",
    "amount": 385.5,
    "fee": 14.5,
    "fee_details": {
      "fixed": 12.5,
      "percent": 0,
      "tax": 2,
      "percent_amount": 0,
      "msi_percent": 0,
      "msi_amount": 0,
      "fixed_installments_amount": 0,
      "fixed_installments_percent": 0,
      "installments_fee": 0
    },
    "installments": 1,
    "total": 400,
    "previous": -2552.4,
    "current": -2166.9,
    "currency": "MXN",
    "gateway": "ecartpay",
    "exchange": 1,
    "reference_id": "BB2331S2411QF3166QQFW86489E4494RG",
    "reference": "2208240",
    "custom_keys": false,
    "order": {},
    "transfer": {
      "folio": "BB2331S2411QF3166QQFW86489E4494RG",
      "clave": "1188439031",
      "numeric_reference": "2208240",
      "concept": "Prueba",
      "ordering_account": "012930012422432535",
      "ordering_bank": "BBVA MEXICO",
      "ordering_name": "Paulina Rivera Gonzalez",
      "ordering_account_type": "40",
      "ordering_tax_id": "RIGP990911PL7",
      "beneficiary_account": "646010142603011960",
      "beneficiary_bank": "STP",
      "beneficiary_name": "Hugo Morin",
      "beneficiary_account_type": "40",
      "beneficiary_tax_id": "MOGH950915DL5",
      "payment_type": "1",
      "operation_type": "0",
      "operation_date": "20260312",
      "company": "ECARTPAY",
      "updated_at": "2026-03-13T18:10:22.406Z",
      "created_at": "2026-03-13T18:10:22.406Z"
    },
    "charges": [
      {
        "id": "646010142603011960",
        "status": "paid",
        "type": "transfer",
        "currency": "MXN",
        "amount": 40000,
        "gateway": "stp",
        "method": {
          "reference": "646010142603011960"
        }
      }
    ],
    "available_at": "2026-03-13T18:10:22.567Z",
    "b2b_metadata": {
      "b2b_transactions": []
    },
    "_id": "69b4530ed47ff53bb5798815",
    "created_at": "2026-03-13T18:10:22.646Z",
    "updated_at": "2026-03-13T18:10:22.646Z",
    "__v": 0
  }
}

Transfer module events

transfer.created

This event is triggered when a payment transfer to a merchant is complete.

Payload Example

{
  "event": "transfer.created",
  "data": {
    "_id": "69b3078604895e4df9d8d43a",
    "account_id": "6851ef3dd0b39474707f960d",
    "activity_id": "69b3078604895e4df9d8d432",
    "transaction_id": "69b3078604895e4df9d8d43e",
    "status": "paid",
    "amount": 485.5,
    "currency": "MXN",
    "numeric_reference": "2208240",
    "ordering_bank": "BBVA MEXICO",
    "ordering_name": "ROBERTO ALEJANDRO DE LA CRUZ MARTINEZ",
    "ordering_account": "012930012422432535",
    "ordering_tax_id": "CUMR880519HF4",
    "beneficiary_account": "646010142603003716",
    "beneficiary_tax_id": "null",
    "folio": "BB1331S2123QE3166QQFW86489E4494RT",
    "concept": "Prueba",
    "order": null,
    "charges": [],
    "fee": 14.5,
    "operation_date": "20240829",
    "total": 500,
    "customer_id": "6854346910775959c2173b48"
  }
}

Orders module events

orders.confirmation

This event is triggered when an order is paid for.

Payload Example

{
  "status": "paid",
  "id": "68e7df0e788c6655fe08cb76"
}

orders.create

This event is triggered when an order is paid for.

Payload Example

{
  "status": "created",
  "id": "68e7df0e788c6655fe08cb76"
}

orders.update

This event is triggered when an order is paid for.

Payload Example

{
  "status": "cancelled",
  "id": "68e7df0e788c6655fe08cb76"
}

Withdrawals module events

withdrawals.processing

This event is triggered when a withdrawal is created (default status).

Payload Example

{
  "message": "A withdrawal request has been created and is being processed.",
  "status": "processing",
  "account_id": "6893ccade6ee2ee721b73cdc",
  "authorization_id": "68f117b334e4ff3047ee7720",
  "amount": 1,
  "fee": 0,
  "currency": "MXN",
  "gateway": "stp",
  "payment_method_information": {
    "name": "4772143024959474",
    "bank": "40012",
    "business_name": "Andre Pierre Gignac",
    "number": "4772143024959474",
    "method": "deposit",
    "country": "MX"
  },
  "reference_id": "68f117b334e4ff3047ee7727",
  "reference": "68f117b334e4ff3047ee7727",
  "created_by": "[email protected]",
  "_id": "68f117b334e4ff3047ee7729",
  "created_at": "2025-10-16T16:05:07.858Z",
  "updated_at": "2025-10-16T16:05:07.858Z",
  "__v": 0
}


withdrawals.paid

This event is triggered when a withdrawal is created (default status).

Payload Example

{
  "message": "A withdrawal request has been completed.",
  "status": "processing",
  "account_id": "6893ccade6ee2ee721b73cdc",
  "authorization_id": "68f117b334e4ff3047ee7720",
  "amount": 1,
  "fee": 0,
  "currency": "MXN",
  "gateway": "stp",
  "payment_method_information": {
    "name": "4772143024959474",
    "bank": "40012",
    "business_name": "Andre Pierre Gignac",
    "number": "4772143024959474",
    "method": "deposit",
    "country": "MX"
  },
  "reference_id": "68f117b334e4ff3047ee7727",
  "reference": "68f117b334e4ff3047ee7727",
  "created_by": "[email protected]",
  "_id": "68f117b334e4ff3047ee7729",
  "created_at": "2025-10-16T16:05:07.858Z",
  "updated_at": "2025-10-16T16:05:07.858Z",
  "__v": 0
}

withdrawals.cancelled

This event is triggered when a withdrawal is created (default status).

Payload Example

{
  "message": "The withdrawal has been cancelled.",
  "_id": "68f117b334e4ff3047ee7729",
  "status": "cancelled",
  "account_id": "6893ccade6ee2ee721b73cdc",
  "authorization_id": "68f117b334e4ff3047ee7720",
  "amount": 1,
  "fee": 0,
  "currency": "MXN",
  "gateway": "stp",
  "payment_method_information": {
    "name": "4772143024959474",
    "bank": "40012",
    "business_name": "Andre Pierre Gignac",
    "number": "4772143024959474",
    "method": "deposit",
    "country": "MX"
  },
  "reference_id": "68f117b334e4ff3047ee7727",
  "reference": "68f117b334e4ff3047ee7727",
  "created_by": "[email protected]",
  "created_at": "2025-10-16T16:05:07.858Z",
  "updated_at": "2025-10-16T16:05:46.141Z",
  "__v": 0,
  "in_review": false
}

Updated 8 days ago