Error Overview

Flexiti uses conventional HTTP response codes to indicate the success or failure of an API request. In general:

...

Code Block

{
    "url": "/flexiti/pos-api/v2.5/client-id/flexitidemo/customers/828930/verify",
    "message": "Some inputs are wrong!",
    "error": "wrong_input",
    "field_errors": [
        {
            "param": "email",
            "msg": "invalid",
            "value": "johndoe@"
        }
    ]
}

...

Merchant Integration Endpoint Errors

POST /oauth/token

Code	Error	Scenario
400	invalid_client	Wrong or missing client id or client_secret
400	invalid_request	Invalid or missing grant_type parameter
409	invalid_role	The Developer Portal account being used is not provisioned for the API being accessed. Please contact Flexiti Implementation Support.

...

GET /client-id/{

...

clientId}/i18n

Code	Error	Scenario
409	general_error	A generic error covering back-end process issues
409	invalid_role	The Developer Portal account being used is not provisioned for the API being accessed. Please contact Flexiti Implementation Support.

Code	Error	Scenario
409	authentication_failure	Wrong Merchant username or passwordinvalid_role	The Developer Portal account being used is not provisioned for the API being accessed. Please contact Flexiti Implementation Support.
409	general_error	A generic error covering back-end process issues

...

Credit Application Endpoint Errors

POST /client-id/{client_id}/apply

Code	Error	Scenario
400	general_error	A generic error covering back-end process issues
409	invalid_role	The Developer Portal account being used is not provisioned for the API being accessed. Please contact Flexiti Implementation Support.
409	application_create_error	There was an error creating the Credit Application due to a 3rd party timeout
409	tos_agreement_required	Terms and Conditions missing or not agreed
409	customer_already_exists	Customer applying already has an account
409	not_verified	For the online channel, the /apply payload contains different personal information than the /init payload using the same token, or incorrect widget_session_id
409	external_location_id_not_found	The external location ID being passed is not registered with Flexiti
409	account_type_not_permitted	The merchant is not able to support applications for this account type.

...

Customer Endpoint Errors

GET /client-id/{client_id}/customers/lookup

...

Code	Error	Scenario
404	not_found	Customer Account not found
409	invalid_role	The Developer Portal account being used is not provisioned for the API being accessed. Please contact Flexiti Implementation Support.
409	general_error	A generic error covering back-end process issues

...

Transaction Endpoint Errors

POST /client-id/{client_id}/transactions

Code	Error	Scenario
403	Insufficient scope: authorized scope is insufficient	Scope of the token is not sufficient to access the endpoint
404	not_found	Customer Account, transaction, not found
409	invalid_role	The Developer Portal account being used is not provisioned for the API being accessed. Please contact Flexiti Implementation Support.
409	general_error	A generic error covering back-end process issues
409	invalid_transaction_type	wrong value for transaction type in the request
409	wrong_verification_code	Verification code entered is incorrect
409	verification_code_required	Verification code is a required parameter.
409	user_not_active	Customer Account is not activated
409	user_not_able_to_purchase	Customer account status different to normal (NNOR)
409	limit_payment_amount_24	Payments made on the account exceed the $10,000/day limit
409	not_enough_credit	Customer does not have enough open to buy for transaction amount
409	not_verified	For in-store channel the request_id does not match the one passed in the /verify endpoint
409	external_location_id_not_found	The external location ID being passed is not registered with Flexiti
409	account_type_not_permitted	The merchant is not able to support this account type (open/closed loop scenarios)

POST /client-id/{client-id}/authorization

Code	Error	Scenario
404	not_found	Customer Account not found
404	customer_identity_not_found	the customer didn’t pass through the widget or was not authenticated properly
409	invalid_role	The Developer Portal account being used is not provisioned for the API being accessed. Please contact Flexiti Implementation Support.
409	credit_exceeded	Amount requested plus interest is greater than the available credit of the customer account.
409	general_error	A generic error covering back-end process issues
409	auth_not_allowed	Merchant has not been configured for preauthorization
409	plan_term_not_set	Merchant has not been configured for the financing option (Plan and Term or Regular Purchase).
409	plan_term_not_available	Plan and Term for prime category for a non-prime customer. Plan "DP - SAC Interest Accrues" for a QC customer. Plan "DP - SAC No Payments + No Interest Accrued" for a ROC customer.
409	user_not_able_to_purchase	Customer account status different than normal (NNOR)
409	not_verified	For in-store channel the request_id does not match the one passed in the /verify endpoint for online channel the widget_session_id does not match the one used on the /init endpoint
409	external_location_id_not_found	The external location ID being passed is not registered with Flexiti
409	account_type_not_permitted	The merchant is not able to support this account type (open/closed loop scenarios)

