API Reference

Payment Method Card

Reference of Payloads to be sent for event type PAYMENT_METHOD_CARD.

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...
PAYMENT_METHOD_CARDPAYMENT_METHOD_CREATED3000a card payment method is created.
PAYMENT_METHOD_CARDPAYMENT_METHOD_UPDATED3100a card payment method is updated.
PAYMENT_METHOD_CARDPAYMENT_METHOD_DELETED3101a card payment method is deleted.
PAYMENT_METHOD_CARDPAYMENT_METHOD_USED3300a card payment method is used (a charge was requested).
PAYMENT_METHOD_CARDPAYMENT_METHOD_FAILED3002a card payment method failed on being created, updated or deleted.

PAYMENT_METHOD_CREATED_CARD

{
	  "event_type": "PAYMENT_METHOD_CARD", /* API Event Type */
	  "event_type_description": "PAYMENT_METHOD_CREATED", /* Event Sub-Type description */
	  "webhook_notification_code": 3000, /* 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": 134, /* Object ID of the API resource created/updated */
		    "code": "paycard_k23nsdof98ud087arf", /* Object Code of the API resource created/updated */
		    "status": "success", /* The status of the action */
	  }
}

PAYMENT_METHOD_UPDATED_CARD

{
	  "event_type": "PAYMENT_METHOD_CARD", /* API Event Type */
	  "event_type_description": "PAYMENT_METHOD_UPDATED", /* Event Sub-Type description */
	  "webhook_notification_code": 3100, /* 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": 134, /* Object ID of the API resource created/updated */
		    "code": "paycard_k23nsdof98ud087arf", /* Object Code of the API resource created/updated */
		    "status": "success", /* The status of the action */
	  }
}

PAYMENT_METHOD_DELETED_CARD

{
	  "event_type": "PAYMENT_METHOD_CARD", /* API Event Type */
	  "event_type_description": "PAYMENT_METHOD_DELETED", /* Event Sub-Type description */
	  "webhook_notification_code": 3101, /* 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": 134, /* Object ID of the API resource created/updated */
		    "code": "paycard_k23nsdof98ud087arf", /* Object Code of the API resource created/updated */
		    "status": "success", /* The status of the action */
	  }
}

PAYMENT_METHOD_USED_CARD

{
	  "event_type": "PAYMENT_METHOD_CARD", /* API Event Type */
	  "event_type_description": "PAYMENT_METHOD_USED", /* Event Sub-Type description */
	  "webhook_notification_code": 3300, /* 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": 134, /* Object ID of the API resource created/updated */
		    "code": "paycard_k23nsdof98ud087arf", /* Object Code of the API resource created/updated */
		    "status": "success", /* The status of the action */
	  }
}

PAYMENT_METHOD_FAILED_CARD

{
	  "event_type": "PAYMENT_METHOD_CARD", /* API Event Type */
	  "event_type_description": "PAYMENT_METHOD_FAILED", /* Event Sub-Type description */
	  "webhook_notification_code": 3002, /* 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": 134, /* Object ID of the API resource created/updated */
		    "code": "paycard_k23nsdof98ud087arf", /* Object Code 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 card data provided" /* If status=failed, a description of the failure */
	  }
}

go up