Reference of Payloads to be sent for event type PAYMENT_METHOD_DMCL.
Webhook List
For information about specific payloads for a given API event type and webhook notification code, just click on the corresponding Webhook Code in the table below.
| Event Type | Event Sub Type | Code | scheduled to be sent whenever... |
|---|---|---|---|
| PAYMENT_METHOD_DMCL | PAYMENT_METHOD_CREATED | 4000 | a domiciled payment method is created. |
| PAYMENT_METHOD_DMCL | PAYMENT_METHOD_UPDATED | 4100 | a domiciled payment method is updated. |
| PAYMENT_METHOD_DMCL | PAYMENT_METHOD_DELETED | 4101 | a domiciled payment method is deleted. |
| PAYMENT_METHOD_DMCL | PAYMENT_METHOD_USED | 4300 | a domiciled payment method is used (a charge was requested). |
| PAYMENT_METHOD_DMCL | PAYMENT_METHOD_FAILED | 4002 | a domiciled payment method failed on being created, updated or deleted. |
| PAYMENT_METHOD_DMCL | BANK_INSTITUTION_ADDED | 4305 | a new BANK INSTITUTION is added. |
| PAYMENT_METHOD_DMCL | BANK_INSTITUTION_UPDATED | 4105 | any existing BANK INSTITUTION is updated. |
PAYMENT_METHOD_CREATED_DOMICILED
{
"event_type": "PAYMENT_METHOD_DMCL", /* API Event Type */
"event_type_description": "PAYMENT_METHOD_CREATED", /* Event Sub-Type description */
"webhook_notification_code":4000, /* Webhook notification event code */
"created_at": "2024-07-15 12:34:56", /* The timestamp when the event was created */
"first_sent_at": "2024-07-15 12:36:00", /* The timestamp of first attempt to send the event */
"attempts": 1, /* Attempts made by the webhook */
"account_id": 321, /* Account ID related with the event sent */
"customer_id": 345, /* Customer ID related with the event, if exist. */
"request_id": 12343, /* If exist, our internal request ID related with the event. */
"details": {
"id": 32, /* Object ID of the API resource created/updated */
"code": "payspei_ffy564gry345re", /* Object Code of the API resource created/updated */
"status": "success", /* The status of the action */
}
}
PAYMENT_METHOD_UPDATED_DOMICILED
{
"event_type": "PAYMENT_METHOD_DMCL", /* API Event Type */
"event_type_description": "PAYMENT_METHOD_UPDATED", /* Event Sub-Type description */
"webhook_notification_code": 4100, /* Webhook notification event code */
"created_at": "2024-07-15 12:34:56", /* The timestamp when the event was created */
"first_sent_at": "2024-07-15 12:36:00", /* The timestamp of first attempt to send the event */
"attempts": 1, /* Attempts made by the webhook */
"account_id": 321, /* Account ID related with the event sent */
"customer_id": 345, /* Customer ID related with the event, if exist. */
"request_id": 12343, /* If exist, our internal request ID related with the event. */
"details": {
"id": 32, /* Object ID of the API resource created/updated */
"code": "payspei_ffy564gry345re", /* Object Code of the API resource created/updated */
"status": "success", /* The status of the action */
}
}
PAYMENT_METHOD_DELETED_DOMICILED
{
"event_type": "PAYMENT_METHOD_DMCL", /* API Event Type */
"event_type_description": "PAYMENT_METHOD_DELETED", /* Event Sub-Type description */
"webhook_notification_code": 4101, /* Webhook notification event code */
"created_at": "2024-07-15 12:34:56", /* The timestamp when the event was created */
"first_sent_at": "2024-07-15 12:36:00", /* The timestamp of first attempt to send the event */
"attempts": 1, /* Attempts made by the webhook */
"account_id": 321, /* Account ID related with the event sent */
"customer_id": 345, /* Customer ID related with the event, if exist. */
"request_id": 12343, /* If exist, our internal request ID related with the event. */
"details": {
"id": 32, /* Object ID of the API resource created/updated */
"code": "payspei_ffy564gry345re", /* Object Code of the API resource created/updated */
"status": "success", /* The status of the action */
}
}
PAYMENT_METHOD_USED_DOMICILED
{
"event_type": "PAYMENT_METHOD_DMCL", /* API Event Type */
"event_type_description": "PAYMENT_METHOD_USED", /* Event Sub-Type description */
"webhook_notification_code": 4300, /* Webhook notification event code */
"created_at": "2024-07-15 12:34:56", /* The timestamp when the event was created */
"first_sent_at": "2024-07-15 12:36:00", /* The timestamp of first attempt to send the event */
"attempts": 1, /* Attempts made by the webhook */
"account_id": 321, /* Account ID related with the event sent */
"customer_id": 345, /* Customer ID related with the event, if exist. */
"request_id": 12343, /* If exist, our internal request ID related with the event. */
"details": {
"id": 32, /* Object ID of the API resource created/updated */
"code": "payspei_ffy564gry345re", /* Object Code of the API resource created/updated */
"status": "failed", /* The status of the action */
"failed_reason": "FAILED_ON_CHARGE", /* If status=failed, a failure code */
"failed_message": "Insufficient account balance" /* If status=failed, a description of the failure */
}
}
PAYMENT_METHOD_FAILED_DOMICILED
{
"event_type": "PAYMENT_METHOD_DMCL", /* API Event Type */
"event_type_description": "PAYMENT_METHOD_FAILED", /* Event Sub-Type description */
"webhook_notification_code": 4002, /* Webhook notification event code */
"created_at": "2024-07-15 12:34:56", /* The timestamp when the event was created */
"first_sent_at": "2024-07-15 12:36:00", /* The timestamp of first attempt to send the event */
"attempts": 1, /* Attempts made by the webhook */
"account_id": 321, /* Account ID related with the event sent */
"customer_id": 345, /* Customer ID related with the event, if exist. */
"request_id": 12343, /* If exist, our internal request ID related with the event. */
"details": {
"id": 32, /* Object ID of the API resource created/updated */
"code": "payspei_ffy564gry345re", /* Object Code of the API resource created/updated */
"status": "failed", /* The status of the action */
"failed_reason": "FAILED_ON_UPDATE", /* If status=failed, a failure code */
"failed_message": "Invalid bank code provided" /* If status=failed, a description of the failure */
}
}
BANK_INSTITUTION_ADDED
{
"event_type": "PAYMENT_METHOD_DMCL", /* API Event Type */
"event_type_description": "BANK_INSTITUTION_ADDED", /* Event Sub-Type description */
"webhook_notification_code": 4305, /* Webhook notification event code */
"created_at": "2024-07-15 12:34:56", /* The timestamp when the event was created */
"first_sent_at": "2024-07-15 12:36:00", /* The timestamp of first attempt to send the event */
"attempts": 1, /* Attempts made by the webhook */
"account_id": 321, /* Account ID related with the event sent */
"request_id": 12343, /* If exist, our internal request ID related with the event. */
"details": {
"id": null, /* Object ID of the API resource created/updated */
"code": "012", /* Object Code of the API resource created/updated */
"name": "BBVA", /* Object Name of the API resource created/updated */
"status": "success", /* The status of the action */
}
}
BANK_INSTITUTION_UPDATED
{
"event_type": "PAYMENT_METHOD_DMCL", /* API Event Type */
"event_type_description": "BANK_INSTITUTION_UPDATED", /* Event Sub-Type description */
"webhook_notification_code": 4105, /* Webhook notification event code */
"created_at": "2024-07-15 12:34:56", /* The timestamp when the event was created */
"first_sent_at": "2024-07-15 12:36:00", /* The timestamp of first attempt to send the event */
"attempts": 1, /* Attempts made by the webhook */
"account_id": 321, /* Account ID related with the event sent */
"request_id": 12343, /* If exist, our internal request ID related with the event. */
"details": {
"id": null, /* Object ID of the API resource created/updated */
"code": "021", /* Object Code of the API resource created/updated */
"name": "HSBC", /* Object Name of the API resource created/updated */
"status": "success", /* The status of the action */
}
}