ZenPayments
  1. Merchants
ZenPayments
  • General Information
    • Authentication
    • Errors
    • Responses
    • Filters
      • Example - gte
      • Example - between
      • Example - like
      • Example - in
      • Example - non-empty
    • Pagination
      • 10 results per page
    • Data Types
  • Merchants
    • Sandbox
      • Sandbox Payment Gateway
    • Card Payments
      • Authorization
      • Sale
      • Capture
      • Partial Capture
      • Refund
      • Partial Refund
      • Soft/Dynamic Descriptor
      • Card Authentication
      • Card Tokenization
      • Card Tokenization with Global Token
      • Sale with a Fee Terminal
    • Hosted Form
      • Generate
      • Generate with Billing and Contact Information
    • Hosted Fields
      • How it Works
      • Hosted Fields Token
        • Hosted Fields Token
      • Integration Guide
        • Step 1: Include the JavaScript Library
        • Step 2: Add HTML Elements for all payment fields
        • Step 3: Set the AccessToken and Configure the rest of the form
        • Step 4: Add styling
        • Step 5: Listen for Events
        • Step 6: Get the tokenized card
          • Get the tokenized card
        • Add Payment Method Page
        • Testing your integration
    • CustomerVault
      • Sandbox
        • Sandbox Dashboard
      • Hosted Card Form
        • Generate
      • Customers
        • List
        • View
        • Create
        • Update
        • Archive
        • Delete
      • Cards
        • List Cards
        • View
        • Add Card
        • Update Exp Date
        • Archive
        • Unarchive
        • Delete
      • Billing Information
        • List
        • View
        • Update
        • Create
      • Shipping Information
        • List
        • View
        • Update
        • Create
      • Recurring Payment
        • List
        • View
        • Update
        • Create
    • Transaction Reporting
      • List
      • View
    • Response Codes
      • Verification Response Codes
    • 3DSecure
      • Version
      • Create
        • Create
      • Check
        • Check
      • Test Cards
    • Account Updater
      • Card Compatibility
      • How It Works
        • Sale with Account Updater
    • ACH Payments
      • General Information
      • Transactions
        • SEC Codes
        • Statuses
        • Actions
          • Action
        • History Log
          • Log
        • List
        • View
        • Create ACH
        • Create ACH & Save Customer
        • Create ACH for an existing Customer
        • Create ACH for an existing Customer and specific Account
        • Remove
      • Hosted Form
        • Example Request
      • Customers
        • List Customers
        • View specific Customer
        • Create Customer
        • Update Customer
        • Delete a Customer
      • Customer Accounts
        • List Customer Accounts
        • Create Customer Account
        • Update Customer Account
        • Delete a Customer Account
      • Bank Information
        • View
      • ACH Settlements
        • List
        • View
      • ACH Webhooks
        • New ACH Record
        • ACH Status Update
        • New ACH Customer
    • Reporting
      • Sandbox
        • Sandbox Dashboard
      • Authorizations
        • List
        • List with Filters
      • Batches
        • List
        • List with Filters
        • Summary
      • Payouts
        • List
        • View
        • Export
      • Chargebacks
        • Disputes
          • Upload a temporary file
          • Create a Dispute
          • Preview
          • Submit
        • Webhooks
          • Signatures
          • Events
            • Chargeback
              • New Chargeback Record
              • Chargeback Update
        • View
          • List
          • View
      • Statements
        • List
        • Download
      • Reserve
        • List
      • Fraud Report
        • Generate
      • Visa Verifi
        • Submiting External Transactions
          • Submit
        • List
      • Other Reports
        • Request a Report
        • Check Status
        • Download
    • Gateway Test Cards
  • Platforms
    • Sandbox
      • Sandbox Dashboard
    • Onboarding
      • Boarding Applications
        • Campaigns
          • List
        • Equipment
          • Terminals
            • List
            • View
          • View
          • Update
        • List
          • List Boarding Applications
        • Create
          • Create Boarding Application
        • Delete
          • Delete Boarding Application
        • View
          • View Boarding Application
        • Update
          • Update Boarding Application
        • Principals
          • List Principals
          • Create Principal
          • Update a Single Principal
          • Mass update Principals
          • Delete Principal
        • Processing
          • View Processing section
          • Update Processing section
        • Merchant Category Codes (MCCs)
          • List MCCs
        • ACH
          • View ACH section
          • Update ACH section
        • Documents
          • Attachment About
            • List All Document Categories
          • View all documents
          • MPA
          • Assign a single document
          • Assign multiple documents
          • Update a single document
          • Delete a single document
        • Fees
          • Types
            • List
          • Other Fees
            • Add
            • Update
            • Delete
          • List all fees
          • View a specific fee
          • Update a single fee
          • Update multiple fees
        • Bank Accounts
          • Add
          • Update
          • Change
        • Validate
          • Validate a Boarding Application
        • URL
          • GET URL of Boarding Application
        • Signature
          • Request E-sign
            • Request Signature
          • Embed E-sign
            • Embeded E-sign Example Flow 1
            • Embeded E-sign Example Flow 2
            • Request Embed
          • Manually Signing
            • Manual Sign
          • External eSign Signing
            • External eSign
        • Automation
          • AutoSign
            • Set AutoSign
          • AutoUnderwriting
            • Set AutoUnderwriting
        • Status
          • Set status to Underwriting
        • Notes
          • List
          • Create
      • Merchants
        • Terminals
          • List Terminals
          • View a specific Terminal
          • VAR Sheet
          • VAR View
        • List Merchants
      • DBA
        • List
        • View
      • Attachments
        • Temporary Upload
          • Temporary Upload
        • Chunk Upload
          • Initialize
          • Upload Request 1/2
          • Upload Request 2/2
        • Standard Upload
        • List attachments
        • View
        • View in browser
        • Download
        • Delete
      • Webhooks
        • Signatures
        • Events
          • Boarding Application
          • Merchant
            • Account
              • New Acquiring Account
              • New ACH Account
              • Closed Acquiring Account
              • Closed ACH Account
            • Terminal
              • New Terminal Record
              • Update Terminal Record
              • Delete Terminal Record
    • Reporting
      • Authorizations
        • List
        • List with Filters
      • Batches
        • List
        • List with Filters
        • Summary
      • Payouts
        • List
        • View
        • Export
      • Chargebacks
        • View
          • List
          • View
        • Disputes
          • Upload a temporary file
          • Create a Dispute
          • Preview
          • Submit
        • Webhooks
          • Signatures
          • Events
            • Chargeback
              • New Chargeback Record
              • Chargeback Update
      • Statements
        • List
        • Download
      • Reserve
        • List
      • Fraud Report
        • Generate
      • Other Reports
        • Request a Report
        • Check Status
        • Download
    • Residuals
      • List
      • View
    • Tickets
      • Update Ticket Status
        • Close
        • Re-Open
      • Responses
        • List
        • Create
        • Add an Attachment
      • Attachments
        • List
        • View
        • Create
        • Delete
      • Categories
        • List
      • Notes
        • List
        • View
        • Create
        • Update
        • Delete
        • Attachments
      • List
      • Create
      • View a specific ticket
    • Connect
      • Webhooks
        • Access Granted
        • Access Updated
        • Access Revoked
    • Misc
      • Address Checker
        • List Countries
        • List States
        • List Cities and Zip Codes
        • Filter by City and State
      • BIN Check
        • Get BIN Information
  1. Merchants

