Docs

checkout.payment.error

Emitted when a payment errors for a checkout.

Use checkout.payment.error to run actions when a payment errors for a checkout.

This typically occurs when no payment methods are available. For example, if you open a checkout with allowedPaymentMethods set to ["apple-pay"], but the customer's device or browser doesn't support Apple Pay, this is emitted.

namestring
Name of this event, in the format entity.event_type.
typestring
Type of error which occured.
Values
  • front-end_error
    Typically means there's a problem with Paddle.js or your integration.
  • api_error
    Typically means there's a problem with the Paddle API.
codestring
Short snake case string that describes this error. Use to search the error reference.
detailstring
Some information about what went wrong as a human-readable string.
documentation_urlstring
Link to a page in the error reference for this specific error.
Example
{
  "name": "checkout.payment.error",
  "type": "front-end_error",
  "code": "no_payment_methods_available",
  "detail": "No payment methods available",
  "documentation_url": "https://developer.paddle.com/api-reference/overview"
}

Was this page helpful?