Status reasons

📘
The status reason object is only available for Point-of-Sale payments at this time.

The Payment API provides an optional statusReason object that offers details about the status of a payment. This object includes the following properties:

code: a machine-readable code that indicates the reason for the payment's status.
message: a description of the status reason, localized according to the locale provided with the request.

All possible status reasons are listed below, grouped by payment method.

Point-of-Sale

Failures for Point-of-Sale payments can have varied reasons, with most failure reasons originating from card schemes or our own restrictions. Below the most common status reasons are described.

Card scheme responses

Code	Description
`approved_or_completed_successfully`	The transaction was approved.
`refer_to_card_issuer`	The transaction was cancelled after being initially approved by the issuer. This can be due to various reasons, for example, if the shopper returns goods after purchase.
`invalid_merchant`	The transaction was refused by the card issuer. The shopper should contact their bank for clarification. The shopper can try again after resolving the issue with their bank, or use another payment method.
`capture_card`	The card issuer requests to retain the card. This can be due to a suspected counterfeit or stolen card. This reason is used in an E-Commerce environment although it originates from an in-person payments environment.
`do_not_honor`	This is a generic refusal that has several possible causes. The shopper should contact their issuing bank for clarification.
`error`	Payment could not be authorised and resulted in an error. The shopper can try again or use another payment method.
`partial_approval`	A partial approval was made but the transaction was not finalised. The shopper should retry the transaction.
`invalid_transaction`	The transaction type is not supported by the card issuer. The shopper should contact their bank for clarification or try another payment method.
`invalid_amount`	The transaction amount is incorrect. The shopper should try again with the correct amount.
`invalid_issuer`	The card issuer is not valid. The shopper should try another card or payment method.
`lost_card`	The card has been reported as lost. The shopper should contact their bank for a replacement card.
`stolen_card`	The card has been reported as stolen. The shopper should contact their bank for a replacement card.
`insufficient_funds`	The account associated with the card has insufficient funds. The shopper should use another payment method or contact their bank.
`expired_card`	The card has expired. The shopper should use another card or contact their bank for a replacement.
`invalid_pin`	The PIN entered is incorrect. The shopper should try again with the correct PIN.
`transaction_not_permitted_to_cardholder`	The transaction is not permitted for the cardholder. The shopper should contact their bank for more information.
`transaction_not_allowed_at_terminal`	The transaction is not permitted at the acquirer terminal. The shopper should try another payment method.
`exceeds_withdrawal_amount_limit`	The transaction exceeds the withdrawal amount limit. The shopper should try again with a lower amount or contact their bank.
`restricted_card`	The card is restricted. The shopper should contact their bank for more information.
`security_violation`	There is a security violation. The shopper should contact their bank for more information.
`exceeds_withdrawal_count_limit`	The transaction exceeds the withdrawal count limit. The shopper should try again later or contact their bank.
`allowable_number_of_pin_tries_exceeded`	The allowable number of PIN tries has been exceeded. The shopper should contact their bank.
`no_reason_to_decline`	There is no specific reason to decline the request. The shopper should contact their bank for more information.
`cannot_verify_pin`	The PIN cannot be verified. The shopper should try again with the correct PIN.
`issuer_unavailable`	The issuer is not available. The shopper should try again later.
`unable_to_route_transaction`	The transaction cannot be routed. The shopper should try another payment method.
`duplicate_transaction`	Duplicate transaction detected.
`system_malfunction`	There is a system malfunction. The shopper should try again later.
`honor_with_id`	Honor with ID.
`invalid_card_number`	The card number is incorrect. The shopper should verify and try again with the correct card number.
`format_error`	There was a format error in the transaction. The shopper should try again or contact their bank.
`contact_card_issuer`	The card issuer needs to be contacted. The shopper should contact their bank for more information.
`pin_not_changed`	PIN not changed.
`invalid_nonexistent_to_account_specified`	Invalid/nonexistent 'To Account' specified.
`invalid_nonexistent_from_account_specified`	Invalid/nonexistent 'From Account' specified.
`invalid_nonexistent_account_specified`	An invalid or nonexistent account was specified. The shopper should verify the account information and try again.
`lifecycle_related`	The transaction was declined due to life cycle issues. The shopper should contact their bank for more information.
`domestic_debit_transaction_not_allowed`	Domestic debit transaction not allowed.
`policy_related`	The transaction was declined due to policy reasons. The shopper should contact their bank for more information.
`fraud_security_related`	The transaction was declined due to fraud or security concerns. The shopper should contact their bank for more information.
`invalid_authorization_life_cycle`	Invalid authorization life cycle.
`purchase_amount_only_no_cash_back_allowed`	Purchase amount only, no cash back allowed.
`cryptographic_failure`	There is a cryptographic failure.
`unacceptable_pin`	Unacceptable PIN.
`refer_to_card_issuer_special_condition`	Refer to card issuer, special condition.
`pick_up_card_special_condition`	The card issuer requests to retain the card. This can be due to a suspected counterfeit or stolen card.
`vip_approval`	V.I.P Approval.
`invalid_account_number`	The account number is incorrect.
`re_enter_transaction`	The transaction should be re-entered. The shopper should try the transaction again.
`no_action_taken`	No action taken (unable to back out prior transaction).
`unable_to_locate_record`	Unable to locate record in file, or account number is missing from the inquiry.
`file_temporarily_unavailable`	File is temporarily unavailable.
`no_credit_account`	No credit account.
`closed_account`	The account associated with the card is closed. The shopper should contact their bank.
`no_checking_account`	No checking account.
`no_savings_account`	No savings account.
`suspected_fraud`	The transaction is suspected of fraud. The shopper should contact their bank for more information.
`transaction_does_not_fulfill_aml_requirement`	Transaction does not fulfill AML requirement.
`pin_data_required`	PIN data is required. The shopper should enter the PIN and try again.
`unable_to_locate_previous_message`	Unable to locate previous message (no match on transaction ID).
`previous_message_located_inconsistent_data`	Previous message located, but the reversal data are inconsistent with original message.
`blocked_first_used`	Transaction from new cardholder, and card not properly unblocked.
`transaction_reversed`	Transaction reversed.
`credit_issuer_unavailable`	The credit issuer is unavailable. The shopper should try again later.
`pin_cryptographic_error_found`	PIN cryptographic error found (error found by VIC security module during PIN decryption).
`negative_online_cam_result`	The transaction was declined due to negative online CAM results. The shopper should contact their bank for more information.
`violation_of_law`	The transaction cannot be completed due to a violation of law. The shopper should contact their bank for more information.
`force_stip`	Force STIP.
`cash_service_not_available`	The cash service is not available. The shopper should try again later or use another payment method.
`cashback_request_exceeds_issuer_limit`	The cashback request exceeds the issuer limit. The shopper should try again with a lower amount or contact their bank.
`decline_for_cvv2_failure`	The transaction was declined due to CVV2 failure. The shopper should try again with the correct CVV2.
`transaction_amount_exceeds_pre_authorized_amount`	Transaction amount exceeds pre-authorized approval amount.
`invalid_biller_information`	Invalid biller information.
`pin_change_unblock_request_declined`	PIN change/unblock request declined.
`unsafe_pin`	Unsafe PIN.
`card_authentication_failed`	Card authentication failed. Or offline PIN authentication interrupted.
`stop_payment_order`	There is a stop payment order. The shopper should contact their bank for more information.
`revocation_of_authorization`	Revocation of authorisation order.
`revocation_of_all_authorizations`	Revocation of all authorisation orders.
`forward_to_issuer_xa`	Forward to issuer.
`forward_to_issuer_xd`	Forward to issuer.
`unable_to_go_online`	The transaction was declined offline. The shopper should try again or use another payment method.
`additional_customer_authentication_required`	Additional customer authentication required.

Merchant related responses

Code	Description
`merchant_id_not_found`	Merchant ID not found.
`merchant_account_closed`	Merchant account closed.
`terminal_id_not_found`	Terminal ID not found.
`terminal_closed`	Terminal closed.
`invalid_category_code`	Invalid category code.
`invalid_currency`	Invalid currency.
`missing_cvv2_cvc2`	Missing CVV2/CVC2.
`cvv2_not_allowed`	CVV2 not allowed.
`merchant_not_registered_vbv`	Merchant not registered for Verified by Visa/Secure Code.
`merchant_not_registered_for_amex`	Merchant not registered for Amex.
`transaction_not_permitted_at_terminal`	Transaction not permitted at terminal.
`agreement_terminal_not_related`	Agreement and terminal are not related.
`invalid_processor_id`	Invalid processor ID.
`invalid_merchant_data`	Invalid merchant data (Name, City or Postal Code).
`sub_merchant_account_closed`	Sub-merchant account closed.