This functionality will be deprecated in Q3 2025 and is already replaced by Get Merchant Accounts via the
lifecycle.status
and last_user_action.status
fields.external_user_id
in the request to List Merchants will return a status
parameter in the response. The values for the status
parameter can be found below:
status | Description |
---|---|
not enrolled | The user has not provided login credentials (or other sufficient step-up authentication information such as an OTP code) to authenticate with the merchant. |
enrolling | The user provided login credentials (or other step-up authentication information such as an OTP code) for the merchant and authentication to the merchant is currently taking place. |
credentials | The user attempted to login to the merchant, but provided incorrect login credentials and needs to provide new ones to re-attempt the login. |
otp | The user needs to provide a step-up authentication OTP code to login to the merchant, either for the first time or because it was provided incorrectly before. If the user does not provide this within a short period, the status will change to failed . |
approval | The user needs to approve the login via a push notification, text message, or similar from the merchant. |
questions | The user needs to provide answers to security questions. |
zip | The user needs to provide their zip code. |
enrolled | The user successfully logged in to the merchant and the action (such as a card switch) was performed successfully (if applicable). |
failed | The user was unsuccessful in logging in to the merchant (or was successful, but updating the card-on-file was unsuccessful). |