GET /client-id/{clientId}/authorizations

...

Code	Error	Scenario
403	Insufficient scope: authorized scope is insufficient	Scope of the token is not sufficient to access the endpoint
404	not_found	Authorization ID or Capture ID not found
409	invalid_role	The Developer Portal account being used is not provisioned for the API being accessed. Please contact Flexiti Implementation Support.
409	general_error	A generic error covering back-end process issues
409	capture_amount_exceeded	Return amount is greater than the remaining captured amount.
409	return_date_exceeded	Capture creation date is more than 100 days old.
409	wrong_transaction_type	The capture is not related to a promotional purchase
409	not_permitted	The employee doesn’t have enough permissions to perform the return
409	external_location_id_not_found	The external location ID being passed is not registered with Flexiti
409	account_type_not_permitted	The merchant is not able to support this account type (open/closed loop scenarios)

POST /client-id/{client_id}/accounts/{account_number}/refund

Code	Error	Scenario
403	Insufficient scope: authorized scope is insufficient	Scope of the token is not sufficient to access the endpoint
404	not_found	Customer Account not found
409	invalid_role	The Developer Portal account being used is not provisioned for the API being accessed. Please contact Flexiti Implementation Support.
409	general_error	A generic error covering back-end process issues
409	refunds_limit_exceeded_amount	Refund amount exceeds account balance limit.
409	external_location_id_not_found	The external location ID being passed is not registered with Flexiti
409	account_type_not_permitted	The merchant is not able to support this account type (open/closed loop scenarios)

GET /client-id/{clientId}/captures

Code	Error	Scenario
403	Insufficient scope: authorized scope is insufficient	Scope of the token is not sufficient to access the endpoint
409	invalid_role	The Developer Portal account being used is not provisioned for the API being accessed. Please contact Flexiti Implementation Support.
409	general_error	A generic error covering back-end process issues
409	date_from_bigger_than_date_to	The From date is later than the To date

GET /client-id/{clientId}/information

...

Code

...

Error

...

Scenario

...

409

...

general_error

...

A generic error covering back-end process issues

...

409

...

invalid_role

...

The Developer Portal account being used is not provisioned for the API being accessed. Please contact Flexiti Implementation Support.

Code	Error	Scenario
409	invalid_role	The Developer Portal account being used is not provisioned for the API being accessed. Please contact Flexiti Implementation Support.
409	general_error	A generic error covering back-end process issues

Versions Compared

Old Version 56

New Version 57

Key

Error Overview

Merchant Integration Endpoint Errors

POST /oauth/token

GET /client-id/{

clientId}/i18n

POST /client-id/{clientId}/widget/init

Credit Application Endpoint Errors

POST /client-id/{client_id}/apply

Customer Endpoint Errors

GET /client-id/{client_id}/customers/lookup

Transaction Endpoint Errors

POST /client-id/{client_id}/transactions

POST /client-id/{client-id}/authorization

GET /client-id/{clientId}/authorizations

POST /client-id/{client_id}/accounts/{account_number}/refund

GET /client-id/{clientId}/captures

GET /client-id/{clientId}/information

POST /client-id/{clientId}/widget/init

Page Comparison

Versions Compared

Old Version 56

New Version 57

Key

<span class="diff-html-removed" data-a11y-before="Start of deleted content" data-a11y-after="End of deleted content" id="removed-diff-0">[data-colorid=ekk9nntwfo]{color:#ff5630} html[data-color-mode=dark] [data-colorid=ekk9nntwfo]{color:#cf2600}</span>Error Overview

Merchant Integration Endpoint Errors

POST /oauth/token

GET /client-id/{

clientId}/i18n

POST /client-id/{clientId}/widget/init

Credit Application Endpoint Errors

POST /client-id/{client_id}/apply

Customer Endpoint Errors

GET /client-id/{client_id}/customers/lookup

Transaction Endpoint Errors

POST /client-id/{client_id}/transactions

POST /client-id/{client-id}/authorization

GET /client-id/{clientId}/authorizations

POST /client-id/{client_id}/accounts/{account_number}/refund

GET /client-id/{clientId}/captures

GET /client-id/{clientId}/information

POST /client-id/{clientId}/widget/init

Error Overview