Intro

When you create or complete a payment intent, Belvo returns instructions in the next_step object you’ll need to follow to guide your user through the payment process. These instructions differ depending on the payment flow you're using, so to make things easier we created this dedicated article for each next step to help you navigate the payment intent flow. 🤓

Creating a payment intent for a new customer

pse_display_payment_method_information

When sent?

• your customer needs to select an institution.
• there is an unexpected error during the payment process and the customer needs to start the payment flow from the beginning.

Possible next_step responses

• pse_display_credentials_required
• pse_display_payment_method_information

Payment intent status

• REQUIRES_PAYMENT_METHOD

---

pse_display_credentials_required

When sent?

• you need to collect your customer’s credentials.
• the credentials provided are invalid and have to be input again.

Possible next_step responses

• pse_display_customer_bank_accounts
• pse_display_token_required
• pse_display_payment_method_information

Payment intent status

• REQUIRES_PAYMENT_METHOD

---

pse_display_token_required

When sent?

• your customer needs to input the institution-required MFA token.
• the MFA token provided is invalid and has to be input again.

Possible next_step responses

• pse_display_token_required
• pse_display_credentials_required
• pse_display_payment_method_information

Payment intent status

• REQUIRES_PAYMENT_METHOD

---

pse_display_customer_bank_accounts

When sent?

• your customer needs to select a bank account to make the payment.

Possible next_step responses

• pse_display_confirmation_required
• pse_display_payment_processing

Payment intent status

• PROCESSING
• REQUIRES_PAYMENT_METHOD

---

pse_display_confirmation_required

When sent?

• you have to send through confirm: true in the PATCH request to process the payment.

Possible next_step responses

• pse_display_payment_processing
• pse_display_payment_method_information

Payment intent status

• PROCESSING

---

pse_display_payment_processing

When sent?

• the payment is being processed because you sent through confirm: true in the PATCH request.

Possible next_step responses

• pse_display_payment_succeeded
• pse_display_payment_failed

Payment intent status

• PROCESSING

---

pse_display_payment_succeeded

When sent?

• the payment process succeeded.

Possible next_step responses

• null

Payment intent status

• SUCCEEDED

---

pse_display_payment_failed

When sent?

• the payment process failed.

Possible next_step responses

• null

Payment intent status

• FAILED

---

Creating a payment intent to collect subsequent payments

pse_display_customer_bank_accounts

When sent?

• your customer needs to select a bank account to make the payment.

Possible next_step responses

• pse_display_token_required

Payment intent status

• REQUIRES_PAYMENT_METHOD

---

pse_display_token_required

When sent?

• your customer needs to input the institution-required MFA token.
• the MFA token provided is invalid and has to be input again.

Possible next_step responses

• pse_display_confirmation_required
• pse_display_payment_processing
• pse_display_token_required

Payment intent status

• REQUIRES_PAYMENT_METHOD

---

pse_display_payment_method_information

When sent?

• your customer needs to select an institution.
• there is an unexpected error during the payment process and the customer needs to start the payment flow from the beginning.

Possible next_step responses

• pse_display_credentials_required
• pse_display_payment_method_information

Payment intent status

• REQUIRES_PAYMENT_METHOD

---

pse_display_confirmation_required

When sent?

• you have to send through confirm: true in the PATCH request to process the payment.

Possible next_step responses

• pse_display_payment_processing

Payment intent status

• PROCESSING

---

pse_display_payment_processing

When sent?

• the payment is being processed because you sent through confirm: true in the PATCH request.

Possible next_step responses

• pse_display_payment_succeeded
• pse_display_payment_failed

Payment intent status

• PROCESSING

---

pse_display_payment_succeeded

When sent?

• the payment process succeeded.

Possible next_step responses

• null

Payment intent status

• SUCCEEDED

---

pse_display_payment_failed

When sent?

• the payment process failed.

Possible next_step responses

• null

Payment intent status

• FAILED

---

Creating a payment intent using the non-Belvo flow

pse_display_payment_method_information

When sent?

• your customer needs to select an institution.
• there is an unexpected error during the payment process and the customer needs to start the payment flow from the beginning.

Possible next_step responses

• pse_display_needs_redirect
• pse_display_payment_method_information

Payment intent status

• REQUIRES_PAYMENT_METHOD

---

pse_display_needs_redirect

When sent?

• your customer selected a non-supported Belvo institution and needs to be redirected to their institution to continue the payment process.

Possible next_step responses

• pse_display_payment_processing
• pse_display_payment_method_information

Payment intent status

• REQUIRES_PAYMENT_METHOD

---

pse_display_payment_processing

When sent?

• the payment is being processed because you sent through confirm: true in the PATCH request.

Possible next_step responses

• pse_display_payment_succeeded
• pse_display_payment_failed

Payment intent status

• PROCESSING

---

pse_display_payment_succeeded

When sent?

• the payment process succeeded.

Possible next_step responses

• null

Payment intent status

• SUCCEEDED

---

pse_display_payment_failed

When sent?

• the payment process failed.

Possible next_step responses

• null

Payment intent status

• FAILED