FlexPay HomeTrust CenterStatus
API Reference
Contact Support

Response Codes

An API call’s HTTP response code can indicate an error state or some other degradation of service. See the following response codes and corresponding response bodies for common causes.

API Response

CodeDescription
400Bad request. The request, as submitted, is not valid. The request should not be retried
401Unauthorized. No HTTP basic authentication was specified or API key is invalid
403Forbidden. A fraudulent request was detected.
404Not found. The requested item was not found. The request should not be retried.
505Internal Server Error. FlexPay experienced an error processing the request.

Transaction Response

FieldsCode RangeDescription
Approved10000The request was successful
Soft Decline20000The request declined, though subsequent attempts may be successful
Hard Decline30000The request declined. Most hard declines require the Issuer or Cardholder to rectify the outstanding issue(s) before a subsequent attempt can be made.
Risk Responses40000The request triggered a risk response. The status of the response (responseCode and status) will depend on the action specified in your risk settings on your gateway.
API Validation50000The request failed API validation and was not successful due to the error

Approved

CodeDescription
10000Approved
10001The reversal was processed successfully

Soft Decline

CodeDescription
20000You need to refer to the Card Issuer
20002Invalid or inactive merchant
20003Declined - do not honor
20012Re-enter transaction or transaction has been expired
20013Invalid response
20018Completed Partially
20022Bank decline
20023The card has been declined due to insufficient funds
20039Response timeout
20043Transaction cannot be completed
20046System error
20047Other / Unidentified responses
20048Unable to authorize
20050Over daily limit
20056Customer token/Id is incorrect or invalid
20057Your merchant account authentication failed
20068Invalid API access token
20073Batch data is missing or Invalid
20074Suspected fraud response code
20075Transaction limit for merchant exceeded
20076Transaction required data are missing or invalid
20077RETRY - Not a credit account
20078RETRY - Not a cheque account
20079RETRY - Not a savings account
20080RETRY - Expired card
20081RETRY - Limit exceeded. Enter a lesser value.
20082RETRY - Invalid transaction date
20083RETRY - Invalid expiry date format
20084RETRY - You submitted an unsupported card type with your request
20085RETRY - Gateway declined - Invalid transaction
20086RETRY - Billing address is missing
20087RETRY - Gateway declined - Blacklist transaction cannot be processed
20088RETRY - Gateway declined - Postal code failed The card’s postal code failed validation.
20089RETRY - Gateway declined - Missing required data. Please make sure all required data is sent, such as: CVV, Expiry date, Cardholder name, Billing address, Postalcode etc.
20090RETRY - Declined - AVS(Address) not matched the transaction payment method.
20091RETRY - Mismatch - Shipping to billing shipping country does not match billing country
20092RETRY - Mismatch - Shipping to BIN shipping country does not match bin country.
20093RETRY - Mismatch - Shipping to IP shipping country does not match IP country
20094RETRY - Mismatch - Billing to BIN billing country does not match bin country.
20095RETRY - Mismatch - Billing to IP billing country does not match IP country.
20096RETRY - Mismatch - BIN to IP BIN country does not match IP country.
20097RETRY - Gateway declined - Card number is blacklisted
20098RETRY - Gateway declined - IP address is blacklisted
20099RETRY - Gateway declined - Email is blacklisted
20100RETRY - Gateway declined - Phone number is Blacklisted
20101RETRY - The bank has requested that you retrieve the card from the cardholder - validate with the bank.
20102RETRY - Expired Card - Pick Up
20103RETRY – Invalid card number
20104RETRY – No gateways are configured to process the submitted card type
20105RETRY - Invalid value for "ReferenceData".
20106Invalid Account Number.
20107No credit account.
20108No checking account.
20109No savings account.
20110RETRY - The bank has requested that you retrieve the card from the cardholder - it may be a lost or stolen card.
20111RETRY - Invalid card: Luhn algorithm failed (MOD - 10).
20112RETRY - Suspected Fraud - Pick Up.
20113RETRY - Restricted Card - Pick Up.
20114RETRY - The bank has requested that you retrieve the card from the cardholder - it may be a lost card.
20115RETRY - The bank has requested that you retrieve the card from the cardholder - it may be a stolen card.
20116RETRY - The void request failed.
20117RETRY - Invalid transaction.
20118RETRY - The reversal request failed.
20119RETRY - The external gateway has reported that you have submitted an invalid amount with your request.
20120RETRY - Error / Invalid parameters in the request.
20121RETRY - Format Error.
20122RETRY - Not a savings account.
20123RETRY - Transaction not permitted to that cardholder.
20124RETRY - Suspected fraud.
20125RETRY - Restricted card.
20126RETRY - Duplicate transaction.
20127RETRY - Decline for CVV2 failure.
20128RETRY - Limit exceeded. Enter a lesser value.
20129RETRY - Invalid transaction date.
20130RETRY - You submitted an unsupported card type with your request.
20131RETRY - Gateway declined - Invalid transaction.
20132RETRY - The external gateway has reported that you have submitted an invalid currency with your request.
20133RETRY - Billing address is missing.
20134RETRY - Authorisation already reversed (voided) or capture is larger than initial authorised value.
20135RETRY - Authorization is completed.
20136RETRY - Transaction already reversed.
20137RETRY - Invalid API version.
20138RETRY - Invalid customer/user.
20139RETRY - This processor does not accept partial reversals.
20140RETRY - Original transaction for reversal not found.
20141RETRY - This transaction has already been captured.
20142RETRY - Invalid gateway payment method id
20143RETRY - Original transaction has not been captured, scheduled recovery has been cancelled.
20144RETRY - Risk Blocked Transaction refused due to risk model.
20145RETRY - Gateway declined - Blacklist transaction cannot be processed.
20146RETRY - Gateway declined - CVV is missing or incorrect. The merchant's configuration requires a CVV to be entered, but no CVV was provided with this transaction or CVV is incorrect.
20147RETRY - Gateway declined - Postal code failed The card’s postal code failed validation.
20148RETRY - Declined - AVS(Address) not matched the transaction payment method.
20149RETRY - Mismatch - Shipping to billing shipping country does not match billing country.
20150RETRY - Mismatch - Shipping to BIN shipping country does not match bin country.
20151RETRY - Mismatch - Shipping to IP shipping country does not match IP country.
20152RETRY - Mismatch - Billing to BIN billing country does not match bin country.
20153RETRY - Mismatch - Billing to IP billing country does not match IP country.
20154RETRY - Mismatch - BIN to IP BIN country does not match IP country.
20155RETRY - Gateway declined - Card number is blacklisted.
20156RETRY - Gateway declined - IP address is blacklisted.
20157RETRY - Gateway declined - Email is blacklisted.
20158RETRY - Gateway declined - Phone number is blacklisted.

