Payment Request Cash In

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_CASHIN	CASHIN_REFERENCE_CREATED	7000	a cash in reference is created.
PAYMENT_REQUEST_CASHIN	CASHIN_REFERENCE_CANCELED	7101	a cash in reference is cancelled.
PAYMENT_REQUEST_CASHIN	CASHIN_REFERENCE_FAILED	7002	a cash in reference payment request is failed.
PAYMENT_REQUEST_CASHIN	CASHIN_REFERENCE_EXPIRED	7102	a cash in reference is expired.
PAYMENT_REQUEST_CASHIN	CASHIN_REFERENCE_COMPLETED	7001	we got confirmation from providers that payment attempt was success.

CASHIN_REFERENCE_CREATED

{
	  "event_type": "PAYMENT_REQUEST_CASHIN", /* API Event Type */
	  "event_type_description": "CASHIN_REFERENCE_CREATED", /* Event Sub-Type description */
	  "webhook_notification_code": 7000, /* 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", /* Cash in reference */
        "amount": "1344.43", /* Amount related with the API resource created/updated */
		    "status": "success", /* The status of the action */
	  }
}

CASHIN_REFERENCE_CANCELED

{
	  "event_type": "PAYMENT_REQUEST_CASHIN", /* API Event Type */
	  "event_type_description": "CASHIN_REFERENCE_CANCELED", /* Event Sub-Type description */
	  "webhook_notification_code": 7101, /* 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", /* Cash in reference */
        "amount": "1344.43", /* Amount related with the API resource created/updated */
		    "status": "success", /* The status of the action */
	  }
}

CASHIN_REFERENCE_FAILED

{
	  "event_type": "PAYMENT_REQUEST_CASHIN", /* API Event Type */
	  "event_type_description": "CASHIN_REFERENCE_FAILED", /* Event Sub-Type description */
	  "webhook_notification_code": 7002, /* 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", /* Cash in reference */
      "amount": "1344.43", /* Amount related with the API resource created/updated */
		    "status": "success", /* The status of the action */
	  }
}

CASHIN_REFERENCE_EXPIRED

{
	  "event_type": "PAYMENT_REQUEST_CASHIN", /* API Event Type */
	  "event_type_description": "CASHIN_REFERENCE_EXPIRED", /* Event Sub-Type description */
	  "webhook_notification_code": 7102, /* 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, /* Cash in reference */
      "amount": "1344.43", /* Amount related with 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 */
	  }
}

CASHIN_REFERENCE_COMPLETED

{
	  "event_type": "PAYMENT_REQUEST_CASHIN", /* API Event Type */
	  "event_type_description": "CASHIN_REFERENCE_COMPLETED", /* Event Sub-Type description */
	  "webhook_notification_code": 7001, /* 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", /* Cash in reference */
      "amount": "1344.43", /* Amount related with the API resource created/updated */
		    "status": "success", /* The status of the action */
	  }
}

Webhook List

CASHIN_REFERENCE_CREATED

CASHIN_REFERENCE_CANCELED

CASHIN_REFERENCE_FAILED

CASHIN_REFERENCE_EXPIRED

CASHIN_REFERENCE_COMPLETED

go up