Response Codes

Responses to any request clearly indicate if the request is processed successfully. We have integrated the following logic and groups in our response codes.
Status Object
FieldsDescriptionTypeFilterableRequiredReadonlyLevel 1Level 2Level 3
statusStatus ObjectObjectNoNoYes
status.statusApproved,Declined, ErrorStringYesNoYesNoNoNo
status.reasonStatus reasonStringNoNoYesNoNoNo

Approval Response#

This is the only response that we will return only a status for it. Do not expect a status.reason here
Example:
"status": {
        "status": "Approved",
        "reason": null
    }

Decline Response#

The decline response will include a status.reason giving you more details on the type of decline.
Example:
"status": {
        "status": "Declined",
        "reason": Insufficient Funds
    }
Here is a list of all possible decline codes:
Status Reason MessageDetails
Duplicate Request (Approved previously)The transaction was already performed and approved. Verify if the request was submitted twice for the same transaction ID or external reference number.
Reversal Not AllowedThe transaction is not authorized for reversal. This error may occur because the transaction was settled, declined, or already reversed.
Return Not AllowedThe transaction is not authorized for return. This error may occur because the transaction was not settled, was declined, or was already reversed.
Supervisor Override Required
Modify Transaction Not AllowedThe transaction is not authorized for modification. This error may occur because the transaction was already settled, or was declined.
Possible Duplicate RequestThis is a duplicate request. The credentials for this transaction (i.e. amount, card number, or same service) are the same as another transaction submitted less than one minute apart.
Duplicate Request (Reversed previously)The request with the same credentials (amount, card number, or same service) hit the server twice within a minute.
Inactive Device (Terminal)The device is not registered, or is inactive in the system.
Device (Terminal) Configuration missingThe configuration parameter is missing.
Insufficient privileges
Incremental Auth Not Allowed
Unable to process your request. Settlement InProgress.The transaction settlement is in progress.
Functionality currently not available.The functionality is not supported by .
Inactive Merchant (Account)The merchant is not registered, or is inactive in the system.
Merchant (Account) configuration missingThe configuration parameter is missing.
Processor configuration missingThe processor parameter is missing.
Unique ID ErrorThe terminal unique ID is invalid, or is not registered in the system.
Service Not Allowed
Inactive terminal (Backend)The device is inactive or is not registered at the host.
Inactive account (Backend)The account is inactive, or is not registered at the host.
Unique ID Error (Backend)The terminal unique ID is invalid, or is not registered at the host.
Duplicate Request (Backend)This is a duplicate transaction. This transaction was already approved and processed.
Reversal Not Allowed (Backend)The transaction is not authorized for reversal. This error may occur because the transaction was settled, declined, or already reversed.
Return Not Allowed (Backend)The transaction is not authorized for return. This error may occur because the transaction was settled, declined, or already reversed.
Re-enter transaction
Encryption failure from host
Return not allowed, Card number requested does not match with original transaction card number
Invalid taskID
Currency code mismatch with original transaction
Multiple amount format in single request not supported
Time out
System Error
Error on Host
System error (DB Insert)
Invalid store IDInvalid store ID.
Invalid amountAmount provided in request is invalid.
Coupon service is temporarily unavailable.Coupon service is temporarily unavailable.
Host Auth initialization declined
Card not accepted by host
Host Auth finalization declined
Host connectivity failed
Host Reversal declined
Host Return initialization declined
Host Return finalization declined
Payment_Facilitator_ID is mandatory for VISA, Mastercard Payment facilitator transactionsThe transaction does not contain Payment_Facilitator_ID information, which is mandatory for Payment Facilitator Visa and Mastercard transactions.
General Bill Pay DeclineGeneral declined please contact help desk.
Refer to IssuerThe merchant must call the issuer to obtain verbal authorization.
Suspected Card (pick-up, hot-card)This credit card has been flagged for fraud. the merchant should call the number on the back of the card to obtain further instructions.

