doDeal

Overview

The doDeal endpoint is the core gateway for payment operations in the Hyp API. It provides a unified interface for processing various transaction types, with specific behavior controlled by the validation parameter.

Use cases

Direct Charge: Process immediate payment from a credit card via server-to-server integration (see Basic Integration Flow)
Pre-Authorization: Reserve funds without charging immediately - ideal for hotels, car rentals, e-commerce inventory verification (see Two-Phase Commits)
Capture Authorization: Finalize and collect funds that were previously reserved via pre-authorization (see Two-Phase Commits)
Tokenization: Store card details securely for future use without processing a transaction (see Tokenization Process)
Payment Page Initialization: Redirect customers to a hosted payment page for PCI-compliant processing (see Integrating Hyp's Payment Page)
Credit Payouts: Send funds to a customer or third party - refunds, marketplace payouts (see Payouts)
Hold Operations: Temporarily delay transaction execution for manual review, fraud checks, or business approval
Release Operations: Release transactions from hold status to proceed with processing

Request structure

For a comprehensive overview of the API request format and authentication, see API Request & Response General Structure.

Endpoint

POST https://your-hyp-environment-url/xpo/Relay

Note: The endpoint server may vary by environment (production, sandbox, etc.). Please verify the correct endpoint URL with Hyp support.

Request parameters

The API uses HTTP POST with application/x-www-form-urlencoded content type. These parameters are sent as form data:

Parameter

Required

Type

Description

user

Yes

String

API username provided by Hyp

password

Yes

String

API password provided by Hyp

int_in

Yes

String

URL-encoded XML payload containing the actual API command and parameters

The int_in parameter contains the complete XML request shown in the next section, but it must be URL-encoded before sending. All code examples include proper URL encoding.

XML payload structure

The following XML structure is what gets URL-encoded and sent in the int_in parameter:

<ashrait>
  <request>
    <version>2000</version>
    <language>ENG</language>
    <requestId/>
    <command>doDeal</command>
    <doDeal>
        <terminalNumber>0123456</terminalNumber>
        <cardNo>4111111111111111</cardNo>
        <cardExpiration>1225</cardExpiration>
        <transactionType>debit</transactionType>
        <currency>ILS</currency>
        <total>1000</total>
        <validation>autoComm</validation>
        <creditType>RegularCredit</creditType>
        <transactionCode>Phone</transactionCode>
        <!-- Additional parameters based on use case -->
    </doDeal>
  </request>
</ashrait>

Command parameters

Required parameters

terminalNumber (String, Required)

Terminal ID assigned by Hyp. This is your merchant-specific identifier that determines which configuration and rules apply to the transaction.

Valid Values: Merchant-specific identifier Example: 0123456

transactionType (String, Required)

Determines the direction of funds flow. Use debit to charge a customer, credit to send funds to a customer.

Valid Values: debit, credit Example: debit

currency (String, Required)

ISO 4217 currency code (according to supported currencies by the credit company).

Valid Values: ILS (New Israeli Shekel), USD (United States Dollar), GBP (Great Britain Pound), HKD (Hong Kong Dollar), JPY (Japanese Yen), EUR (European currency unit) Example: ILS

total (Integer, Required)

Transaction amount in the smallest currency unit (cents/agorot). For example, 1000 = 10.00 ILS.

Valid Values: Positive integer, or 0 for tokenization only Example: 1000 (equals 10.00)

validation (String, Required)

Operation type that determines the transaction behavior. This is the key parameter that controls what action doDeal performs.

Valid Values: autoComm, verify, captureAuth, token, txnSetup, SetAsHold, autoCommRelease Example: autoComm Note: See validation types reference table below for detailed use cases

creditType (String, Required)

The following credit types are supported:

Valid Values:

RegularCredit - A single debit payment
IsraCredit - "Isracredit", "AMEX credit", "Visa Adif/30+", "Diners Adif/30+" (local Israeli payment method)
AdHock - Ad hock debit- "Hiyuv Miyadi" (local Israeli payment method)
SpecialCredit - Special credit - "credit"/"fixed payments credit" (local Israeli payment method). Tag numberOfPayments is mandatory
Payments - Multiple payments debit (installments). Tags numberOfPayments, periodicalPayment and firstPayment are mandatory according to the notes below

Example: RegularCredit

transactionCode (String, Required)

Transaction channel identifier for processing rules and fraud prevention.

Valid Values: Phone, Internet, Installments, Credit Example: Phone

Card data parameters

cardNo (String, Optional)

Credit card number. Required for new card transactions unless using a saved card token (cardId).

Valid Values: 16-19 digits Example: 4111111111111111 Note: Must be accompanied by cardExpiration

cardExpiration (String, Optional)

Card expiry date. Required when cardNo is provided.

Valid Values: MMYY format Example: 1225 (December 2025)

cvv (String, Optional but Recommended)

Card security code for additional verification. While optional, strongly recommended for card-not-present transactions.

Valid Values: 3-4 digits Example: 123

cardId (String, Optional)

Token representing a previously saved card. Use as an alternative to cardNo for returning customers.

Valid Values: 16-digit token Example: 1234567890121234 Note: Last 4 digits match the original card

track2 (String, Optional)

Magnetic stripe data for physical card-present transactions (POS terminals).

Valid Values: Track2 format Example: 4111111111111111=25121015432198712345

Payment page parameters

mpiValidation (String, Optional)

Operation type for payment page transactions. Determines what happens after the customer completes the payment form.

Valid Values: autoComm, verify, token Example: autoComm

successUrl (String, Optional)

URL to redirect customers after a successful payment. Required for payment page transactions.

Valid Values: Valid HTTPS URL Example: https://yoursite.com/payment/success

cancelUrl (String, Optional)

URL to redirect customers if they cancel the payment. Required for payment page transactions.

Valid Values: Valid HTTPS URL Example: https://yoursite.com/payment/cancel

errorUrl (String, Optional)

URL to redirect customers if a payment error occurs.

Valid Values: Valid HTTPS URL Example: https://yoursite.com/payment/error

mid (String, Optional)

Merchant identifier for payment page branding and configuration.

Valid Values: Alphanumeric merchant ID Example: MERCHANT123

uniqueid (String, Optional)

Unique transaction identifier to prevent duplicate processing and for tracking.

Valid Values: Any unique string Example: ORDER-2024-001234

Installments parameters

numberOfPayments (Integer, Optional)

Number of installment payments. Required when creditType is set to Installments, SpecialCredit, or Payments.

Valid Values: 2-36 Default: 1 Example: 6

firstPayment (Integer, Optional)

Amount of the first installment in cents/agorot. The remaining amount is divided equally among other payments.

Valid Values: Positive integer Default: Total transaction amount Example: 500 (5.00 ILS)

deferMonths (Integer, Optional)

Number of months to defer the first installment payment.

Valid Values: 1-12 Default: 0 (no deferral) Example: 3

3D-Secure parameters

cavv (String, Optional)

Cardholder Authentication Verification Value - cryptographic proof that the cardholder was authenticated by the card issuer.

Valid Values: Base64 encoded value Example: AAABBIIFmAAAAAAAAAAAAAA=

eci (String, Optional)

Electronic Commerce Indicator - indicates the authentication result for 3D Secure transactions.

Valid Values: 3D Secure specific values (01, 02, 05, 06, 07) Example: 05

xid (String, Optional)

Transaction identifier for 3D Secure authentication process.

Valid Values: Alphanumeric string Example: MDAwMDAwMDAwMDAwMDAwMzIyNzY=

Business logic parameters

user (String, Optional)

User reference identifier for tracking purposes.

Valid Values: Any string Example: customer_12345

customerData (String, Optional)

Additional customer information that can be stored with the transaction.

Valid Values: JSON or XML formatted string Example: {"customerId":"12345","email":"[email protected]"}

addonData (String, Optional)

Custom data field for storing additional transaction-related information.

Valid Values: Any string Example: order_id=ORD123;source=mobile_app

recipientName (String, Optional)

Name of the recipient for payout transactions.

Valid Values: Text string Example: John Doe

transferComment (String, Optional)

Comment or description for transfer/payout transactions.

Valid Values: Text string Example: Refund for order #12345

dealerNumber (String, Optional)

Identifier for the dealer or agent processing the transaction.

Valid Values: Numeric string Example: 98765

slaveTerminalNumber (String, Optional)

Secondary terminal number for multi-terminal setups.

Valid Values: Numeric string Example: 0123457

mainTerminalNumber (String, Optional)

Primary terminal number in multi-terminal configurations.

Valid Values: Numeric string Example: 0123456

Advanced control parameters

routeCode (String, Optional)

Transaction routing code for advanced payment processing rules.

Valid Values: Specific routing codes (consult Hyp for available codes) Example: ROUTE_001

ipayCode (String, Optional)

Internal payment processing code for specialized handling.

Valid Values: Alphanumeric code Example: IPAY123

offerCode (Numeric(2), Optional)

A two-digit numeric value as agreed between the merchant and the acquirer. An offer code "KOD MIVTZA" as agreed between the merchant and the acquirer. Also requires pre-setup configuration on SHVA Terminal.

Valid Values: Two-digit numeric value (00-99) Example: 12

dueDate (String, Optional)

Payment due date for deferred transactions.

Valid Values: YYYYMMDD format Example: 20241231

periodicalPayment (String, Optional)

Flag to indicate if this is a recurring/subscription payment.

Valid Values: true, false Example: true

userDataX (String, Optional)

Extended user data field for additional custom information.

Valid Values: Any string Example: subscription_id=SUB789;plan=premium

shiftIdX (String, Optional)

Shift identifier for batch processing and reconciliation.

Valid Values: Numeric string Example: 20240715001

shiftTxnDate (String, Optional)

Transaction date for shift processing.

Valid Values: YYYYMMDD format Example: 20240715

Validation types reference

Validation Value

Use Case

Required Additional Parameters

autoComm

Direct charge - immediate payment processing

cardNo + cardExpiration OR cardId

verify

Pre-authorization - reserve funds without charging

cardNo + cardExpiration OR cardId

captureAuth

Capture pre-authorized funds

tranId (from original pre-auth)

token

Tokenization only - store card without charging

cardNo + cardExpiration, total=0

txnSetup

Payment page initialization

mpiValidation + successUrl + cancelUrl

SetAsHold

Put transaction on hold for manual review

tranId (from original transaction)

autoCommRelease

Release transaction from hold

tranId (from held transaction)

Transaction type & validation combinations

Transaction Type

Validation

Use Case

Description

debit

autoComm

Direct Charge

Immediate payment from customer

debit

verify

Pre-Authorization

Hold funds for later capture

debit

captureAuth

Capture

Finalize pre-authorized transaction

debit

token

Tokenization

Store card details for future use

credit

autoComm

Payout Charge

Send money to customer immediately

credit

verify

Payout Pre-Auth

Reserve for future credit payout

credit

captureAuth

Payout Capture

Finalize credit payout

Response structure

Success response

<?xml version='1.0'?>
<ashrait>
    <response>
        <command>doDeal</command>
        <dateTime>2025-08-04 14:48</dateTime>
        <requestId />
        <tranId>119252675</tranId>
        <result>000</result>
        <message>Permitted transaction</message>
        <userMessage>Permitted transaction</userMessage>
        <additionalInfo>Host Result Remote 00-SUCCESS </additionalInfo>
        <version>2000</version>
        <language>Eng</language>
        <doDeal>
            <status>000</status>
            <statusText>Permitted transaction</statusText>
            <extendedStatus />
            <extendedStatusText />
            <extendedUserMessage />
            <terminalNumber>0882804010</terminalNumber>
            <cardId>1092880571131111</cardId>
            <cardBin>411111</cardBin>
            <cardMask>411111******1111</cardMask>
            <cardLength>16</cardLength>
            <cardNo>xxxxxxxxxxxx1111</cardNo>
            <cardName />
            <cardExpiration>1225</cardExpiration>
            <cardType code="99">Foreign</cardType>
            <extendedCardType code="0">Credit</extendedCardType>
            <blockedCard />
            <lifeStyle />
            <customCardType />
            <creditCompany code="0">Foreign</creditCompany>
            <cardBrand code="2">Visa</cardBrand>
            <cardAcquirer code="6">Alphacard</cardAcquirer>
            <serviceCode />
            <transactionType code="01">RegularDebit</transactionType>
            <creditType code="1">RegularCredit</creditType>
            <currency code="1">ILS</currency>
            <baseCurrency />
            <baseAmount />
            <transactionCode code="50">Phone</transactionCode>
            <total>1000</total>
            <firstPayment />
            <periodicalPayment />
            <numberOfPayments />
            <clubId />
            <validation code="4">AutoComm</validation>
            <idStatus code="0">Absent</idStatus>
            <cvvStatus code="3">NotValidated</cvvStatus>
            <authSource code="2">CreditCompany</authSource>
            <authNumber>8605326</authNumber>
            <fileNumber>45</fileNumber>
            <slaveTerminalNumber>021</slaveTerminalNumber>
            <slaveTerminalSequence>884</slaveTerminalSequence>
            <eci />
            <clientIp />
            <email />
            <cavv code="" />
            <user />
            <addonData />
            <supplierNumber>300012</supplierNumber>
            <id />
            <shiftId1 />
            <shiftId2 />
            <shiftId3 />
            <shiftTxnDate />
            <cgUid>119252675</cgUid>
            <cardHash />
            <acquirerData>
                <gateway>AshraitEmv</gateway>
                <acquirerTranType>01</acquirerTranType>
                <mcc>4121</mcc>
                <acquirerResponseId>654676767431</acquirerResponseId>
                <avsResponse code="0">Absent</avsResponse>
                <acquirerTranCode>50</acquirerTranCode>
            </acquirerData>
            <ashraitEmvData>
                <uid>25080414485408828046754</uid>
                <authCodeCreditCompany code="1">CreditCompanyAuthorized</authCodeCreditCompany>
                <idFlag>0</idFlag>
                <manufId>CGD</manufId>
                <catLevel>0</catLevel>
                <manufUse>001101</manufUse>
                <ashVersion>x</ashVersion>
                <ashTermType>0</ashTermType>
                <emvResponseCode>00</emvResponseCode>
                <deviceStatus>1111000000</deviceStatus>
                <ashReasonText>TIKRA</ashReasonText>
                <authCodeAcquirer code="0">NoAuthNumber</authCodeAcquirer>
                <isDoReverseDeal>0</isDoReverseDeal>
                <mti>100</mti>
            </ashraitEmvData>
            <extendedTranCode />
            <sendNotification />
        </doDeal>
    </response>
</ashrait>

Error response

<?xml version='1.0'?>
<ashrait>
    <response>
        <command>doDeal</command>
        <dateTime>2025-08-06 10:46</dateTime>
        <requestId />
        <tranId>119295245</tranId>
        <result>004</result>
        <message>Refusal by credit company</message>
        <userMessage>Refusal by credit company</userMessage>
        <additionalInfo>Host Result Remote RESPONSE_0004-Transaction not approved </additionalInfo>
        <version>2000</version>
        <language>Eng</language>
        <doDeal>
            <status>004</status>
            <statusText>Refusal by credit company</statusText>
            <extendedStatus>15004</extendedStatus>
            <extendedStatusText>Transaction not approved</extendedStatusText>
            <extendedUserMessage>Transaction not approved</extendedUserMessage>
            <terminalNumber>0882814011</terminalNumber>
            <cardId>1092880571131111</cardId>
            <cardBin>411111</cardBin>
            <cardMask>411111******1111</cardMask>
            <cardLength>16</cardLength>
            <cardNo>xxxxxxxxxxxx1111</cardNo>
            <cardName />
            <cardExpiration>1225</cardExpiration>
            <cardType code="99">Foreign</cardType>
            <extendedCardType code="0">Credit</extendedCardType>
            <blockedCard />
            <lifeStyle />
            <customCardType />
            <creditCompany code="0">Foreign</creditCompany>
            <cardBrand code="2">Visa</cardBrand>
            <cardAcquirer code="2">Visa</cardAcquirer>
            <serviceCode />
            <transactionType code="01">RegularDebit</transactionType>
            <creditType code="1">RegularCredit</creditType>
            <currency code="1">ILS</currency>
            <baseCurrency />
            <baseAmount />
            <transactionCode code="50">Phone</transactionCode>
            <total>1000</total>
            <firstPayment />
            <periodicalPayment />
            <numberOfPayments />
            <clubId />
            <validation code="4">AutoComm</validation>
            <idStatus code="0">Absent</idStatus>
            <cvvStatus code="0">Absent</cvvStatus>
            <authSource code="2">CreditCompany</authSource>
            <authNumber />
            <fileNumber />
            <slaveTerminalNumber />
            <slaveTerminalSequence />
            <eci />
            <clientIp />
            <email />
            <cavv code="" />
            <user />
            <addonData />
            <supplierNumber>7007245</supplierNumber>
            <id />
            <shiftId1 />
            <shiftId2 />
            <shiftId3 />
            <shiftTxnDate />
            <cgUid>119295245</cgUid>
            <cardHash />
            <acquirerData>
                <gateway>AshraitEmv</gateway>
                <acquirerTranType>01</acquirerTranType>
                <mcc>0242</mcc>
                <avsResponse code="0">Absent</avsResponse>
                <acquirerTranCode>50</acquirerTranCode>
            </acquirerData>
            <ashraitEmvData>
                <uid>25080610460308828142450</uid>
                <authCodeCreditCompany code="2">CreditCompanyDeclined</authCodeCreditCompany>
                <idFlag>0</idFlag>
                <manufId>CGD</manufId>
                <catLevel>0</catLevel>
                <manufUse>001101</manufUse>
                <ashVersion>x</ashVersion>
                <ashTermType>0</ashTermType>
                <emvResponseCode>04</emvResponseCode>
                <deviceStatus>1111000000</deviceStatus>
                <ashReasonText>TIKRA</ashReasonText>
                <authCodeAcquirer code="2">AquirerDeclined</authCodeAcquirer>
                <telAuthAbility>1</telAuthAbility>
                <isDoReverseDeal>0</isDoReverseDeal>
                <mti>100</mti>
            </ashraitEmvData>
            <extendedTranCode />
            <sendNotification />
        </doDeal>
    </response>
</ashrait>

Response fields

Root response fields

Field

Type

Description

command

String

The command that was executed (doDeal)

dateTime

String

Response timestamp (YYYY-MM-DD HH:MM format)

requestId

String

Original request ID if provided

tranId

String

Unique transaction identifier assigned by system

result

String

Response code (000 for success, see Response Codes section)

message

String

System message describing the result

userMessage

String

User-friendly message

additionalInfo

String

Additional technical information about the transaction

version

String

API version used

language

String

Response language

doDeal section fields

Field

Type

Description

status

String

Transaction status code (same as result)

statusText

String

Transaction status description

extendedStatus

String

Extended error code for additional details

extendedStatusText

String

Extended status description

extendedUserMessage

String

Extended user message

terminalNumber

String

Terminal ID that processed the transaction

cardId

String

Token ID for saved card (16 digits)

cardBin

String

First 6 digits of card number

cardMask

String

Masked card number (e.g., 411111******1111)

cardLength

String

Number of digits in card number

cardNo

String

Masked card number (last 4 digits visible)

cardExpiration

String

Card expiry date (MMYY format)

cardType

Object

Card type with code and description

extendedCardType

Object

Extended card type (Credit/Debit)

creditCompany

Object

Credit company with code and name

cardBrand

Object

Card brand with code (2=Visa, 3=MasterCard, etc.)

cardAcquirer

Object

Acquirer information

transactionType

Object

Transaction type with code

creditType

Object

Credit type with code

currency

Object

Currency with code (1=ILS, 2=USD, etc.)

transactionCode

Object

Transaction code with value

total

Integer

Transaction amount in cents

validation

Object

Validation type with code

authNumber

String

Authorization number from card issuer

cgUid

String

CreditGuard unique identifier

supplierNumber

String

Supplier/merchant number

acquirerData section fields

Field

Type

Description

gateway

String

Gateway used (e.g., AshraitEmv)

acquirerTranType

String

Acquirer transaction type

mcc

String

Merchant Category Code

acquirerResponseId

String

Acquirer's response identifier

avsResponse

Object

AVS response with code

ashraitEmvData section fields

Field

Type

Description

uid

String

Unique transaction ID from Ashrait

authCodeCreditCompany

Object

Credit company authorization status

emvResponseCode

String

EMV response code (00 = success)

authCodeAcquirer

Object

Acquirer authorization status

Code examples

#!/bin/bash

# Set credentials and endpoint
API_USER="your_username"
API_PASS="your_password"
ENDPOINT="https://your-hyp-environment-url/xpo/Relay"

# Create XML payload for direct charge
XML_PAYLOAD='<ashrait>
  <request>
    <version>2000</version>
    <language>ENG</language>
    <command>doDeal</command>
    <doDeal>
      <terminalNumber>0123456</terminalNumber>
      <transactionType>debit</transactionType>
      <transactionCode>Phone</transactionCode>
      <total>1000</total>
      <currency>ILS</currency>
      <creditType>RegularCredit</creditType>
      <validation>autoComm</validation>
      <cardNo>4111111111111111</cardNo>
      <cardExpiration>1225</cardExpiration>
      <cvv>123</cvv>
    </doDeal>
  </request>
</ashrait>'

# URL encode the XML
ENCODED_XML=$(echo -n "$XML_PAYLOAD" | python3 -c "import sys, urllib.parse; print(urllib.parse.quote(sys.stdin.read()))")

# Send request
curl -X POST "$ENDPOINT" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "user=$API_USER&password=$API_PASS&int_in=$ENCODED_XML"

import requests
import urllib.parse
from xml.etree import ElementTree as ET

# Configuration
API_USER = "your_username"
API_PASS = "your_password"
ENDPOINT = "https://your-hyp-environment-url/xpo/Relay"

def process_payment(terminal_number, total, currency="ILS", **kwargs):
    """
    Process various types of payments using doDeal endpoint
    
    Args:
        terminal_number (str): Terminal ID
        total (int): Amount in cents
        currency (str): Currency code
        **kwargs: Additional parameters for specific use cases:
            - validation: Transaction type (autoComm, verify, captureAuth, token, etc.)
            - transaction_type: debit or credit
            - card_number: Credit card number
            - card_expiration: Card expiry (MMYY)
            - cvv: Card security code
            - card_id: Token for saved card
            - tran_id: For capture/hold operations
            - mpi_validation: For payment page setup
            - success_url: Payment page success URL
            - cancel_url: Payment page cancel URL
        
    Returns:
        dict: Response containing success status and transaction data
    """
    
    # Build XML parameters dynamically
    xml_params = [
        f"<terminalNumber>{terminal_number}</terminalNumber>",
        f"<transactionType>{kwargs.get('transaction_type', 'debit')}</transactionType>",
        f"<total>{total}</total>",
        f"<currency>{currency}</currency>",
        f"<validation>{kwargs.get('validation', 'autoComm')}</validation>",
        f"<creditType>{kwargs.get('credit_type', 'RegularCredit')}</creditType>",
        f"<transactionCode>{kwargs.get('transaction_code', 'Phone')}</transactionCode>"
    ]
    
    # Add card data if provided
    if 'card_number' in kwargs:
        xml_params.append(f"<cardNo>{kwargs['card_number']}</cardNo>")
    if 'card_expiration' in kwargs:
        xml_params.append(f"<cardExpiration>{kwargs['card_expiration']}</cardExpiration>")
    if 'cvv' in kwargs:
        xml_params.append(f"<cvv>{kwargs['cvv']}</cvv>")
    if 'card_id' in kwargs:
        xml_params.append(f"<cardId>{kwargs['card_id']}</cardId>")
    
    # Add transaction reference for capture/hold operations
    if 'tran_id' in kwargs:
        xml_params.append(f"<tranId>{kwargs['tran_id']}</tranId>")
    
    # Add payment page parameters
    if 'mpi_validation' in kwargs:
        xml_params.append(f"<mpiValidation>{kwargs['mpi_validation']}</mpiValidation>")
    if 'success_url' in kwargs:
        xml_params.append(f"<successUrl>{kwargs['success_url']}</successUrl>")
    if 'cancel_url' in kwargs:
        xml_params.append(f"<cancelUrl>{kwargs['cancel_url']}</cancelUrl>")
    if 'mid' in kwargs:
        xml_params.append(f"<mid>{kwargs['mid']}</mid>")
    if 'uniqueid' in kwargs:
        xml_params.append(f"<uniqueid>{kwargs['uniqueid']}</uniqueid>")
    
    # Create XML payload
    xml_payload = f"""<ashrait>
      <request>
        <version>2000</version>
        <language>ENG</language>
        <command>doDeal</command>
        <doDeal>
          {''.join(xml_params)}
        </doDeal>
      </request>
    </ashrait>"""
    
    # Prepare form data
    form_data = {
        'user': API_USER,
        'password': API_PASS,
        'int_in': xml_payload
    }
    
    # Send request
    try:
        response = requests.post(ENDPOINT, data=form_data)
        response.raise_for_status()
        
        # Parse XML response
        root = ET.fromstring(response.text)
        result = root.find('.//result').text
        
        if result == '000':
            # Extract response data
            tran_id = root.find('.//tranId').text
            response_data = {
                'success': True,
                'transaction_id': tran_id,
                'result_code': result
            }
            
            # Add optional response fields if present
            auth_number = root.find('.//authNumber')
            if auth_number is not None:
                response_data['auth_number'] = auth_number.text
            
            card_id = root.find('.//cardId')
            if card_id is not None:
                response_data['card_id'] = card_id.text
            
            cg_uid = root.find('.//cgUid')
            if cg_uid is not None:
                response_data['cg_uid'] = cg_uid.text
            
            return response_data
        else:
            error_msg = root.find('.//userMessage')
            return {
                'success': False,
                'error': error_msg.text if error_msg is not None else 'Unknown error',
                'result_code': result
            }
            
    except Exception as e:
        return {
            'success': False,
            'error': str(e)
        }

# Example 1: Direct Charge
direct_charge = process_payment(
    terminal_number='0123456',
    total=1000,  # 10.00 ILS
    validation='autoComm',
    card_number='4111111111111111',
    card_expiration='1225',
    cvv='123'
)

# Example 2: Pre-Authorization
pre_auth = process_payment(
    terminal_number='0123456',
    total=5000,  # 50.00 ILS
    validation='verify',
    card_number='4111111111111111',
    card_expiration='1225',
    cvv='123'
)

# Example 3: Tokenization
tokenization = process_payment(
    terminal_number='0123456',
    total=0,  # No charge for tokenization
    validation='token',
    card_number='4111111111111111',
    card_expiration='1225'
)

# Example 4: Payment Page Setup
payment_page = process_payment(
    terminal_number='0123456',
    total=2500,  # 25.00 ILS
    validation='txnSetup',
    mpi_validation='autoComm',
    success_url='https://yoursite.com/success',
    cancel_url='https://yoursite.com/cancel',
    mid='MERCHANT123',
    uniqueid='ORDER-456'
)

# Example 5: Capture Pre-Authorization
capture = process_payment(
    terminal_number='0123456',
    total=5000,  # Same amount as pre-auth
    validation='captureAuth',
    tran_id='12345678'  # From pre-auth response
)

# Example 6: Credit Payout
payout = process_payment(
    terminal_number='0123456',
    total=1500,  # 15.00 ILS
    transaction_type='credit',
    validation='autoComm',
    card_number='4111111111111111',
    card_expiration='1225'
)

# Print results
for name, result in [('Direct Charge', direct_charge), ('Pre-Auth', pre_auth), 
                     ('Tokenization', tokenization), ('Payment Page', payment_page),
                     ('Capture', capture), ('Payout', payout)]:
    if result['success']:
        print(f"{name} successful! Transaction ID: {result['transaction_id']}")
    else:
        print(f"{name} failed: {result['error']}")

const axios = require('axios');
const querystring = require('querystring');
const xml2js = require('xml2js');

// Configuration
const API_USER = 'your_username';
const API_PASS = 'your_password';
const ENDPOINT = 'https://your-hyp-environment-url/xpo/Relay';

/**
 * Process various types of payments using doDeal endpoint
 * @param {Object} options - Payment options
 * @returns {Object} Response with success status and data
 */
async function processPayment(options) {
    const {
        terminalNumber,
        total,
        currency = 'ILS',
        validation = 'autoComm',
        transactionType = 'debit',
        creditType = 'RegularCredit',
        transactionCode = 'Phone',
        ...additionalParams
    } = options;

    // Build XML parameters
    const xmlParams = [
        `<terminalNumber>${terminalNumber}</terminalNumber>`,
        `<transactionType>${transactionType}</transactionType>`,
        `<total>${total}</total>`,
        `<currency>${currency}</currency>`,
        `<validation>${validation}</validation>`,
        `<creditType>${creditType}</creditType>`,
        `<transactionCode>${transactionCode}</transactionCode>`
    ];

    // Add additional parameters dynamically
    Object.entries(additionalParams).forEach(([key, value]) => {
        if (value !== undefined && value !== null) {
            xmlParams.push(`<${key}>${value}</${key}>`);
        }
    });

    const xmlPayload = `<ashrait>
      <request>
        <version>2000</version>
        <language>ENG</language>
        <command>doDeal</command>
        <doDeal>
          ${xmlParams.join('\n          ')}
        </doDeal>
      </request>
    </ashrait>`;

    // Prepare form data
    const formData = querystring.stringify({
        user: API_USER,
        password: API_PASS,
        int_in: xmlPayload
    });

    try {
        // Send request
        const response = await axios.post(ENDPOINT, formData, {
            headers: {
                'Content-Type': 'application/x-www-form-urlencoded'
            }
        });

        // Parse XML response
        const parser = new xml2js.Parser();
        const result = await parser.parseStringPromise(response.data);
        
        const responseData = result.ashrait.response[0];
        const resultCode = responseData.result[0];

        if (resultCode === '000') {
            const successResponse = {
                success: true,
                transactionId: responseData.tranId[0],
                resultCode: resultCode
            };

            // Add optional fields if present
            if (responseData.doDeal && responseData.doDeal[0]) {
                const dealData = responseData.doDeal[0];
                if (dealData.authNumber) successResponse.authNumber = dealData.authNumber[0];
                if (dealData.cardId) successResponse.cardId = dealData.cardId[0];
                if (dealData.cgUid) successResponse.cgUid = dealData.cgUid[0];
                if (dealData.cardBrand) successResponse.cardBrand = dealData.cardBrand[0];
            }

            return successResponse;
        } else {
            return {
                success: false,
                error: responseData.userMessage ? responseData.userMessage[0] : 'Unknown error',
                resultCode: resultCode
            };
        }
    } catch (error) {
        return {
            success: false,
            error: error.message
        };
    }
}

// Example usage patterns

async function runExamples() {
    try {
        // 1. Direct Charge
        const directCharge = await processPayment({
            terminalNumber: '0123456',
            total: 1000,
            validation: 'autoComm',
            cardNo: '4111111111111111',
            cardExpiration: '1225',
            cvv: '123'
        });

        // 2. Pre-Authorization  
        const preAuth = await processPayment({
            terminalNumber: '0123456',
            total: 5000,
            validation: 'verify',
            cardNo: '4111111111111111',
            cardExpiration: '1225',
            cvv: '123'
        });

        // 3. Tokenization
        const tokenization = await processPayment({
            terminalNumber: '0123456',
            total: 0,
            validation: 'token',
            cardNo: '4111111111111111',
            cardExpiration: '1225'
        });

        // 4. Payment Page Setup
        const paymentPage = await processPayment({
            terminalNumber: '0123456',
            total: 2500,
            validation: 'txnSetup',
            mpiValidation: 'autoComm',
            successUrl: 'https://yoursite.com/success',
            cancelUrl: 'https://yoursite.com/cancel',
            mid: 'MERCHANT123',
            uniqueid: 'ORDER-456'
        });

        // 5. Installments Payment
        const installments = await processPayment({
            terminalNumber: '0123456',
            total: 3000,
            validation: 'autoComm',
            creditType: 'Installments',
            numberOfPayments: 6,
            firstPayment: 500,
            cardNo: '4111111111111111',
            cardExpiration: '1225',
            cvv: '123'
        });

        // 6. Token-based Payment
        const tokenPayment = await processPayment({
            terminalNumber: '0123456',
            total: 1500,
            validation: 'autoComm',
            cardId: '1234567890123456'  // Previously obtained token
        });

        // Process results
        const examples = [
            ['Direct Charge', directCharge],
            ['Pre-Authorization', preAuth],
            ['Tokenization', tokenization],
            ['Payment Page', paymentPage],
            ['Installments', installments],
            ['Token Payment', tokenPayment]
        ];

        examples.forEach(([name, result]) => {
            if (result.success) {
                console.log(`${name} successful! Transaction ID: ${result.transactionId}`);
                if (result.authNumber) console.log(`  Auth Number: ${result.authNumber}`);
                if (result.cardId) console.log(`  Card Token: ${result.cardId}`);
            } else {
                console.log(`${name} failed: ${result.error} (Code: ${result.resultCode})`);
            }
        });

    } catch (error) {
        console.error('Error running examples:', error.message);
    }
}

// Run examples
runExamples();

import java.io.*;
import java.net.*;
import java.util.*;
import javax.xml.parsers.*;
import org.w3c.dom.*;

public class HypDoDealClient {
    private static final String API_USER = "your_username";
    private static final String API_PASS = "your_password";
    private static final String ENDPOINT = "https://your-hyp-environment-url/xpo/Relay";
    
    public static class PaymentRequest {
        public String terminalNumber;
        public int total;
        public String currency = "ILS";
        public String validation = "autoComm";
        public String transactionType = "debit";
        public String creditType = "RegularCredit";
        public String transactionCode = "Phone";
        public Map<String, String> additionalParams = new HashMap<>();
        
        public PaymentRequest(String terminalNumber, int total) {
            this.terminalNumber = terminalNumber;
            this.total = total;
        }
        
        public PaymentRequest setValidation(String validation) {
            this.validation = validation;
            return this;
        }
        
        public PaymentRequest setTransactionType(String transactionType) {
            this.transactionType = transactionType;
            return this;
        }
        
        public PaymentRequest setCreditType(String creditType) {
            this.creditType = creditType;
            return this;
        }
        
        public PaymentRequest addParam(String key, String value) {
            this.additionalParams.put(key, value);
            return this;
        }
    }
    
    public static class PaymentResult {
        public boolean success;
        public String transactionId;
        public String authNumber;
        public String cardId;
        public String cgUid;
        public String cardBrand;
        public String resultCode;
        public String error;
        
        @Override
        public String toString() {
            return success ? 
                String.format("SUCCESS - TxnID: %s, Auth: %s", transactionId, authNumber) :
                String.format("FAILED - %s (Code: %s)", error, resultCode);
        }
    }
    
    public static PaymentResult processPayment(PaymentRequest request) {
        PaymentResult result = new PaymentResult();
        
        try {
            // Build XML payload
            StringBuilder xmlBuilder = new StringBuilder();
            xmlBuilder.append("<ashrait>")
                     .append("<request>")
                     .append("<version>2000</version>")
                     .append("<language>ENG</language>")
                     .append("<command>doDeal</command>")
                     .append("<doDeal>")
                     .append("<terminalNumber>").append(request.terminalNumber).append("</terminalNumber>")
                     .append("<transactionType>").append(request.transactionType).append("</transactionType>")
                     .append("<total>").append(request.total).append("</total>")
                     .append("<currency>").append(request.currency).append("</currency>")
                     .append("<validation>").append(request.validation).append("</validation>")
                     .append("<creditType>").append(request.creditType).append("</creditType>")
                     .append("<transactionCode>").append(request.transactionCode).append("</transactionCode>");
            
            // Add additional parameters
            for (Map.Entry<String, String> entry : request.additionalParams.entrySet()) {
                xmlBuilder.append("<").append(entry.getKey()).append(">")
                         .append(entry.getValue())
                         .append("</").append(entry.getKey()).append(">");
            }
            
            xmlBuilder.append("</doDeal>")
                     .append("</request>")
                     .append("</ashrait>");
            
            String xmlPayload = xmlBuilder.toString();
            
            // Prepare form data
            String formData = String.format("user=%s&password=%s&int_in=%s",
                URLEncoder.encode(API_USER, "UTF-8"),
                URLEncoder.encode(API_PASS, "UTF-8"),
                URLEncoder.encode(xmlPayload, "UTF-8")
            );
            
            // Send HTTP request
            URL url = new URL(ENDPOINT);
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
            conn.setRequestMethod("POST");
            conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
            conn.setDoOutput(true);
            
            try (OutputStreamWriter writer = new OutputStreamWriter(conn.getOutputStream())) {
                writer.write(formData);
                writer.flush();
            }
            
            // Read response
            StringBuilder response = new StringBuilder();
            try (BufferedReader reader = new BufferedReader(
                    new InputStreamReader(conn.getInputStream()))) {
                String line;
                while ((line = reader.readLine()) != null) {
                    response.append(line);
                }
            }
            
            // Parse XML response
            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
            DocumentBuilder builder = factory.newDocumentBuilder();
            Document doc = builder.parse(new ByteArrayInputStream(
                response.toString().getBytes("UTF-8")));
            
            String resultCode = getElementValue(doc, "result");
            result.resultCode = resultCode;
            
            if ("000".equals(resultCode)) {
                result.success = true;
                result.transactionId = getElementValue(doc, "tranId");
                result.authNumber = getElementValue(doc, "authNumber");
                result.cardId = getElementValue(doc, "cardId");
                result.cgUid = getElementValue(doc, "cgUid");
                result.cardBrand = getElementValue(doc, "cardBrand");
            } else {
                result.success = false;
                result.error = getElementValue(doc, "userMessage");
                if (result.error == null) {
                    result.error = getElementValue(doc, "message");
                }
            }
            
        } catch (Exception e) {
            result.success = false;
            result.error = e.getMessage();
        }
        
        return result;
    }
    
    private static String getElementValue(Document doc, String tagName) {
        NodeList nodeList = doc.getElementsByTagName(tagName);
        if (nodeList.getLength() > 0) {
            return nodeList.item(0).getTextContent();
        }
        return null;
    }
    
    public static void main(String[] args) {
        // Example 1: Direct Charge
        PaymentResult directCharge = processPayment(
            new PaymentRequest("0123456", 1000)
                .setValidation("autoComm")
                .addParam("cardNo", "4111111111111111")
                .addParam("cardExpiration", "1225")
                .addParam("cvv", "123")
        );
        
        // Example 2: Pre-Authorization
        PaymentResult preAuth = processPayment(
            new PaymentRequest("0123456", 5000)
                .setValidation("verify")
                .addParam("cardNo", "4111111111111111")
                .addParam("cardExpiration", "1225")
                .addParam("cvv", "123")
        );
        
        // Example 3: Tokenization
        PaymentResult tokenization = processPayment(
            new PaymentRequest("0123456", 0)
                .setValidation("token")
                .addParam("cardNo", "4111111111111111")
                .addParam("cardExpiration", "1225")
        );
        
        // Example 4: Payment Page Setup
        PaymentResult paymentPage = processPayment(
            new PaymentRequest("0123456", 2500)
                .setValidation("txnSetup")
                .addParam("mpiValidation", "autoComm")
                .addParam("successUrl", "https://yoursite.com/success")
                .addParam("cancelUrl", "https://yoursite.com/cancel")
                .addParam("mid", "MERCHANT123")
                .addParam("uniqueid", "ORDER-456")
        );
        
        // Example 5: Installments
        PaymentResult installments = processPayment(
            new PaymentRequest("0123456", 3000)
                .setValidation("autoComm")
                .setCreditType("Installments")
                .addParam("numberOfPayments", "6")
                .addParam("firstPayment", "500")
                .addParam("cardNo", "4111111111111111")
                .addParam("cardExpiration", "1225")
                .addParam("cvv", "123")
        );
        
        // Example 6: Credit Payout
        PaymentResult payout = processPayment(
            new PaymentRequest("0123456", 1500)
                .setTransactionType("credit")
                .setValidation("autoComm")
                .addParam("cardNo", "4111111111111111")
                .addParam("cardExpiration", "1225")
        );
        
        // Example 7: Token-based Payment
        PaymentResult tokenPayment = processPayment(
            new PaymentRequest("0123456", 1500)
                .setValidation("autoComm")
                .addParam("cardId", "1234567890123456")
        );
        
        // Print results
        System.out.println("=== Payment Processing Results ===");
        System.out.println("Direct Charge: " + directCharge);
        System.out.println("Pre-Authorization: " + preAuth);
        System.out.println("Tokenization: " + tokenization);
        System.out.println("Payment Page: " + paymentPage);
        System.out.println("Installments: " + installments);
        System.out.println("Payout: " + payout);
        System.out.println("Token Payment: " + tokenPayment);
    }
}

Response codes

Common response codes

Here are the most frequently encountered response codes:

Code

Message

Description

000

Permitted transaction

Transaction approved successfully

003

Contact the credit company

004

Refusal by credit company

Transaction declined by issuer

006

Incorrect CVV/ID

CVV or ID verification failed

009

No communication

Connection error - retry or contact support

033

Defective card

Card validation failed

036

Expired card

Card expiration date has passed

039

Incorrect control number

Card control number validation failed

099

General error

System error - contact support

All response codes

Click for the full list of response codes

Code

Message

Description

000

Permitted transaction

001

The card is blocked - confiscate it

002

The card is stolen - confiscate it

003

Contact the credit company

004

Refusal by credit company

005

The card is forged - confiscate it

006

Incorrect CVV/ID

007

Incorrect CAVV/ECI/UCAF

008

An error occurred while building access key for blocked card files

Please contact System Administration

009

No communication

No communication. Please try again or contact System Administration

010

The program was stopped by user`s command (ESC)

Please contact System Administration

011

The acquirer is not authorized for foreign currency transactions

012

This card is not permitted for foreign currency transactions

013

The terminal is not permitted for foreign currency load/unload into this card

The terminal is not permitted for foreign currency charge/discharge into this card

014

This card is not permitted for load/unload transaction

This card is not permitted for charge/discharge transaction

015

Track 2 (Magnetic) does not match the typed data

016

Additional required data was not entered (Z field)

017

Last 4 digits were not entered (W field)

018

AVS status not approved

019

INT_IN is shorter than 16 characters

Please contact System Administration

020

The input file (INT_IN) does not exist

Please contact System Administration

021

Blocked cards file (NEG) does not exist or has not been updated - transmit or request authorization for each transaction

Please contact System Administration

022

One of the parameter files/vectors does not exist

Please contact System Administration

023

Date file (DATA) does not exist

Please contact System Administration

024

Format file (START) does not exist

Please contact System Administration

025

The difference in days in the blocked cards input is too large - transmit or request authorization for each transaction

Please contact System Administration

026

The difference in generations in the blocked cards input is too large - transmit or request authorization for each transaction

Please contact System Administration

027

When the magnetic strip is not completely entered - define the transaction as a telephone number or signature only

028

The central terminal number was not entered into the defined main supplier terminal

Please contact System Administration

029

The beneficiary number was not entered into the defined main beneficiary terminal

Please contact System Administration

030

The supplier/beneficiary number was entered - however the terminal was not updated as the main supplier/beneficiary

Please contact System Administration

031

The beneficiary number was entered - however the terminal was updated as the main supplier

Please contact System Administration

032

Old transactions - transmit or request authorization for each transaction

Please contact System Administration

033

Defective card

034

This card is not permitted for this terminal or is not authorized for this type of transaction

035

This card is not permitted for this transaction or type of credit

036

Expired card

037

Installment error - the amount of transactions needs to be equal to: first installment plus fixed installments times number of installments

038

Unable to execute a debit transaction that is higher than the credit card`s ceiling

039

Incorrect control number

040

The beneficiary and supplier numbers were entered - however the terminal is defined as main

Please contact System Administration

041

The transaction`s amount exceeds the ceiling when the input file contains J1 or J2 or J3 (contact prohibited)

Check card details with no amount

042

The card is blocked for the supplier where input file contains J1 or J2 or J3 (contact prohibited)

Please contact System Administration

043

Random where input file contains J1 (contact prohibited)

Please contact System Administration

044

The terminal is prohibited from requesting authorization without transaction (J5)

Please contact System Administration

045

The terminal is prohibited for supplier-initiated authorization request (J6)

Please contact System Administration

046

The terminal must request authorization where the input file contains J1 or J2 or J3 (contact prohibited)

Please contact System Administration

047

Secret code must be entered where input file contains J1 or J2 or J3 (contact prohibited)

Please contact System Administration

051

Incorrect vehicle number

052

The number of the distance meter was not entered

053

The terminal is not defined as gas station (petrol card or incorrect transaction code was used)

Please contact System Administration

057

An ID number is required (for Israeli cards only) but was not entered

058

CVV is required but was not entered

059

CVV and ID number are required (for Israeli cards only) but were not entered

060

ABS attachment was not found at the beginning of the input data in memory

Please contact System Administration

061

The card number was either not found or found twice

Please contact System Administration

062

Incorrect transaction type

Please contact System Administration

063

Incorrect transaction code

Please contact System Administration

064

Incorrect credit type

Please contact System Administration

065

Incorrect currency

Please contact System Administration

066

The first installment and/or fixed payment are for non-installment type of credit

Please contact System Administration

067

Number of installments exist for the type of credit that does not require this

Please contact System Administration

068

Linkage to dollar or index is possible only for installment credit

Please contact System Administration

069

The magnetic strip is too short

Please contact System Administration

070

The PIN code device is not defined

Please contact System Administration

071

Incorrect beneficiary

Please contact System Administration

072

The secret code was not entered

073

Incorrect secret code

074

Incorrect secret code - last try

075

Please contact System Administration

076

Please contact System Administration

077

Incorrect PIN code

079

Terminal definitions does not permit to clear this currency

080

The club code entered does not match the credit type

081

Validation type is incorrect

090

Cannot cancel charge transaction

091

Cannot cancel discharge transaction

092

Cannot cancel foreign currency transaction

099

Unable to read/write/open the TRAN file

Please contact System Administration

100

No equipment for inputting secret code

Please contact System Administration

101

No authorization from credit company for clearance

Please contact System Administration

106

The terminal is not permitted to send queries for immediate debit cards

Please contact System Administration

107

The transaction amount is too large - divide it into a number of transactions

108

The terminal is not authorized to execute forced transactions

Please contact System Administration

109

The terminal is not authorized for cards with service code 587

Please contact System Administration

110

The terminal is not authorized for immediate debit cards

111

The terminal is not authorized for installment transactions

112

The terminal is authorized for installment transactions only - not telephone/signature

113

The terminal is not authorized for telephone transactions

114

The terminal is not authorized for signature-only transactions

115

The terminal is not authorized for foreign currency transactions - or transaction is not authorized

116

The terminal is not authorized for club transactions

117

The terminal is not authorized for star/point/mile transactions

118

The terminal is not authorized for Isracredit credit

119

The terminal is not authorized for Amex credit

120

The terminal is not authorized for dollar linkage

121

The terminal is not authorized for index linkage

122

The terminal is not authorized for index linkage with foreign cards

123

The terminal is not authorized for star/point/mile transactions for this type of credit

124

The terminal is not authorized for Isra 36 credit

125

The terminal is not authorized for Amex 36 credit

126

The terminal is not authorized for this club code

127

The terminal is not authorized for immediate debit transactions (except for immediate debit cards)

128

The terminal is not authorized to accept Visa card staring with 3

129

The terminal is not authorized to execute credit transactions above the ceiling

130

The card is not permitted to execute club transactions

131

The card is not permitted to execute star/point/mile transactions

132

The card is not permitted to execute dollar transactions (regular or telephone)

133

The card is not valid according to Isracard`s list of valid cards

134

Defective card according to system definitions (Isracard VECTOR1) - error in the number of figures on the card

135

The card is not permitted to execute dollar transactions according to system definitions (Isracard VECTOR1)

136

The card belongs to a group that is not permitted to execute transactions according to system definitions (Visa VECTOR 20)

137

The card`s prefix (7 figures) is invalid according to system definitions (Diners VECTOR21)

138

The card is not permitted to carry out installment transactions according to Isracard`s list of valid cards

139

The number of installments is too large according to Isracard`s list of valid cards

140

Visa and Diners cards are not permitted for club installment transactions

141

Series of cards are not valid according to system definition (Isracard VECTOR5)

142

Invalid service code according to system definitions (Isracard VECTOR6)

143

The card`s prefix (2 figures) is invalid according to system definitions (Isracard VECTOR7)

144

Invalid service code according to system definitions (Visa VECTOR12)

145

Invalid service code according to system definitions (Visa VECTOR13)

146

Immediate debit card is prohibited for executing credit transaction

147

The card is not permitted to execute installment transactions according to Alpha vector no. 31

148

The card is not permitted for telephone and signature-only transactions according to Alpha vector no. 31

149

The card is not permitted for telephone transactions according to Alpha vector no. 31

150

Credit is not approved for immediate debit cards

151

Credit is not approved for foreign cards

152

Incorrect club code

153

The card is not permitted to execute flexible credit transactions (Adif/30+) according to system definitions (Diners VECTOR21)

154

The card is not permitted to execute immediate debit transactions according to system definitions (Diners VECTOR21)

155

The payment amount is too low for credit transactions

156

Incorrect number of installments for credit transaction

157

Zero ceiling for this type of card for regular credit or Credit transaction

158

Zero ceiling for this type of card for immediate debit credit transaction

159

Zero ceiling for this type of card for immediate debit in dollars

160

Zero ceiling for this type of card for telephone transaction

161

Zero ceiling for this type of card for credit transaction

162

Zero ceiling for this type of card for installment transaction

163

American Express card issued abroad is not permitted for installment transactions

American Express card issued abroad not permitted for instalments transaction

164

JCB cards are only permitted to carry out regular credit transactions

165

The amount in stars/points/miles is higher than the transaction amount

166

The club card is not within terminal range

167

Star/point/mile transactions cannot be executed

168

Dollar transactions cannot be executed for this type of card

169

Credit transactions cannot be executed with other than regular credit

170

Amount of discount on stars/points/miles is higher than the permitted

171

Forced transactions cannot be executed with credit/immediate debit card

172

The previous transaction cannot be cancelled (credit transaction or card number are not identical)

173

Double transaction

174

The terminal is not permitted for index linkage of this type of credit

175

The terminal is not permitted for dollar linkage of this type of credit

176

The card is invalid according to system definitions (Isracard VECTOR1)

177

Unable to execute the self-service transaction if the gas station does not have self service

178

Credit transactions are forbidden with stars/points/miles

179

Dollar credit transactions are forbidden on tourist cards

180

Phone transactions are not permitted on Club cards

200

Application error

Please contact System Administration

201

Error reading encrypted magnetic strip

250

Internal error - communication synchronization

Please contact System Administration

251

Terminal directory does not exist

Please contact System Administration

252

No write permission for terminal directory

Please contact System Administration

253

No executable permission for terminal directory

Please contact System Administration

300

Invalid response received from Ashrait

Please contact System Administration

301

Zero amount is not allowed when J is not 2 or 3 or 5 or 102

Please contact System Administration

302

No authorization number was entered in the E field

Please contact System Administration

303

XPO (Ashrait) did not respond within the defined timeout

Please contact System Administration

304

The terminals folder does not exist

Please contact System Administration

305

No writing permission to terminal log file

Please contact System Administration

306

Incorrect username - password or database name when connecting to the database

Please contact System Administration

307

An error occurred while connecting to the database

Please contact System Administration

308

An error occurred while executing a query in the database

Please contact System Administration

309

Invalid date for checking previous charge deals

Please contact System Administration

310

There is no debit deal that matches the credit deal

Please contact System Administration

311

An error occurred while attempting to write Ashrait record with error code into database

Please contact System Administration

312

There is no transaction found for canceling

313

Transaction for canceling was already transmitted

314

The transaction was already cancelled

315

Access to the terminals folder is not permitted

Please contact System Administration

316

Error connecting to external interface

Please contact System Administration

317

There are missing parameters for the required action

Please contact System Administration

318

Configuration file error

Please contact System Administration

319

The terminal is not allowed to accept cancellation commands

320

Credit is already done per specified debit deal

321

The refund amount is large/small than the charge amount

The refund amount is large/small than the charge amount amount is different than the charge deal amount

322

Missing mandatory field in XML

Please contact System Administration

323

Incorrect deal type when using DELETE1

Please contact System Administration

324

The terminal is not permitted to refund transactions

325

Invalid XML format

Please contact System Administration

326

No permission for this type of card

327

The terminal does not exist

Please contact System Administration

328

The terminal already exists

Please contact System Administration

329

The terminal is locked for doDeal

Terminal is locked for doDeal

330

The terminal is locked for transmission

Terminal is locked for transmit

331

Invalid value in an XML field

Please contact System Administration

332

More than one transaction found for cancel/ cond. Refund

333

Merchant is not permitted to perform the required action

Please contact System Administration

334

The transaction has already been settled once

335

Blocked card for credit in CFT terminal

336

Terminal blocked for non dollars deals

337

X field is mandatory

338

Total amount for this card is above permitted per day

339

Refund credit type is different from original transaction

340

Refund number of payments is different from original transaction

341

Refund amount is different from original transaction

342

Card id was not found

343

shva communicator returned empty response

Please contact System Administration

344

Merchant does not exist

345

Merchant already exist

346

Terminal is not permitted to clear this currency

347

Sector does not exist

348

Password should contain upper and lower case letters numbers and punctuation

349

Terminal does not support mayBeDuplicate

Please contact System Administration

350

Acquirer does not exist

351

Matching routing was not found

352

Unable to transmit - exceeded a daily quota

353

No transactions to transmit

354

Transaction processing time exceeds allowed time

Please contact System Administration

355

Hold deal already released

356

There is no transaction found for release

357

More than one transaction found for release

358

Sensitive details were not found

359

Report id was not found

360

Merchant block action

361

Error identifying extended card type

Please contact System Administration

362

Merchant does not have permission for report definition

363

Definition Id does not exist

364

Sent parameters are not defined for report

365

Error producing report

366

Report process id does not exists

367

Internal card Id does not exists for card number

368

Transaction already transmitted

369

Original transaction was done on unauthorized terminal

370

Transfer transaction amount does not match original transaction

371

Did not find transaction for transfer

372

Transaction was transferred to another terminal

373

Merchant decision for cvv is not allowed

374

Cannot do forced transaction with this card

375

cgUid does not exist

376

No transaction found for hold

377

Transaction already on hold

378

More than one transaction found for hold

379

Capture total amount is higher than authorization amount

380

OTP request failed

381

Terminal is blocked for OTP request

382

OTP invalid

383

OTP used

384

Maximum OTP request exceeded

385

Incorrect CVV/ID

386

Cancel transaction was found matching current transaction

399

Missing initialization in payCheckOut server

400

Invalid parameters order

Please contact System Administration

401

Invalid characters in INT_IN string

Please contact System Administration

402

Invalid characters in XML string

Please contact System Administration

403

Less than six days to card`s expiration date

404

No communication to Ashrait

Please contact System Administration

405

SSL HTTPS customers are not permitted to access the system

Please contact System Administration

406

Not in use

407

Not in use

408

Authorization number was not found in the system

409

The card is in customers black list

410

This type of transaction is not permitted in this terminal

411

The customer is not permitted to work with this terminal

412

No authorization number was found for this transaction

413

Removing transaction from TR table failed

414

An XML field or an INT_IN parameter is too short/ long

415

No permission to charge twice with same authorization number

416

No permission to refund twice with same authorization number

417

The card is in customers negative list - previous Ashrait return code

418

Merchant is not permitted to send non-encrypted data

419

Authorization number from credit company is invalid

420

Application error - customer specific

421

More than 4 days passed since charge transaction

422

The card is in customer`s negative list - previous chargeback

423

The card failed the fraud detection test

424

A failure occurred in the fraud detection test

425

Failed to get response from external server

Please contact System Administration

426

Failed to find external server details for sharing cardid

Please contact System Administration

427

There are details missing in the receipt

428

No matching transaction was found for printing the receipt

429

More than one matching transaction was found for printing the receipt

430

Kupa number is missing in the printing receipt request

431

X field is missing in the printing receipt request

432

Unknown request sent by Kupa for printing the receipt

433

The transaction amount is above offline mode limits

The amount is above limit for offline transaction

434

J5 transactions are not permitted in offline mode

Cannot make J5 transaction in offline mode

441

Refund total is different from original transaction

444

Application Error

Please contact System Administration

449

Invalid discount amount

450

Inactive card

451

This card does not exist

452

No privileges found for sharing cardid

Please contact System Administration

453

Sharing external cardId is not allowed

Please contact System Administration

454

Sharing internal cardId is not allowed

Please contact System Administration

455

merchant does not support sessionId

Please contact System Administration

456

merchant session timeout

Please contact System Administration

457

Error creating sessionId

Please contact System Administration

458

Duplicate transactions

459

Missing parameter orgUid/cgUid

460

Original transaction was not found

461

Refusal (manual phone approval is not possible for this card)

462

Wrong value in header

463

More than one original transaction was found

464

No Authorization to run the billing Id

470

for notification transactions - you must be sent informativeIndication field

471

request must contain at least one condition

499

This card is not permitted for this terminal

Please contact System Administration

500

TransmitId was not found

transmitId was not found

501

Terminal cannot be retransmitted. please call support

502

Terminal is currently in transmit. cannot make another transmit

503

Terminal cannot be retransmitted. there was no transmit failure

504

Cannot transmit. there was a transmit failure. please try to reTransmit

505

Modem Closed Please wait

Please contact System Administration

506

Phone Not Connected

507

Trying again

508

Number of Bad lines in Neg

Please contact System Administration

509

Old Neg file cannot be opened

Please contact System Administration

510

Old Del file cannot be opened

Please contact System Administration

511

Old Add file cannot be opened

Please contact System Administration

512

Add and Del size differ

Please contact System Administration

513

Cannot Open Temp neg

Please contact System Administration

514

Bad Neg file

Please contact System Administration

515

for future use

516

Not Authorised

517

Could not connect trying Backup line

518

Could not connect

519

Ashrait EMV decision - general error

Please contact System Administration

520

Ashrait EMV decision - transaction is not permitted

Please contact System Administration

521

Card exists already in NEG

522

Card Does Not exists in NEG

523

Cannot Open file

524

Disconnected in Parameters

525

Disconnected in Transactions

526

Disconnected in Neg

527

Cannot Delete file

528

Transmit stoped without an error code

529

Unable to begin new transmission due to many transmission process

530

Transmit file does not match expected number of transactions

Please contact System Administration

531

Disconnected in Transmit

532

Prod port used of test terminal

Please contact System Administration

533

Error in transmit

534

Transmit exceeds allowed batches per transmit

Please contact System Administration

550

Transmit service - error parsing GW request

Please contact System Administration

551

transmit service - error starting flow

Please contact System Administration

552

Transmit service - transmit_log not in status 0

Please contact System Administration

553

Transmit service - error getting transactions from DB

Please contact System Administration

554

Transmit service - error creating transactionData

Please contact System Administration

555

Transmit service - error creating 1402 messages

Please contact System Administration

556

Transmit service - error sending or creating request to BP

Please contact System Administration

557

Transmit service - error updating transmit log

Please contact System Administration

558

Acquirer error - terminal does not exist

Please contact System Administration

559

Transmit service - received negative checksum from SHVA for transactions transmit

Please contact System Administration

681

MPI Authentication Failed

682

MPI Transaction validation failed

683

MPI Invalid request or post parameters

684

MPI CG Gateway returned an error

685

MPI Error accessing the CG Gateway

686

MPI Internal Server Error

687

MPI Transaction has expired (timeout)

688

MPI Transaction already submitted

689

MPI Transaction not found (used for reports)

690

Too many processes

too many processes

691

No process found - no files found

no process found - no files found

692

Process id was not found

693

SHVA error - data mismatch between terminal and SHVA

Please contact System Administration

694

SHVA error - errors in STANDIN

Please contact System Administration

695

SHVA / Ashrait error - acquirer/issuer permissions

Please contact System Administration

696

PinPad device error

Please contact System Administration

697

Ashrait decision - validation of SHVA files

Please contact System Administration

698

SHVA error - permissions missing for credit type

Please contact System Administration

699

SHVA error - permissions missing for card type

Please contact System Administration

700

Error - request details invalid

Please contact System Administration

701

SHVA error - message validation error

Please contact System Administration

831

Terminal is not permitted to clear that currency

850

Error in Mpos module

851

Error in Pos module

852

Host already exists in Mpos

853

Request was not done

854

General network error

855

Error while copying terminal files

856

Pos cannot transmit local approved transactions

857

Error during downgrade. There are transactions waiting for transmission

858

Error during downgrade. Cannot find application backup file

859

Error during downgrade. Cannot find upgrade file

900

transaction blocked due to no liability shift

901

3DS is not enabled for this terminal

902

3DS is not enabled for this card brand

903

Could not find a matching 3DS Lookup (J107) Transaction

904

Duplicate 3DS transaction

910

Cannot add EMD Item.Original EMD transaction was not found

911

EMD item was already been refunded in the past

912

EMD item was already been canceled in the past

913

Cannot refund EMD item - call support

914

Cannot cancel EMD item - call support

915

General problem in EMD item management - call support

916

Sum amount of total EMD items is more than amount of original EMD transaction

917

EMD item currency must be identical to original EMD transaction currency

918

Duplicate EMD item.Ticket number already exist

919

EMD item not exist

920

EMD transaction was already been fully refunded - Cannot add EMD item

921

EMD transaction was already cancelled - Cannot add EMD item

988

No Authorization to run the billing id

997

Could not find terminal for conversion

1001

Refer to Card Issuer

1002

Refer to Card Issuer-special condition

1003

Invalid Merchant

1004

Pick up card

1005

Do not honour

1006

Error

1007

Pick up card

1009

Request in progress

1012

Invalid Transaction

1013

Invalid Amount

1014

Invalid card number

1019

Re-enter transaction

1021

No action taken

1030

Format Error

1041

Lost card pick up

1043

Stolen card pick up

1051

Not sufficient funds

1052

No checking account

1053

No savings account

1054

Expired card

1055

PIN incorrect

1057

Transaction not allowed for cardholder

1058

Transaction not allowed for merchant

1061

Exceeds withdrawal amount limit

1062

Restricted card

1063

Security violation

1065

Activity count limit exceeded

1075

PIN tries exceeded

1077

Inconsistent with original

1078

It is not authorized to clear this transaction

1081

Validation type not supported

1082

Transaction type not supported

1083

Card type not supported

1084

Pre-authorisation time too great

1086

Cannot verify PIN

1091

Issuer unavailable

1092

Invalid receiving institution id

1093

Transaction violates law

1094

Duplicate transaction

1096

System malfunction

1099

No Communication to bank Proxy

1102

Capture was already done per specified authorize deal

1103

Bank timeout

1104

Bank proxy timeout

1105

Capture total amount is higher than authorization amount

1106

Original authorization was not found

1163

batchsettlement action error

batch settlement action error

1164

save transactionid action error

1165

get settlement status action error

1166

update transmit status action error

1167

file validator action error

1168

build host file action error

1169

check transmitted file size action error

1170

transmit settlement file action

1200

Unable to transmit - exceeded a daily quota

1201

No transactions to transmit

1202

Missing parameter in transmit request

1710

Invalid Merchant

1803

Call Issuer

1804

Deny

1809

Invalid merchant

1810

Invalid amount

1811

Invalid account

1812

Issuer not available

1815

Requested function not supported

1822

Invalid card security code

1836

Expired Card

1883

Invalid currency code

1887

Deny — New card issued

1888

Deny — Account canceled

1889

Deny — Canceled or Closed Merchant

1890

Deny — Pick up card

1907

The customer has not yet confirmed payment for this transaction

2001

Amount error

2002

Amount is more than established service limit

2003

Call for Assistance

2004

Check is OK but cannot be converted

2005

Declined

2006

Declined - Do Not Honor. Failed Negative Check - Unpaid Items

2007

Declined - General System Error / Host Busy

2008

Duplicate Check Number

2009

Expired Card

2010

Invalid PIN

2011

Invalid Card

2012

Invalid Terminal ID

2013

Invalid Routing/Transit Number

2014

Invalid Merchant Nbr

2015

Invalid SE Number

2016

Invalid Data Submitted or Void Transaction

2017

MICR Read Error

2018

Must settle POS Device - batch is over 7 days old

2019

General System Error

2020

Please retry/ reenter transaction

2021

Record not found on Elavon

2022

Request Exceeds Balance

2023

Call for Assistance

2024

Invalid request

2025

Too Many Checks (over Limit)

2026

Refer to Issuer

2027

Refer to Issuer

2028

Do Not Honor. Declined CVV2 Mismatchailure

2029

Pick up card

2030

General System Error / Host Busy (Gift Card)

2031

Invalid Card (Gift Card)

2032

Invalid Terminal ID (Gift Card)

2033

Transaction Amount Error (Gift Card)

2034

Gift Card has already been activated

2035

Request Exceeds Balance (Gift Card)

2036

Cannot Load the Gift Card Amount Specified

2037

Gift Card Cannot be Reloaded

2038

Gift Card has not been previously activated

2039

Call for Assistance (Gift Card)

2040

General System Error / Host Busy (Gift Card)

2171

Blocked due to ECI downgrade

2200

Unsupported Message Type

Unsupported message type

2201

Unable to handle message type at this time

2202

Unsupported Message Version

Unsupported message version

2203

Invalid xml format

2204

Empty request

2205

Unable to locate merchant configuration

2206

Error processing message request

2207

Error processing cg3dsPaRes

2208

Missing or invalid cg3dsPaRes

2209

Card type and message type mismatch

2210

Error validating processor id value

2211

Error validating merchant id value

2212

Merchant not active

2213

Error validating message - transaction id is empty

2214

Error parsing cg3dsPaRes message elements

2215

Error validating amount

2216

System error - call support

2217

Error processing lookup request

2218

Error during 3ds authentication

2219

Error persisting lookup information

2220

Error persisting cg3dsPaRes information

2221

Error persisting 3D Secure authentication information

2222

Error persisting VERes information

2223

Error persisting PAReq information

2224

Error persisting VEReq information

2225

Payment initiative not supported

2230

Cannot verify cg3dsPaRes - see status of cg3dsSignatureVerification

2300

Not allowed

2301

Invalid card number

2302

Invalid card security code

2303

Invalid AVS fields

2304

Card holder missing

2305

Invalid amount

2306

Unsupported currency

2307

Invalid merchant account

2308

Internal error

2309

Billing address problem (City)

Unable to process your request. Please try later

2311

Billing address problem (Street)

Billing address problem (City)

2312

Billing address problem (HouseNumberOrName)

Billing address problem (Street)

2313

Billing address problem (Country)

Billing address problem (HouseNumberOrName)

2314

Billing address problem (StateOrProvince)

Billing address problem (Country)

2315

Billing address problem (Country)

Billing address problem (StateOrProvince)

2316

Refused

2317

Payment details are not supported

5001

Redirect the card holder to the issuer page for additional authentication

9689

Maximal length for the parameter passportNumber is

9860

Field user is mandatory

9861

Missing configuration

cancelDeal - Cancel transaction before settlement
refundDeal - Refund transaction after settlement
transmitTerminal - Manual settlement transmission

Notes

Amount Format: Always use cents/agorot (1000 = 10.00)
Card Requirements: cardNo must be accompanied by cardExpiration
Pre-auth Expiry: Pre-authorizations expire after 7-30 days (issuer-dependent)
Token Format: 16 digits with the last 4 matching the original card
Test Cards: Use 4111111111111111 in a sandbox environment
Settlement: Transactions settle during nightly batch (typically 11:00 PM Israel time)

PreviouscancelDeal NextgetSessionId

Last updated 3 months ago

Was this helpful?

Good afternoon

Overview

Use cases

Request structure

Endpoint

Request parameters

XML payload structure

Command parameters

Required parameters

Card data parameters

Payment page parameters

Installments parameters

3D-Secure parameters

Business logic parameters

Advanced control parameters

Validation types reference

Transaction type & validation combinations

Response structure

Success response

Error response

Response fields

Root response fields

doDeal section fields

acquirerData section fields

ashraitEmvData section fields

Code examples

Response codes

Common response codes

All response codes

Related commands

Notes