Hard Decline

CODEDESCRIPTION
30000The bank has requested that you retrieve the card from the cardholder - validate with the bank.
30001The bank has requested that you retrieve the card from the cardholder - it may be a lost or stolen card.
30002Invalid card: Luhn algorithm failed (MOD - 10)
30003Expired Card - Pick Up
30004Suspected Fraud - Pick Up
30006Restricted Card - Pick Up
30008The bank has requested that you retrieve the card from the cardholder - it may be a lost card.
30009The bank has requested that you retrieve the card from the cardholder - it may be a stolen card.
30010The void request failed
30011Invalid transaction
30012Invalid card number
30013The reversal request failed
30015The external gateway has reported that you have submitted an invalid amount with your request
30016Error / Invalid parameters in the request
30017Format Error
30019Not a credit account
30024Not a cheque account
30025Not a savings account
30026Expired card
30029Transaction not permitted to that cardholder
30031Suspected fraud
30034Restricted card
30044Duplicate transaction
30049Decline for CVV2 failure
30051Limit exceeded. Enter a lesser value
30052Invalid transaction date
30053Card not supported
30055Invalid expiry date format
30058You submitted an unsupported card type with your request.
30059Gateway declined - Invalid transaction
30061The external gateway has reported that you have submitted an invalid currency with your request
30062Billing address is missing
30064Authorisation already reversed (voided) or capture is larger than initial authorised value
30065Authorization is completed
30066Transaction already reversed
30071Invalid API version
30074Invalid customer/user
30077This processor does not accept partial reversals
30078Original transaction for reversal not found
30079This transaction has already been captured
30080DO NOT RETRY - You need to refer to the Card Issuer
30081DO NOT RETRY - Invalid or inactive merchant
30082DO NOT RETRY - Do not honour
30083DO NOT RETRY - Re-enter transaction or transaction has been expired
30084DO NOT RETRY - Invalid response
30085DO NOT RETRY - Completed partially
30086DO NOT RETRY - Bank decline
30087DO NOT RETRY - The card has been declined due to insufficient funds
30088DO NOT RETRY - Response timeout
30089DO NOT RETRY - Transaction cannot be completed
30090DO NOT RETRY - System error
30091DO NOT RETRY - Other / Unidentified responses
30092DO NOT RETRY - Over daily limit
30093DO NOT RETRY - Customer token/Id is incorrect or invalid
30094DO NOT RETRY - Customer token/Id is incorrect or invalid
30095DO NOT RETRY - Your merchant account authentication failed
30096DO NOT RETRY - Invalid API access token
30097DO NOT RETRY - Batch data is missing or Invalid
30098DO NOT RETRY - Transaction limit for merchant exceeded
30099DO NOT RETRY - Transaction required data are missing or invalid
30100DO NOT RETRY - Retry limit reached
30101Invalid gateway payment method Id
30102DO NOT RETRY - Suspected fraud response code
30103Original transaction has not been captured, scheduled recovery has been cancelled. Used in enterprise with scheduler to notify FP to stop recovery.
30104DO NOT RETRY - Invalid Account Number.
30105DO NOT RETRY - No credit account.
30106DO NOT RETRY - No checking account.
30107DO NOT RETRY - No savings account.