Suspected card error occurs in the following scenarios:

- The card is restricted by the issuer
- Loss of card is reported

Theft of card is reported
Honor with identification?The card is not identified.
Invalid AmountThe amount exceeds the limits established by the issuer for this type of transaction.
Invalid CardThe issuer indicates that this card is invalid.
No such issuerThe card issuer number is invalid.
Invalid feeThe transaction fee is unacceptable.
Incorrect PinThe PIN entered by the cardholder is incorrect.
Pin attempts exceededThe number of attempts to enter the PIN has exceeded.
Key synchronization failed from the hostThe failure of a key synchronization from the host.
Expired CardThe card has expired.
Insufficient FundsThe credit limit for this account has been exceeded, or the amount is not enough to perform the transaction.
Invalid From AccountThe transaction account is invalid.
Invalid To AccountThe transaction account is invalid.
Withdrawal Limit exceededThe withdrawal limit on an account is exceeded.
Withdrawal frequency exceededThe withdrawal frequency on an account is exceeded.
Time limit for Pre-Auth reachedThe time for Pre-Auth has reached its limit.
AVS FAILEDThe address verification has failed and the merchant is configured for auto decline on AVS failure.
Billing ZIP MismatchThe zip provided does not match the billing address on file and the merchant is configured for auto decline on ZIP code mismatch.
CVV2 verification failedThe V code provided is invalid or does not match what is on file and the merchant set up for auto decline on CVV2 failure.
Issuer or Switch inoperativeThe bank is unavailable to authorize this transaction.
Duplicate transaction ( Same amount / Account)The transaction with the same amount and account is performed twice.
Balance unavailable for inquiryThe balance cannot be validated.
Check Digit ErrThe credit card number entered did not pass validation. Correct and re-enter the credit card number.
Excluded Bin ID for MerchantCard is not allowed to do transactions at this merchant.
Do not honorThe transaction was declined by the issuer.
AVS and CVV2 failedThe address verification and V code verification failed and the merchant set up for auto decline on AVS and CVV2 failure.
Invalid DateThe credit card expiration date is invalid. Verify and re-enter the expiration date.
Invalid ServiceThe service provided by the card is invalid.
Host Validation ErrorThe host is an invalid host.
Activity Limit exceededThe daily card activity limit has been exceeded.
Cannot complete because of ViolationThe transaction cannot be completed because the credit card account has been flagged with a violation.
Debit Pin RequiredThe BIN is blocked by the issuer.
Check Service authentication failure
Could Not Retrieve a Valid Card Number for Token
Card information is not provided
No Card found for the BIN
Card verification failed for card numberVerification of the card number has failed.
PreFraudScout DeclineTransaction is declined in Pre Fraud rules.
General Card Auth DeclineThis is a general decline error.
Blocked AccountThe account provided in transaction is blocked.
Blocked CheckThe check provided in transaction is blocked.
Invalid Token
Service Not Allowed

Error Response#

These are rare and are usually returned due to incorrect request formatting or general system errors.
Status Reason MessageDetails
Format Error field detailsCheck the formatting of your request parameters
Customer requested stop of all recurring payments from specific merchant
Transaction is in process. Please try again after some time.Simultaneous actions cannot be performed on the same customer record. The application is unable to perform edits on a customer record while the record is in use.
An error has occurred. Your request couldn't be processed because of a technical issue. Please try again later. We apologize for the inconvenience. Our technical team has been notifiedThis is a system general error and you can contact us if you are experiencing these errors for more information.
Modified at 2025-08-09 05:39:42
Previous
View
Next
Verification Response Codes
Built with