API Reference

Checkout Orders

Reference of Payloads to be sent for event type CHECKOUT_ORDERS.

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 TypeEvent Sub TypeCodescheduled to be sent whenever...
CHECKOUT_ORDER_CREATEDCHECKOUT_ORDER_CREATED9000an order is created succesfully.
CHECKOUT_ORDER_COMPLETEDCHECKOUT_ORDER_COMPLETED9001Confirmation that payment attempt was success.
CHECKOUT_ORDER_FAILEDCHECKOUT_ORDER_FAILED9101a checkout order failed on being created.
CHECKOUT_ORDER_PAYMENT_FAILEDCHECKOUT_ORDER_PAYMENT_FAILED9004a checkout created order failed the payment attempt.

CHECKOUT_ORDER_CREATED

{
	  "event_type": "CHECKOUT_ORDERS", /* API Event Type */
	  "event_type_description": "CHECKOUT_ORDER_CREATED", /* Event Sub-Type description */
	  "webhook_notification_code": 9000, /* 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 custom ID related with the event, if exist  */
	  "details": {
		    "id": "145", /* Object ID of the API resource created/updated */
		    "code": "1d296142-bcae-4730-a40a-d194f8c6bb76", /* Order id token reference */
        "name" : "SUCCESS",
		    "status": "success", /* The status of the action */
	  }
}

CHECKOUT_ORDER_COMPLETED

{
	  "event_type": "CHECKOUT_ORDERS", /* API Event Type */
	  "event_type_description": "CHECKOUT_ORDER_COMPLETED", /* Event Sub-Type description */
	  "webhook_notification_code": 9001, /* 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 custom ID related with the event, if exist  */
	  "details": {
		    "id": "145", /* Object ID of the API resource created/updated */
		    "code": "1d296142-bcae-4730-a40a-d194f8c6bb76", /* Order id token reference */
        "name" : "SUCCESS",
		    "status": "success", /* The status of the action */
	  }
}

CHECKOUT_ORDER_FAILED

{
	  "event_type": "CHECKOUT_ORDERS", /* API Event Type */
	  "event_type_description": "CHECKOUT_ORDER_FAILED", /* Event Sub-Type description */
	  "webhook_notification_code": 9102, /* 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": "Order failed on being created" /* If status=failed, a description of the failure */
	  }
}

CHECKOUT_ORDER_PAYMENT_FAILED

{
	  "event_type": "CHECKOUT_ORDERS", /* API Event Type */
	  "event_type_description": "CHECKOUT_ORDER_PAYMENT_FAILED", /* Event Sub-Type description */
	  "webhook_notification_code": 9004, /* 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": 123, /* Object ID of the API resource created/updated */
      	"code": "1d296142-bcae-4730-a40a-d194f8c6bb76", /* Order id token 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": "Order failed on payment" /* If status=failed, a description of the failure */
	  }
}

go up