Risk Responses

CODEDESCRIPTION
40000Risk Blocked Transaction refused due to risk model
40002Gateway declined - Blacklist transaction cannot be processed
40003Gateway declined - CVV is missing or incorrect. The merchant’s configuration requires a CVV to be entered, but no CVV was provided with this transaction or CVV is incorrect
40004Gateway declined - Postal code failed The card’s postal code failed validation
40005Gateway declined - Missing required data. Please make sure all required data is sent, such as: CVV, Expiry date, Cardholder name, Billing address, Postalcode etc
40006Declined – AVS (Address) not matched the transaction payment method
40007Mismatch - Shipping to billing shipping country does not match billing country
40008Mismatch - Shipping to BIN shipping country does not match bin country
40009Mismatch - Shipping to IP shipping country does not match IP country
40010Mismatch - Billing to BIN billing country does not match bin country
40011Mismatch - Billing to IP billing country does not match IP country
40012Mismatch - BIN to IP BIN country does not match IP country
40030Gateway declined - Card number is blacklisted
40031Gateway declined - IP address is blacklisted
40032Gateway declined - Email is blacklisted
40033Gateway declined - Phone number is Blacklisted

API Validation

CODEDESCRIPTION
50000Validation error
50002An error was experienced while parsing the payload. Please ensure that the structure is correct.
50003No parameters were found
50005Authorization has been denied for this request
50014Invalid 'CustomerToken' length
50015Invalid 'Email' length
50020Invalid 'PhoneNumber' length
50028Invalid 'FullName' length
50029Invalid 'ProvinceStateCode' length
50037Invalid 'CustomerIp' length
50039Invalid value for 'CountryCode'
50045Field 'CurrencyCode' is required
50048Field 'CustomerToken' or 'email' are required
50055Field 'Month' is required
50056Invalid value for 'Month'
50057Field 'Year' is required
50058Invalid value for 'Year'
50059Field 'CreditCardNumber' is required
50060Invalid 'CreditCardNumber' Length
50068Invalid 'MerchantDescriptor' length
50073Invalid 'CurrencyCode' length
50088Field 'FirstName' is required
50089Field 'LastName' is required
50090Fields 'FullName' or 'FirstName' and 'LastName' are required
50091Invalid 'FirstName' length
50092Invalid 'LastName' length
50093Field 'CountryCode' is required
50094Field 'PostalCode' is required
50095Invalid 'PostalCode' length
50096Field 'ProvinceStateCode' is required
50097Field 'City' is required
50098Invalid 'City' length
50099Field 'Address1' is required
50100Invalid 'Address1' length
50103Field 'MerchantTransactionReferenceId' is required
50104Invalid 'MerchantTransactionReferenceId' length
50105Invalid 'TransactionType'
50106Invalid 'CustomField1' length
50107Invalid 'CustomField2' length
50108Invalid 'CustomField3' length
50109Invalid 'CustomField4' length
50110Invalid 'CustomField5' length
50111Invalid 'ReferenceData' length
50112Invalid 'ShippingPhoneNumber' length
50113Invalid 'ShippingCountryCode' length
50114Invalid 'ShippingPostalCode' length
50115Invalid 'ShippingProvinceStateCode' length
50116Invalid 'ShippingCity' length
50117Invalid 'ShippingAddress2' length
50118Invalid 'ShippingAddress1' length
50119Invalid 'Address2' length
50120Invalid 'BillingPlanCode' length
50121Invalid 'ProductCategoryName' length
50122Invalid 'ProductSku' length
50123Invalid 'MerchantLocation' length
50124Invalid 'Description' length
50125invalid 'GatewayTransactionToken' length
50126Field 'OrderId' is required
50127Invalid 'OrderId' length
50128Invalid 'GatewayToken' length
50129Field 'MerchantTransactionReferenceId' must be unique
50130No gateways are configured to process the submitted card type
50131Original transaction not found using the field ‘TransactionReferenceId’.
50132Invalid value for 'ReferenceData'
50133Field 'PaymentToken' is required
50134Invalid value for 'PaymentToken'
50135Fields 'PaymentToken' or 'PaymentMethod' values are required
50136Invalid PaymentMethod values
50137Invalid value for ''Amount'' while processing a charge or an authorize
50138Invalid value for ''gatewayPaymentMethodId''.
50139Invalid ''gatewayPaymentMethodId'' length
50140Invalid value for ''merchantAccountReferenceId''.
50141Invalid ''merchantAccountReferenceId'' length.
50142Invalid ''vendorId'' length.
50143Invalid value for gateway ''referenceId''.
50144Invalid length for gateway ''referenceId''.
50145Invalid value for ''gatewayType''.
50146Inconsistent values for ''referenceId'' between previous transaction and gateway.
50147Invalid value for one of the currencies in the list of accepted currencies on the gateway.
50148Invalid currency code on the merchant account.
50149Invalid ''GatewayPaymentMethodId'' for selected gateway.
50150Invalid ''GatewayTransactionId'' for selected gateway.
50151Invalid ''GatewayTransactionId'' length.
50152''GatewayTransactionId'' can only be used for an Authorize or Charge transaction.
50153Invalid ''Last4Digits'' length.
50154Invalid ''First6Digits'' length.
50155Invalid ''PaymentModel''.
50156Current transaction cannot be processed when the account is in a Decline Salvage Disabled state.
50157Current transaction with 3DS values cannot be processed when the gateway doesn't support 3DS.
50158Current transaction with 3DS values cannot be processed when the three_ds_version is empty or doesn't start with '2'.
50159Current transaction with valid 3DS version and null or empty threeDS cannot be processed.
50160Field 'CustomerReferenceId' is required if fields 'FullName' or 'FirstName' and 'LastName' are empty
50161Field 'CustomerReferenceId' or 'email' or 'subscriptionId' are required.
50163Original payment not found using the field 'MerchantTransactionReferenceId'.
50164Cannot refund this payment already refunded.
50165'MerchantTransactionReferenceId' and 'CustomerReferenceId' Required.
50166Invalid format or length for 'IssuerIdentificationNumber'.