Payment Request Domiciled

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_REQUEST_DMCL	DMCL_REQUEST_CREATED	6000	a domiciled payment request is created.
PAYMENT_REQUEST_DMCL	DMCL_REQUEST_UPDATED	6100	a domiciled payment request is updated.
PAYMENT_REQUEST_DMCL	DMCL_REQUEST_CANCELLED	6101	a domiciled payment request is cancelled.
PAYMENT_REQUEST_DMCL	DMCL_REQUEST_FAILED	6002	a domiciled payment request failed on being created, updated, cancelled or we have confirmation from providers that payment attempt was rejected.
PAYMENT_REQUEST_DMCL	DMCL_REQUEST_SUCCESS	6001	we got confirmation from providers that payment attempt was success.
PAYMENT_REQUEST_DMCL	DMCL_REQUEST_CHARGEBACK	6005	we got confirmation from providers that chargeback has been made by your customer.

DMCL_REQUEST_CREATED

{
	  "event_type": "PAYMENT_REQUEST_DMCL", /* API Event Type */
	  "event_type_description": "DMCL_REQUEST_CREATED", /* Event Sub-Type description */
	  "webhook_notification_code": 6000, /* 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. */
	  "transaction_id": "trx_ewrehe77r6t8et8t6", /* External transaction ID related with the event, if exist */
	  "details": {
		    "id": null, /* Object ID of the API resource created/updated */
		    "code": "domres_20240617_hr5eg4gege3", /* Object Code of the API resource created/updated */
		    "status": "success", /* The status of the action */
	  }
}

DMCL_REQUEST_UPDATED

{
	  "event_type": "PAYMENT_REQUEST_DMCL", /* API Event Type */
	  "event_type_description": "DMCL_REQUEST_UPDATED", /* Event Sub-Type description */
	  "webhook_notification_code": 6100, /* 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. */
	  "transaction_id": "trx_ewrehe77r6t8et8t6", /* External transaction ID related with the event, if exist */
	  "details": {
		    "id": null, /* Object ID of the API resource created/updated */
		    "code": "domres_20240617_hr5eg4gege3", /* Object Code of the API resource created/updated */
		    "status": "success", /* The status of the action */
	  }
}

DMCL_REQUEST_CANCELLED

{
	  "event_type": "PAYMENT_REQUEST_DMCL", /* API Event Type */
	  "event_type_description": "DMCL_REQUEST_CANCELLED", /* Event Sub-Type description */
	  "webhook_notification_code": 6101, /* 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. */
	  "transaction_id": "trx_ewrehe77r6t8et8t6", /* External transaction ID related with the event, if exist */
	  "details": {
		    "id": null, /* Object ID of the API resource created/updated */
		    "code": "domres_20240617_hr5eg4gege3", /* Object Code of the API resource created/updated */
		    "status": "success", /* The status of the action */
	  }
}

DMCL_REQUEST_FAILED

{
	  "event_type": "PAYMENT_REQUEST_DMCL", /* API Event Type */
	  "event_type_description": "DMCL_REQUEST_FAILED", /* Event Sub-Type description */
	  "webhook_notification_code": 6002, /* 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. */
	  "transaction_id": "trx_ewrehe77r6t8et8t6", /* External transaction ID related with the event, if exist */
	  "details": {
		    "id": null, /* Object ID of the API resource created/updated */
        "code": null, /* Object Code of the API resource created/updated */
		    "status": "failed", /* The status of the action */
		    "failed_reason": "FAILED_ON_CREATE", /* If status=failed, a failure code */
		    "failed_message": "Invalid bank code provided" /* If status=failed, a description of the failure */
	  }
}

DMCL_REQUEST_SUCCESS

{
	  "event_type": "PAYMENT_REQUEST_DMCL", /* API Event Type */
	  "event_type_description": "DMCL_REQUEST_SUCCESS", /* Event Sub-Type description */
	  "webhook_notification_code": 6001, /* 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. */
	  "transaction_id": "trx_ewrehe77r6t8et8t6", /* External transaction ID related with the event, if exist */
	  "details": {
		    "id": null, /* Object ID of the API resource created/updated */
		    "code": "domres_20240617_hr5eg4gege3", /* Object Code of the API resource created/updated */
		    "status": "success", /* The status of the action */
	  }
}

DMCL_REQUEST_CHARGEBACK

{
	  "event_type": "PAYMENT_REQUEST_DMCL", /* API Event Type */
	  "event_type_description": "DMCL_REQUEST_CHARGEBACK", /* Event Sub-Type description */
	  "webhook_notification_code": 6005, /* 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. */
	  "transaction_id": "trx_ewrehe77r6t8et8t6", /* External transaction ID related with the event, if exist */
	  "details": {
		    "id": null, /* Object ID of the API resource created/updated */
		    "code": "domres_20240617_hr5eg4gege3", /* Object Code of the API resource created/updated */
		    "status": "success", /* The status of the action */
	  }
}

Webhook List

DMCL_REQUEST_CREATED

DMCL_REQUEST_UPDATED

DMCL_REQUEST_CANCELLED

DMCL_REQUEST_FAILED

DMCL_REQUEST_SUCCESS

DMCL_REQUEST_CHARGEBACK

go up