Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

HTTP Status Codes

Type

Status

200

Success

Everything worked as expected.

401

Unauthorized

An error with the Merchant authentication.

403

Forbidden

Request is forbidden for the level of access granted.

404

Not Found

The requested resource doesn't exist.

409

Bad Request

The request was unacceptable, often due to missing a required parameter or wrong format.

500

Server Errors

Something went wrong on the Flexiti side. (These are rare.)

...

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

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

user_not_able_to_purchase

Customer account status different to normal (NNOR)

409

user_not_active

Customer Account is not activated

...

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

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

...

POST /client-id/{client_id}/account/{account_number}/verify

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

merchant_override_is_not_allowed

Merchant is not configured for Merchant Override

409

piw_mismatch

Personal Identification word entered does not match what is on file for the customer

409

secret_answer_mismatch

Security question answer does not match what is on file for the customer

...

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

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

...

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

generic_error

A generic error covering backend 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

...

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

409

generic_error

A generic error covering backend process issues

409

date_from_bigger_than_date_to

The From date is later than the To date

...

GET /client-id/{clientId}/authorization/{authorizationId}

Code

Error

Scenario

403

Insufficient scope: authorized scope is insufficient

Scope of the token is not sufficient to access the endpoint

400

not_found

Authorization ID not found

409

generic_error

A generic error covering backend process issues

...

POST /client-id/{clientId}/authorization/{authorizationId}/release

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 not found

409

generic_error

A generic error covering backend process issues

409

authorization_ended

Credit authorization has “closed” status

409

auth_amount_exceeded

Release amount is greater than the remaining credit authorization amount.

409

not_permitted

The employee doesn’t have enough permissions to perform the release

...

POST /client-id/{clientId}/authorization/{authorizationId}/capture

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 not found

409

generic_error

A generic error covering backend process issues

409

authorization_ended

Credit authorization has “closed” status

409

auth_amount_exceeded

Capture amount is greater than the remaining credit authorization amount.

409

not_permitted

  • The employee doesn’t have enough permissions to perform the capture, or;

  • Credit authorization has “unauthorized” status

...

POST /client-id/{clientId}/authorization/{authorizationId}/capture/{captureId}/return

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

generic_error

A generic error covering backend 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

...

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

generic_error

A generic error covering backend process issues

409

refunds_limit_exceeded_amount

Refund amount exceeds account balance limit.

...

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

generic_error

A generic error covering backend process issues

409

date_from_bigger_than_date_to

The From date is later than the To date

...