Reference of Payloads to be sent for event type Account.
Webhook List for Main Account events
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... |
---|---|---|---|
ACCOUNT | ACCOUNT_CREATED | 1000 | an account is created. |
ACCOUNT | ACCOUNT_UPDATED | 1100 | an account is updated. |
ACCOUNT | ACCOUNT_CANCELLED | 1101 | an account is cancelled. |
ACCOUNT | ACCOUNT_FAILED | 1005 | an account failed on being created, updated or cancelled. |
ACCOUNT | EMAIL_UPDATED | 1001 | the account email is changed/replaced. |
ACCOUNT | MOBILE_UPDATED | 1002 | the account mobile is changed/replaced. |
ACCOUNT | SECRET_KEY_CREATED | 1010 | initial Secret API Key is created (by the first time only). |
ACCOUNT | SECRET_KEY_UPDATED | 1011 | a new Secret API Key is created and old one is scheduled to expire (second time and so on). |
ACCOUNT | SECRET_KEY_WARNING | 1012 | a Secret API Key is near to expire (1, 3 and 7 days before expire). |
ACCOUNT | CREDENTIAL_UPDATED | 1013 | new account credentials are created. |
ACCOUNT | CREDENTIAL_WARNING | 1014 | account credentials are expired (1, 3 and 5 days after expired). |
ACCOUNT | UNAUTHORIZED_ACTION | 1015 | an unauthorized action is requested (account behalf). |
ACCOUNT_CREATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "ACCOUNT_CREATED", /* Event Sub-Type description */
"webhook_notification_code": 1000, /* 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": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
ACCOUNT_UPDATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "ACCOUNT_UPDATED", /* Event Sub-Type description */
"webhook_notification_code": 1100, /* 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": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
ACCOUNT_CANCELLED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "ACCOUNT_CANCELLED", /* Event Sub-Type description */
"webhook_notification_code": 1101, /* 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": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
ACCOUNT_FAILED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "ACCOUNT_FAILED", /* Event Sub-Type description */
"webhook_notification_code": 1005, /* 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": 321, /* Object ID of the API resource created/updated */
"status": "failed", /* The status of the action */
"failed_reason": "Inconsistent data", /* If status=failed, a failure code */
"failed_message": "Wrong Email and/or Phone" /* If status=failed, a description of the failure */
}
}
EMAIL_UPDATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "EMAIL_UPDATED", /* Event Sub-Type description */
"webhook_notification_code": 1001, /* 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 */
"details": {
"id": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
MOBILE_UPDATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "MOBILE_UPDATED", /* Event Sub-Type description */
"webhook_notification_code": 1002, /* 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 */
"details": {
"id": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
SECRET_KEY_CREATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SECRET_KEY_CREATED", /* Event Sub-Type description */
"webhook_notification_code": 1010, /* 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": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
SECRET_KEY_UPDATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SECRET_KEY_UPDATED", /* Event Sub-Type description */
"webhook_notification_code": 1011, /* 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": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
SECRET_KEY_WARNING
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SECRET_KEY_WARNING", /* Event Sub-Type description */
"webhook_notification_code": 1012, /* 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 */
"details": {
"id": 321, /* Object ID of the API resource created/updated */
"status": "success", /* The status of the action */
"code": "fb2992d3-5cf2-4177-8433-************",
"name": ""
}
}
CREDENTIAL_UPDATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "CREDENTIAL_UPDATED", /* Event Sub-Type description */
"webhook_notification_code": 1013, /* 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 */
"details": {
"id": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
CREDENTIAL_WARNING
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "CREDENTIAL_WARNING", /* Event Sub-Type description */
"webhook_notification_code": 1014, /* 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 */
"details": {
"id": 321, /* Object ID of the API resource created/updated */
"status": "success", /* The status of the action */
"code": "************",
"name": "user_account"
}
}
UNAUTHORIZED_ACTION
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "UNAUTHORIZED_ACTION", /* Event Sub-Type description */
"webhook_notification_code": 1015, /* 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": 321, /* Object ID of the API resource created/updated */
"status": "failed", /* The status of the action */
"failed_reason": "Unauthorized request", /* If status=failed, a failure code */
"failed_message": "Secret Key Expired" /* If status=failed, a description of the failure */
}
}
Webhook List for Sub Account events
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... |
---|---|---|---|
ACCOUNT | SUB_ACCOUNT_CREATED | 1200 | a sub-account is created. |
ACCOUNT | SUB_ACCOUNT_UPDATED | 1300 | a sub-account is updated. |
ACCOUNT | SUB_ACCOUNT_CANCELLED | 1301 | a sub-account is cancelled. |
ACCOUNT | SUB_ACCOUNT_FAILED | 1205 | a sub-account failed on being created, updated or cancelled. |
ACCOUNT | SA_EMAIL_UPDATED | 1201 | Sub-Account email is changed/replaced. |
ACCOUNT | SA_MOBILE_UPDATED | 1202 | Sub-Account mobile is changed/replaced. |
ACCOUNT | SA_SECRET_KEY_CREATED | 1210 | Sub-Account initial Secret API Key is created (first time only). |
ACCOUNT | SA_SECRET_KEY_UPDATED | 1211 | a new Secret API Key is created and old one is scheduled to expire (second time and so on). |
ACCOUNT | SA_SECRET_KEY_WARNING | 1212 | Sub-Account Secret API Key is near to expire (1, 3 and 7 days before expire). |
ACCOUNT | SA_CREDENTIAL_UPDATED | 1213 | new sub-account credentials are created. |
ACCOUNT | SA_CREDENTIAL_WARNING | 1214 | sub-account credentials are expired (1, 3 and 5 days after expired). |
ACCOUNT | SA_UNAUTHORIZED_ACTION | 1215 | an unauthorized action is requested (sub-account behalf). |
SUB_ACCOUNT_CREATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SUB_ACCOUNT_CREATED", /* Event Sub-Type description */
"webhook_notification_code": 1200, /* 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": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
SUB_ACCOUNT_UPDATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SUB_ACCOUNT_UPDATED", /* Event Sub-Type description */
"webhook_notification_code": 1300, /* 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": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
SUB_ACCOUNT_CANCELLED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SUB_ACCOUNT_CANCELLED", /* Event Sub-Type description */
"webhook_notification_code": 1301, /* 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": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
SUB_ACCOUNT_FAILED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SUB_ACCOUNT_FAILED", /* Event Sub-Type description */
"webhook_notification_code": 1205, /* 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": 321, /* Object ID 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 document number provided" /* If status=failed, a description of the failure */
}
}
SA_EMAIL_UPDATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SA_EMAIL_UPDATED", /* Event Sub-Type description */
"webhook_notification_code": 1201, /* 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 */
"details": {
"id": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
SA_MOBILE_UPDATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SA_MOBILE_UPDATED", /* Event Sub-Type description */
"webhook_notification_code": 1202, /* 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 */
"details": {
"id": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
SA_SECRET_KEY_CREATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SA_SECRET_KEY_CREATED", /* Event Sub-Type description */
"webhook_notification_code": 1210, /* 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": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
SA_SECRET_KEY_UPDATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SA_SECRET_KEY_UPDATED", /* Event Sub-Type description */
"webhook_notification_code": 1211, /* 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": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
SA_SECRET_KEY_WARNING
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SA_SECRET_KEY_WARNING", /* Event Sub-Type description */
"webhook_notification_code": 1212, /* 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 */
"details": {
"id": 321, /* Object ID of the API resource created/updated */
"status": "success", /* The status of the action */
"code": "fb2992d3-5cf2-4177-8433-************",
"name": ""
}
}
SA_CREDENTIAL_UPDATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SA_CREDENTIAL_UPDATED", /* Event Sub-Type description */
"webhook_notification_code": 1213, /* 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 */
"details": {
"id": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
SA_CREDENTIAL_WARNING
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SA_CREDENTIAL_WARNING", /* Event Sub-Type description */
"webhook_notification_code": 1214, /* 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 */
"details": {
"id": 321, /* Object ID of the API resource created/updated */
"status": "success", /* The status of the action */
"code": "************",
"name": "user_account"
}
}
SA_UNAUTHORIZED_ACTION
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SA_UNAUTHORIZED_ACTION", /* Event Sub-Type description */
"webhook_notification_code": 1215, /* 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": 321, /* Object ID of the API resource created/updated */
"status": "failed", /* The status of the action */
"failed_reason": "Unauthorized request", /* If status=failed, a failure code */
"failed_message": "Secret Key Expired" /* If status=failed, a description of the failure */
}
}
Webhook List for payments received on behalf of Main Account
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... |
---|---|---|---|
ACCOUNT | SPEI_REFERENCE_CREATED | 1030 | SPEI clabe account is created. |
ACCOUNT | SPEI_WEBHOOK_ACCEPTED | 1031 | a success SPEI webhook is received (accepted) |
ACCOUNT | SPEI_WEBHOOK_CANCELLED | 1032 | a success SPEI webhook is requested to be cancelled. |
ACCOUNT | SPEI_WEBHOOK_REJECTED | 1033 | a failed SPEI webhook is received (rejected). |
ACCOUNT | SPEI_WEBHOOK_REFUNDED | 1034 | a SPEI transaction refund webhook is received (REFUND) |
ACCOUNT | CASH_REFERENCE_CREATED | 1040 | account CASH reference is created. |
ACCOUNT | CASH_WEBHOOK_ACCEPTED | 1041 | a success CASH webhook is received (accepted). |
ACCOUNT | CASH_WEBHOOK_CANCELLED | 1042 | a success CASH webhook is requested to be cancelled. |
ACCOUNT | CASH_WEBHOOK_REJECTED | 1043 | a failed CASH webhook is received (rejected). |
ACCOUNT | CODI_WEBHOOK_ACCEPTED | 1051 | a success CODI webhook is received (accepted). |
ACCOUNT | CODI_WEBHOOK_REJECTED | 1053 | a failed CODI webhook is received (rejected). |
ACCOUNT | SPEI_ACCOUNT_CASH_OUT_CREATED | 1060 | an account SPEI cash out is successfully created but pending processing. |
ACCOUNT | SPEI_ACCOUNT_CASH_OUT_SUCCESS | 1061 | an account SPEI cash out is successfully created. |
ACCOUNT | SPEI_ACCOUNT_CASH_OUT_CANCELLED | 1062 | an account SPEI cash out transaction was cancelled. |
ACCOUNT | SPEI_ACCOUNT_CASH_OUT_DECLINED | 1063 | an account SPEI cash out transaction was declined. |
ACCOUNT | SPEI_ACCOUNT_CASH_OUT_REJECTED | 1064 | an account SPEI cash out transaction was rejected. |
ACCOUNT | SPEI_ACCOUNT_CASH_OUT_FAILED | 1065 | an account SPEI cash out failed on being created. |
SPEI_WEBHOOKS
SPEI_REFERENCE_CREATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SPEI_REFERENCE_CREATED", /* Event Sub-Type description */
"webhook_notification_code": 1030, /* 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 that holds the generated clabe */
"request_id": 12343, /* If exist, our internal request ID related with the event. */
"details": {
"id": 0, /* No id here */
"status": "success" /* The status of the action */,
"code": "646123222734230003", // CLABE/reference created
}
}
SPEI_WEBHOOK_ACCEPTED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SPEI_WEBHOOK_ACCEPTED", /* Event Sub-Type description */
"webhook_notification_code": 1031, /* 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. */
"details": {
"id": 125436, /* ID of Spei transaction, unique and used later for refunds */
"status": "success", /* The status of the action */
"amount": "1344.43", /* Amount of the money in request */
"code": "646123222734230003", /* Beneficiary CLABE account */
"name": ""
},
"metadata": {
"payer_name":"PAYER NAME",
"payer_account":"00000605847406932", /* Payer Clabe Account */
"payer_rfc":"AAAA9111059J5",
"payer_institution":"40014",
"beneficiary_account":"646180000002175408", /* Beneficiary CLABE account */
"beneficiary_rfc":"AAAA9111059J6",
"beneficiary_name":"BELANEA MEXICO, SAPI DE CV",
"payment_concept":"TRANSFERENCIA A CUENTA CLABE",/* Payment Concept */
"tracking_key":"2025060440014TRAPP001436462539",
"numeric_reference":"3925461"
}
}
SPEI_WEBHOOK_CANCELLED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SPEI_WEBHOOK_CANCELLED", /* Event Sub-Type description */
"webhook_notification_code": 1032, /* 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. */
"details": {
"id": 125436, /* ID of Spei transaction, unique and used later for refunds */
"status": "success", /* The status of the action */
"amount": "1344.43", /* Amount related with the API resource created/updated */
"code": "646123222734230003",
"name": ""
}
}
SPEI_WEBHOOK_REJECTED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SPEI_WEBHOOK_REJECTED", /* Event Sub-Type description */
"webhook_notification_code": 1033, /* 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. */
"details": {
"id": 125436, /* ID of Spei transaction, unique and used later for refunds */
"status": "failed", /* The status of the action */
"code": "646010222734232318",
"name": "",
"failed_reason": "Clabe not found or disabled", /* If status=failed, a failure code */
"failed_message": "Clabe number received does not exist or is disabled" /* If status=failed, a description of the failure */
}
}
SPEI_WEBHOOK_REFUNDED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SPEI_WEBHOOK_REFUNDED", /* Event Sub-Type description */
"webhook_notification_code": 1034, /* 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. */
"details": {
"id": 125436, /* ID of Spei transaction that was refunded */
"status": "Refunded", /* The status of the action */
"amount": "1344.43", /* Amount of the SPEI transaction */
"code": "646123222734230003", /* Beneficiary CLABE account */
"name": "SUCCESS"
},
"metadata": {
"payer_name":"PAYER NAME",
"payer_account":"00000605847406932", /* Payer Clabe Account */
"payer_rfc":"AAAA9111059J5",
"payer_institution":"40014",
"beneficiary_account":"646180000002175408", /* Beneficiary CLABE account */
"beneficiary_rfc":"AAAA9111059J6",
"beneficiary_name":"BELANEA MEXICO, SAPI DE CV",
"payment_concept":"TRANSFERENCIA A CUENTA CLABE",/* Payment Concept */
"tracking_key":"2025060440014TRAPP001436462539",
"numeric_reference":"3925461"
}
}
SPEI_ACCOUNT_CASH_OUT_FAILED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SPEI_ACCOUNT_CASH_OUT_FAILED", /* Event Sub-Type description */
"webhook_notification_code": 1065, /* 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 */
"transaction_id": "trx_ehe77r6t8et5", /* If exist, external transaction ID related with the event. */
"details": {
"id": 321, /* Object ID of the API resource created/updated */
"status": "failed", /* The status of the action */
"code": "4643546543",
"name": "Jonh Mashup",
"amount": "1344.43", /* Amount related with the API resource created/updated */
"failed_reason": "Inconsistent data", /* If status=failed, a failure code */
"failed_message": "Unable to create account spei cashout; low balance" /* If status=failed, a description of the failure */
}
}
SPEI_ACCOUNT_CASH_OUT_SUCCESS
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SPEI_ACCOUNT_CASH_OUT_SUCCESS", /* Event Sub-Type description */
"webhook_notification_code": 1061, /* 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": -1, /* No customer id for cashout operations */
"transaction_id": "trx_ehe77r6t8et5", /* If exist, external transaction ID related with the event. */
"details": {
"id": 533432, /* Spei Out transaction ID */
"status": "success", /* The status of the action */
"amount": "1344.43", /* Amount of the SPEI transaction */
"code": "646123222734230003", /* Beneficiary CLABE account */
"name": "Jonh Mashup",
},
"metadata": {
"payer_name":"PAYER NAME",
"payer_account":"00000605847406932", /* Payer Clabe Account */
"payer_rfc":"AAAA9111059J5",
"payer_institution":"40014",
"beneficiary_account":"646180000002175408", /* Beneficiary CLABE account */
"beneficiary_rfc":"AAAA9111059J6",
"beneficiary_name":"BELANEA MEXICO, SAPI DE CV",
"payment_concept":"TRANSFERENCIA A CUENTA CLABE",/* Payment Concept */
"tracking_key":"2025060440014TRAPP001436462539",
"numeric_reference":"3925461"
}
}
SPEI_ACCOUNT_CASH_OUT_CREATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SPEI_ACCOUNT_CASH_OUT_CREATED", /* Event Sub-Type description */
"webhook_notification_code": 1060, /* 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 */
"transaction_id": "trx_ehe77r6t8et5", /* If exist, external transaction ID related with the event. */
"details": {
"id": 533432, /* Spei Out transaction ID */
"status": "success", /* The status of the action */
"code": "4643546543",
"name": "Jonh Mashup",
"amount": "1344.43" /* Amount related with the API resource created/updated */
},
"metadata": {
"payer_name":"PAYER NAME",
"payer_account":"00000605847406932", /* Payer Clabe Account */
"payer_rfc":"AAAA9111059J5",
"payer_institution":"40014",
"beneficiary_account":"646180000002175408", /* Beneficiary CLABE account */
"beneficiary_rfc":"AAAA9111059J6",
"beneficiary_name":"BELANEA MEXICO, SAPI DE CV",
"payment_concept":"TRANSFERENCIA A CUENTA CLABE",/* Payment Concept */
"tracking_key":"2025060440014TRAPP001436462539",
"numeric_reference":"3925461"
}
}
SPEI_ACCOUNT_CASH_OUT_CANCELLED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SPEI_ACCOUNT_CASH_OUT_CANCELLED",/*Event Sub-Type description */
"webhook_notification_code": 1062, /* 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 */
"transaction_id": "trx_ehe77r6t8et5", /* If exist, external transaction ID related with the event. */
"details": {
"id": 533432, /* Spei Out transaction ID */
"status": "cancelled", /* The status of the action */
"code": "4643546543",
"name": "Jonh Mashup",
"amount": "1344.43", /* Amount related with the API resource created/updated */
"failed_reason": "CANCELLED BY PROVIDER", /* If status=failed, a failure code */
"failed_message": "Transaction cancelled by the bank or provider" /* If
}
}
SPEI_ACCOUNT_CASH_OUT_REJECTED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SPEI_ACCOUNT_CASH_OUT_REJECTED", /* Event Sub-Type description */
"webhook_notification_code": 1063, /* 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 */
"transaction_id": "trx_ehe77r6t8et5", /* If exist, external transaction ID related with the event. */
"details": {
"id": 533432, /* Spei Out transaction ID */
"status": "rejected", /* The status of the action */
"code": "4643546543",
"name": "Jonh Mashup",
"amount": "1344.43", /* Amount related with the API resource created/updated */
"failed_reason": "REJECTED", /* If status=failed, a failure code */
"failed_message": "Transaction rejected by bank or provider" /* If
}
}
SPEI_ACCOUNT_CASH_OUT_DECLINED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "SPEI_ACCOUNT_CASH_OUT_DECLINED", /* Event Sub-Type description */
"webhook_notification_code": 1064, /* 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 */
"transaction_id": "trx_ehe77r6t8et5", /* If exist, external transaction ID related with the event. */
"details": {
"id": 533432, /* Spei Out transaction ID */
"status": "declined", /* The status of the action */
"code": "4643546543",
"name": "Jonh Mashup",
"amount": "1344.43", /* Amount related with the API resource created/updated */
"failed_reason": "DECLINED", /* If status=failed, a failure code */
"failed_message": "Transaction declined by bank or provider" /* If
}
}
CASH_WEBHOOKS
CASH_REFERENCE_CREATED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "CASH_REFERENCE_CREATED", /* Event Sub-Type description */
"webhook_notification_code": 1040, /* 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": 321, /* Object ID of the API resource created/updated */
"status": "success" /* The status of the action */
}
}
CASH_WEBHOOK_ACCEPTED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "CASH_WEBHOOK_ACCEPTED", /* Event Sub-Type description */
"webhook_notification_code": 1041, /* 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. */
"details": {
"id": 64354, /* Object ID of the API resource created/updated */
"status": "success", /* The status of the action */
"amount": "1344.43", /* Amount related with the API resource created/updated */
"code": "5450541222000123"
}
}
CASH_WEBHOOK_CANCELLED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "CASH_WEBHOOK_CANCELLED", /* Event Sub-Type description */
"webhook_notification_code": 1042, /* 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. */
"details": {
"id": 64354, /* Object ID of the API resource created/updated */
"status": "success", /* The status of the action */
"amount": "1344.43", /* Amount related with the API resource created/updated */
"code": "5450541222000123"
}
}
CASH_WEBHOOK_REJECTED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "CASH_WEBHOOK_REJECTED", /* Event Sub-Type description */
"webhook_notification_code": 1043, /* 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. */
"details": {
"id": 46576, /* Object ID of the API resource created/updated */
"status": "failed", /* The status of the action */
"code": "568569583457353",
"failed_reason": "FAILED_ON_VALIDATE", /* If status=failed, a failure code */
"failed_message": "Reference number provided does not exist or is disabled" /* If status=failed, a description of the failure */
}
}
CODI_WEBHOOKS
CODI_WEBHOOK_ACCEPTED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "CODI_WEBHOOK_ACCEPTED", /* Event Sub-Type description */
"webhook_notification_code": 1051, /* 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": 321, /* Object ID of the API resource created/updated */
"status": "success", /* The status of the action */
}
}
CODI_WEBHOOK_REJECTED
{
"event_type": "ACCOUNT", /* API Event Type */
"event_type_description": "CODI_WEBHOOK_REJECTED", /* Event Sub-Type description */
"webhook_notification_code": 1053, /* 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": 321, /* Object ID of the API resource created/updated */
"status": "failed", /* The status of the action */
"failed_reason": "FAILED_ON_VALIDATE", /* If status=failed, a failure code */
"failed_message": "Invalid payload; CODI config for maximum allowed amount exceeded" /* If status=failed, a description of the failure */
}
}