Skip to main content

Update Payment Error

Use the Update Payment Error card to notify the user when the selected payment method cannot process a payment.



This screen includes:

#ElementDescription
1Error bannerDisplays Please update payment details
2Payment iconIdentifies a payment method issue
3Error messageStates that the payment method cannot process the payment
4Update actionOpens the payment details flow

Workflow​

  1. Detect a payment method error.
  2. Call PUT /api/v3/payment-method/error.
  3. Display the payment error card.
  4. Select Update your payment details.
  5. Open the payment details flow.

Validations​

ScenarioApp behaviorSDK output
Payment error data is availableDisplay the error cardstate = ready
Payment error data is invalidBlock the carderror = invalid_payment_error
Request failsDisplay an error statestate = error
Session is invalidBlock accessstate = unauthenticated

Actions​

ScenarioApp behaviorSDK output
Error request succeedsDisplay the payment error cardPage object
Update action selectedOpen the payment details flowNavigation event

Endpoint Resources​

Payment Error​

PUT 

v3/payment-method/error

Returns the payment error card when the selected payment method cannot process the payment.