Reference of Payloads to be sent for event type PAYMENT_REQUEST_CASHOUT.
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_CASHOUT | CASHOUT_REFERENCE_CREATED | 8000 | a cash out reference is created. |
| PAYMENT_REQUEST_CASHOUT | CASHOUT_REFERENCE_COMPLETED | 8001 | we got confirmation from providers that reference was fulfilled successfully. |
| PAYMENT_REQUEST_CASHOUT | CASHOUT_REFERENCE_CANCELED | 8002 | a cash out reference is canceled. |
| PAYMENT_REQUEST_CASHOUT | CASHOUT_REFERENCE_FAILED | 8003 | a cash-out reference is failed on being created. |
| PAYMENT_REQUEST_CASHOUT | CASHOUT_REFERENCE_EXPIRED | 8004 | a cash out reference is expired. |
CASHOUT_REFERENCE_CREATED
{
"event_type": "PAYMENT_REQUEST_CASHOUT", /* API Event Type */
"event_type_description": "CASHOUT_REFERENCE_CREATED", /* Event Sub-Type description */
"webhook_notification_code": 8000, /* 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": "128944531190", /* Cashout reference */
"name" : "SUCCESS",
"status": "success", /* The status of the action */
}
}
CASHOUT_REFERENCE_CANCELED
{
"event_type": "PAYMENT_REQUEST_CASHOUT", /* API Event Type */
"event_type_description": "CASHOUT_REFERENCE_CANCELED", /* Event Sub-Type description */
"webhook_notification_code": 8002, /* 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": "128944531190", /* Cashout reference */
"name" : "SUCCESS",
"status": "success", /* The status of the action */
}
}
CASHOUT_REFERENCE_FAILED
{
"event_type": "PAYMENT_REQUEST_CASHOUT", /* API Event Type */
"event_type_description": "CASHOUT_REFERENCE_FAILED", /* Event Sub-Type description */
"webhook_notification_code": 8003, /* 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, /* Cashout reference */
"name": "FAILED", /* Object Code of the API resource created/updated */
"status": "failed", /* The status of the action */
"failed_reason": "REFERENCE_FAILED", /* If status=failed, a failure code */
"failed_message": "Reference failed on being created" /* If status=failed, a description of the failure */
}
}
CASHOUT_REFERENCE_EXPIRED
{
"event_type": "PAYMENT_REQUEST_CASHOUT", /* API Event Type */
"event_type_description": "CASHOUT_REFERENCE_EXPIRED", /* Event Sub-Type description */
"webhook_notification_code": 8004, /* 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": "128944531190", /* Cashout reference */
"name": "EXPIRED", /* Object Code of the API resource created/updated */
"status": "expired", /* The status of the action */
"failed_reason": "REFERENCE_EXPIRED", /* If status=failed, a failure code */
"failed_message": "Reference is expired" /* If status=failed, a description of the failure */
}
}
CASHOUT_REFERENCE_COMPLETED
{
"event_type": "PAYMENT_REQUEST_CASHOUT", /* API Event Type */
"event_type_description": "CASHOUT_REFERENCE_COMPLETED", /* Event Sub-Type description */
"webhook_notification_code": 8001, /* 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": "128944531190", /* Cashout reference */
"name": "SUCCESS", /* Object Code of the API resource created/updated */
"status": "success", /* The status of the action */
}
}