Ansa Webhook Event Types
This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.
add_balance.failure
Example
JSON
{
"customer_id": "6285a9fd-cc52-4e2e-9dc7-400e751d7114",
"data": null,
"error": {
"code": "request_failed",
"message": "There was an error processing your payment method",
"type": "payment_method_error"
},
"id": "78eeee36-216f-4216-97b8-d77af91a0c77",
"merchant_id": "48a7abfb-ec49-479e-a707-61f236ebfad5",
"type": "add_balance.failure",
"version": "v2"
}add_balance.success
Example
JSON
{
"customer_id": "6285a9fd-cc52-4e2e-9dc7-400e751d7114",
"data": {
"add_balance_amount": 1000,
"event_created_timestamp": "2024-05-28T14:11:20.834Z",
"payment_method_id": "khgtc4235i8t6ufqKUYFJKkuywejrg",
"transaction_id": "50691bb0-2eae-4a3d-840e-1a198ecd4592",
"updated_balance": {
"amount": 123,
"currency": "usd"
}
},
"error": null,
"id": "78eeee36-216f-4216-97b8-d77af91a0c77",
"merchant_id": "48a7abfb-ec49-479e-a707-61f236ebfad5",
"type": "add_balance.success",
"version": "v2"
}autoreload.failure
Example
JSON
{
"customer_id": "6285a9fd-cc52-4e2e-9dc7-400e751d7114",
"data": null,
"error": {
"code": "request_failed",
"message": "There was an error processing your payment method",
"type": "payment_method_error"
},
"id": "78eeee36-216f-4216-97b8-d77af91a0c77",
"merchant_id": "48a7abfb-ec49-479e-a707-61f236ebfad5",
"type": "autoreload.failure",
"version": "v2"
}autoreload.success
Example
JSON
{
"customer_id": "6285a9fd-cc52-4e2e-9dc7-400e751d7114",
"data": {
"current_balance": {
"amount": 123,
"currency": "usd"
},
"event_created_timestamp": "2024-05-28T14:11:20.834Z",
"reload_amount": 1000,
"reload_threshold": 234,
"transaction_id": "50691bb0-2eae-4a3d-840e-1a198ecd4592"
},
"error": null,
"id": "78eeee36-216f-4216-97b8-d77af91a0c77",
"merchant_id": "48a7abfb-ec49-479e-a707-61f236ebfad5",
"type": "autoreload.success",
"version": "v2"
}balance_refund.failure
Example
JSON
{
"customer_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220",
"data": null,
"error": {
"code": "internal",
"message": "Something went wrong. Please try again later.",
"type": "event_delivery_error"
},
"id": "58652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"merchant_id": "badd9882-a247-4e98-941a-7c9c629aa910",
"type": "balance_refund.failure",
"version": "v2"
}balance_refund.success
Example
JSON
{
"customer_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220",
"data": {
"amount": {
"amount": 42,
"currency": "usd"
},
"event_created_timestamp": "2024-05-28T15:25:28.901Z",
"refunded_transaction_id": "fd7c604b-85c4-4b72-85f4-57918120da49",
"transaction_id": "c8d9f88d-4e8b-4487-990f-ddadb1d349fa",
"updated_balance": {
"amount": 42,
"currency": "usd"
}
},
"error": null,
"id": "58652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"merchant_id": "badd9882-a247-4e98-941a-7c9c629aa910",
"type": "balance_refund.failure",
"version": "v2"
}card.autofunding.failure
Example
JSON
{
"customer_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220",
"data": null,
"error": {
"code": "internal",
"message": "Something went wrong. Please try again later.",
"type": "event_delivery_error"
},
"id": "58652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"merchant_id": "badd9882-a247-4e98-941a-7c9c629aa910",
"type": "card.autofunding.failure",
"version": "v2"
}card.autofunding.success
Example
JSON
{
"customer_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220",
"data": {
"autofund_status": "success",
"autoreload_event_data": {
"current_balance": {
"amount": 123,
"currency": "usd"
},
"event_created_timestamp": "2024-05-28T14:11:20.834Z",
"reload_amount": 1000,
"reload_threshold": 234,
"transaction_id": "50691bb0-2eae-4a3d-840e-1a198ecd4592"
},
"card_info": {
"card_id": "5FD1A834-CA29-4298-83AC-622564314AAC",
"card_type": "VIRTUAL"
},
"event_created_timestamp": "2024-05-28T15:25:28.901Z"
},
"error": null,
"id": "58652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"merchant_id": "badd9882-a247-4e98-941a-7c9c629aa910",
"type": "card.autofunding.success",
"version": "v2"
}card.creation.failure
Example
JSON
{
"customer_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220",
"data": null,
"error": {
"code": "internal",
"message": "Something went wrong. Please try again later.",
"type": "event_delivery_error"
},
"id": "58652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"merchant_id": "badd9882-a247-4e98-941a-7c9c629aa910",
"type": "card.creation.failure",
"version": "v2"
}card.creation.success
Example
JSON
{
"customer_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220",
"data": {
"card_info": {
"card_id": "5FD1A834-CA29-4298-83AC-622564314AAC",
"card_type": "VIRTUAL"
},
"event_created_timestamp": "2024-05-28T15:25:28.901Z",
"virtual_card_data": {
"card": {
"card_holder_name": "Jane Doe",
"exp_month": "04",
"exp_year": "2033",
"last_four": "4687",
"state": "CA"
},
"created_at": "2024-05-28T15:25:28.901Z",
"id": "21AC116E-67FD-4FAE-BB45-07C9778CDE81",
"metadata": {},
"type": "VIRTUAL"
}
},
"error": null,
"id": "58652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"merchant_id": "badd9882-a247-4e98-941a-7c9c629aa910",
"type": "card.creation.success",
"version": "v2"
}card.txn.auth.approval
Example
JSON
{
"customer_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220",
"data": {
"card_info": {
"card_id": "5FD1A834-CA29-4298-83AC-622564314AAC",
"card_type": "VIRTUAL"
},
"event_created_timestamp": "2024-05-28T15:25:28.901Z",
"virtual_card_data": {
"card": {
"card_holder_name": "Jane Doe",
"exp_month": "04",
"exp_year": "2033",
"last_four": "4687",
"state": "CA"
},
"created_at": "2024-05-28T15:25:28.901Z",
"id": "21AC116E-67FD-4FAE-BB45-07C9778CDE81",
"metadata": {},
"type": "VIRTUAL"
}
},
"error": null,
"id": "58652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"merchant_id": "badd9882-a247-4e98-941a-7c9c629aa910",
"type": "card.txn.auth.approval",
"version": "v2"
}card.txn.auth.decline
Example
JSON
{
"customer_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220",
"data": {
"card_info": {
"card_id": "5FD1A834-CA29-4298-83AC-622564314AAC",
"card_type": "VIRTUAL"
},
"event_created_timestamp": "2024-05-28T15:25:28.901Z",
"reason": "insufficient_funds",
"response": "INSUFFICIENT_FUNDS",
"virtual_card_data": {
"card": {
"card_holder_name": "Jane Doe",
"exp_month": "04",
"exp_year": "2033",
"last_four": "4687",
"state": "CA"
},
"created_at": "2024-05-28T15:25:28.901Z",
"id": "21AC116E-67FD-4FAE-BB45-07C9778CDE81",
"metadata": {},
"type": "VIRTUAL"
}
},
"error": null,
"id": "58652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"merchant_id": "badd9882-a247-4e98-941a-7c9c629aa910",
"type": "card.txn.auth.decline",
"version": "v2"
}cash_back.success
Example
JSON
{
"customer_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220",
"data": {
"cash_back_amount": 1,
"event_created_timestamp": "2024-05-28T15:25:28.901Z",
"source_txn_amount": 10,
"transaction_id": "78652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"updated_balance": {
"amount": 10,
"currency": "usd"
}
},
"error": null,
"id": "58652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"merchant_id": "badd9882-a247-4e98-941a-7c9c629aa910",
"type": "cash_back.success",
"version": "v1"
}expiring_balance.expired
Example
JSON
{
"customer_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220",
"data": {
"event_created_timestamp": "2024-05-28T15:25:28.901Z",
"expires_at": "2024-05-28T15:25:28.901Z",
"initial_amount": 42,
"initial_transaction_id": "c8d9f88d-4e8b-4487-990f-ddadb1d349fa",
"remaining_amount": 42
},
"error": null,
"id": "58652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"merchant_id": "badd9882-a247-4e98-941a-7c9c629aa910",
"type": "expiring_balance.expired",
"version": "v1"
}expiring_balance.expiring_soon
Example
JSON
{
"customer_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220",
"data": {
"event_created_timestamp": "2024-05-28T15:25:28.901Z",
"expiring_by": "2024-05-30T15:25:28.901Z",
"remaining_amount": 1000,
"user_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220"
},
"error": null,
"id": "58652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"merchant_id": "badd9882-a247-4e98-941a-7c9c629aa910",
"type": "expiring_balance.expiring_soon",
"version": "v1"
}payment_method.creation.failure
Example
JSON
{
"customer_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220",
"data": null,
"error": {
"code": "internal",
"message": "Something went wrong. Please try again later.",
"type": "event_delivery_error"
},
"id": "58652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"merchant_id": "badd9882-a247-4e98-941a-7c9c629aa910",
"type": "payment_method.creation.failure",
"version": "v2"
}payment_method.creation.success
Example
JSON
{
"customer_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220",
"data": {
"card_data": {
"card": {
"card_holder_name": "Jane Doe",
"exp_month": "04",
"exp_year": "2033",
"last_four": "4687",
"state": "CA"
},
"created_at": "2024-05-28T15:25:28.901Z",
"id": "21AC116E-67FD-4FAE-BB45-07C9778CDE81",
"metadata": {},
"type": "VIRTUAL"
},
"card_info": {
"card_id": "5FD1A834-CA29-4298-83AC-622564314AAC",
"card_type": "VIRTUAL"
},
"event_created_timestamp": "2024-05-28T15:25:28.901Z"
},
"error": null,
"id": "58652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"merchant_id": "badd9882-a247-4e98-941a-7c9c629aa910",
"type": "payment_method.creation.success",
"version": "v2"
}payment_method.deletion.failure
Example
JSON
{
"customer_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220",
"data": null,
"error": {
"code": "internal",
"message": "Something went wrong. Please try again later.",
"type": "event_delivery_error"
},
"id": "58652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"merchant_id": "badd9882-a247-4e98-941a-7c9c629aa910",
"type": "payment_method.deletion.failure",
"version": "v2"
}payment_method.deletion.success
Example
JSON
{
"customer_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220",
"data": {
"event_created_timestamp": "2024-05-28T15:25:28.901Z",
"payment_method_id": "59f97e30-ea56-4b75-8a23-1fa0eae0ca06"
},
"error": null,
"id": "58652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"merchant_id": "badd9882-a247-4e98-941a-7c9c629aa910",
"type": "payment_method.deletion.success",
"version": "v2"
}peer_fund.failure
Example
JSON
{
"customer_id": "6285a9fd-cc52-4e2e-9dc7-400e751d7114",
"data": null,
"error": {
"code": "internal",
"message": "Something went wrong. Please try again later.",
"type": "event_delivery_error"
},
"id": "78eeee36-216f-4216-97b8-d77af91a0c77",
"merchant_id": "48a7abfb-ec49-479e-a707-61f236ebfad5",
"type": "peer_fund.failure",
"version": "v2"
}peer_fund.success
Example
JSON
{
"customer_id": "6285a9fd-cc52-4e2e-9dc7-400e751d7114",
"data": {
"event_created_timestamp": "2024-05-28T14:11:20.834Z",
"peer_fund_amount": 1000,
"recipient_customer_id": "c334975b-7ef3-4dea-b237-d973e10b195f",
"sender_updated_balance": {
"amount": 123,
"currency": "usd"
},
"transaction_id": "50691bb0-2eae-4a3d-840e-1a198ecd4592"
},
"error": null,
"id": "78eeee36-216f-4216-97b8-d77af91a0c77",
"merchant_id": "48a7abfb-ec49-479e-a707-61f236ebfad5",
"type": "peer_fund.success",
"version": "v2"
}redeem_gift_card.failure
Example
JSON
{
"customer_id": "6285a9fd-cc52-4e2e-9dc7-400e751d7114",
"data": null,
"error": {
"code": "request_failed",
"message": "There was an error processing your payment method",
"type": "payment_method_error"
},
"id": "78eeee36-216f-4216-97b8-d77af91a0c77",
"merchant_id": "48a7abfb-ec49-479e-a707-61f236ebfad5",
"type": "redeem_gift_card.failure",
"version": "v2"
}redeem_gift_card.success
Example
JSON
{
"customer_id": "6285a9fd-cc52-4e2e-9dc7-400e751d7114",
"data": {
"event_created_timestamp": "2024-05-28T14:11:20.834Z",
"gift_card_last_4": "****4242",
"gift_card_provider": "square",
"redeem_gift_card_amount": 1000,
"transaction_id": "50691bb0-2eae-4a3d-840e-1a198ecd4592",
"updated_balance": {
"amount": 123,
"currency": "usd"
}
},
"error": null,
"id": "78eeee36-216f-4216-97b8-d77af91a0c77",
"merchant_id": "48a7abfb-ec49-479e-a707-61f236ebfad5",
"type": "redeem_gift_card.success",
"version": "v2"
}redeem_promo_code.failure
Example
JSON
{
"customer_id": "6285a9fd-cc52-4e2e-9dc7-400e751d7114",
"data": null,
"error": {
"code": "internal",
"message": "Something went wrong. Please try again later.",
"type": "event_delivery_error"
},
"id": "78eeee36-216f-4216-97b8-d77af91a0c77",
"merchant_id": "48a7abfb-ec49-479e-a707-61f236ebfad5",
"type": "redeem_promo_code.failure",
"version": "v2"
}redeem_promo_code.success
Example
JSON
{
"customer_id": "6285a9fd-cc52-4e2e-9dc7-400e751d7114",
"data": {
"customer_id": "c334975b-7ef3-4dea-b237-d973e10b195f",
"event_created_timestamp": "2024-05-28T14:11:20.834Z",
"redeem_promo_code_amount": 1000,
"transaction_id": "50691bb0-2eae-4a3d-840e-1a198ecd4592",
"updated_balance": {
"amount": 123,
"currency": "usd"
}
},
"error": null,
"id": "78eeee36-216f-4216-97b8-d77af91a0c77",
"merchant_id": "48a7abfb-ec49-479e-a707-61f236ebfad5",
"type": "redeem_promo_code.success",
"version": "v2"
}transaction.merchant_deposit_reserve_funds
Example
JSON
{
"customer_id": "04f56336-ccc8-4b6e-9cc8-8919f6adb220",
"data": {
"amount": {
"amount": 42,
"currency": "usd"
},
"event_created_timestamp": "2024-05-28T15:25:28.901Z",
"transaction_id": "c8d9f88d-4e8b-4487-990f-ddadb1d349fa",
"updated_reserve_funds_balance": {
"amount": 42,
"currency": "usd"
}
},
"error": null,
"id": "58652831-3e9a-472b-9d2a-5d3f7d7e7f80",
"merchant_id": "badd9882-a247-4e98-941a-7c9c629aa910",
"type": "transaction.merchant_deposit_reserve_funds",
"version": "v2"
}use_balance.failure
Example
JSON
{
"customer_id": "6285a9fd-cc52-4e2e-9dc7-400e751d7114",
"data": null,
"error": {
"code": "internal",
"message": "Something went wrong. Please try again later.",
"type": "event_delivery_error"
},
"id": "78eeee36-216f-4216-97b8-d77af91a0c77",
"merchant_id": "48a7abfb-ec49-479e-a707-61f236ebfad5",
"type": "use_balance.failure",
"version": "v2"
}use_balance.success
Example
JSON
{
"customer_id": "6285a9fd-cc52-4e2e-9dc7-400e751d7114",
"data": {
"event_created_timestamp": "2024-05-28T14:11:20.834Z",
"transaction_id": "50691bb0-2eae-4a3d-840e-1a198ecd4592",
"updated_balance": {
"amount": 123,
"currency": "usd"
},
"use_balance_amount": 1000
},
"error": null,
"id": "78eeee36-216f-4216-97b8-d77af91a0c77",
"merchant_id": "48a7abfb-ec49-479e-a707-61f236ebfad5",
"type": "use_balance.success",
"version": "v2"
}