Transaction

Transaction

Transaction response Payload

Status

• transactionStatus TransactionStatus
  The transaction status. This value is populated only if the request was COMPLETED.
  (1) Show values

  1. TransactionStatus

     The transaction's current status

     • AUTHORIZED Authorization request was approved, but funds are held until explicitly completed by a capture request or canceled by void request.
     • CAPTURED Transaction is approved and captured on the batch file
     • DECLINED Transaction declined
     • SETTLED Transaction is approved and settled with the processor.
     • DEPOSITED Transaction is approved and deposited to a gateway.
     • VOIDED Transaction that was canceled with void request.
     • INFORMATIVE Transaction is declined but has an informative record to report to the processor according to specifications.

  2. END

• hostErrorCode int
  The host returns an optional error code. This value is populated only if the request is COMPLETED or the transaction is queried.

• hostErrorMessage string
  The host returns an optional human-readable error message. This value is populated only if the request is COMPLETED or the transaction is queried.

• transactionTime string
  The timestamp for this transaction was last updated in RFC 3339 format.

• onlineCardValidationError boolean
  Indicates whether any error occurred during the online card validation process. If set to true, an error was encountered during validation; otherwise, the validation completed without error.

Transaction info

• transactionType TransactionType
  The type of transaction for which funds were requested.
  (1) Show values

  1. TransactionType

     Describe the type of transaction. Some of the values are used as input only and affect only the TransactionStatus

     • SALE Sale transaction.
     • REFUND Refund Transaction.
     • AUTH_ONLY Authorization only for a SALE transaction. Upon CAPTURE, this type becomes a SALE transaction.
     • CASH - TBD
     • CASHBACK - Cashback transaction.
     • VOID - Void transaction. This transaction type acts as an operation on an already existing transaction. The registered type is not changed; upon success, only the transaction status is set to VOIDED.
     • CAPTURE - Capture an AUTH_ONLY transaction. This transaction type acts as an operation to an already AUTH_ONLY existing transaction. Upon success, the registered type is changed to SALE and the status to CAPTURED.
     • FORCED - Forced transaction
     • TOP_UP - Top-Up transaction for prepaid cards
     • DISCHARGE - Discharge all funds on prepaid card
     • BALANCE - Balance inquiry request. This transaction is not registered or cached on the device.

  2. END

• referenceId string
  A unique string that identifies the transaction on the client side. The client generated this value. If the transaction type is VOID or CAPTURE, the value represents the original transaction referenceId as provided.

• amount long
  The amount of money to authorize this transaction, not including tipAmount. The amount is specified in the smallest denomination of the applicable currency. See Monetary Amount

• currency int
  The currency code of all amount fields that relate to the transaction. The currency is specified as an ISO numeric code. See Monetary Amount

• cashAmount long
  The amount of money that is cashed back to the cardholder. The amount is specified in the smallest denomination of the applicable currency. See Monetary Amount

• tipAmount long
  The amount of money is designated as a tip. This amount is added to amount, and the summary of the two will be the totalAmount the cardholder will be charged. The amount is specified in the smallest denomination of the applicable currency. See Monetary Amount

• totalAmount long
  The total amount of money charged from the card. This amount is a summary of amount and tipAmount. The amount is specified in the smallest denomination of the applicable currency. See Monetary Amount

• transactionId string
  A unique ID (UID) is generated by the host to identify this transaction.

• authorizationNumber string
  The authorization code returned by the card issuer describes the authorization status. This value is populated only if the transaction was processed for online authorization.

• rrn string
  The Retrieval Reference Number generated by the credit card company is populated only if the transaction was processed for online authorization.

• systemTraceNumber string
  A number is generated by the host during the transaction execution to identify the transaction in the batch file.

• batchNo string
  An optional ID that represents the batch number this transaction was settled during settlement. This value is populated if the transaction status is SETTLED or a VOIDED or INFORMATIVE transaction was settled.

• cvvResponse CVVResponse
  A value that represents the response from the card issuer regarding the CVV input.
  (1) Show values

  1. CVVResponse

     The response returned from the issuer for the Card Verification Value (CVV) verification

     • NO_CVV Cvv not entered
     • CVV_ACCEPTED Cvv entered and valid
     • CVV_REJECTED Cvv entered and invalid
     • CVV_NOT_CHECKED Cvv entered and not checked

• cardHolderIdResponse CardholderIdResponse
  A value that represents the response from the card issuer regarding the Cardholder ID input.
  (1) Show values

  1. CardholderIdResponse

     The response returned from the issuer for the Cardholder ID verification.

     • NO_CARDHOLDER_ID Cardholder ID not entered
     • CARDHOLDER_ID_ACCEPTED Cardholder ID entered and valid
     • CARDHOLDER_ID_REJECTED Cardholder ID entered and invalid
     • CARDHOLDER_ID_NOT_CHECKED Cardholder ID entered and not checked

Deposit info

• gatewayToken string
  If the transaction is deposited, this field contains the card token assigned by the gateway.
  It is populated when the transaction status is DEPOSITED or when a VOIDED or INFORMATIVE transaction has been deposited.
  This field is returned only if supported by the gateway.

• depositId string
  An optional ID representing the deposit acknowledgment number in a gateway with a remote batch file.
  This value is populated when the transaction status is DEPOSITED or when a VOIDED or INFORMATIVE transaction has been deposited.
  This field is returned only if supported by the gateway.

• addendumResponse string
  This field is returned in the response when provided by the processor or gateway.
  It reflects the addendum data sent by the gateway, not necessarily what was included in the request.

Device info

• appVersion string
  The current application version.

• terminalId String
  The terminal ID.

• terminalNo int
  The sequence number of the terminal that belongs to this terminal ID.

Card Details

• panEntryMode PanEntryMode
  The PAN entry mode for this transaction
  (1) Show values

  1. PanEntryMode

     This enumerator describes the PAN entry mode (The way the card was detected) according to Ashrait specifications.

     • MSR Card detected with magnetic reader upon swipe
     • MSR_CONTACTLESS Card detected with RF reader upon tap and without authentication between the smart card and the smart reader
     • CONTACTLESS Card detected with RF reader upon tap
     • MOBILE_WALLET Card detected with RF reader upon tap with a mobile phone or smartwatch
     • EMV Card detected with ICC reader upon insertion to slot
     • MOTO Card was detected upon manual entry of the PAN, which was received through telephone or mail.
     • SIGNATURE_ONLY Card was detected upon manual entry of the PAN. The card was present during the manual entry.
     • FALLBACK_CHIP_ERROR Card detected with magnetic reader upon swipe after the card insertion failed to operate
     • FALLBACK_EMPTY_CANDIDATE_LIST Card was detected by a magnetic reader upon swipe after the smart reader couldn't find any matching AID with the inserted card.
     • OTHER Other, should be never received

• cardName string
  A name that describes the card used to request the funds. This value is dynamic and sometimes can be retrieved from the ICC and include Hebrew characters.

• maskedPan string
  The PAN on the card used to request the funds is masked with Xs for security reasons. The value represents the actual length of the PAN.

• panSuffix string
  The last four digits of the PAN on the card were used to request the funds.

• acquirer int
  The detected card acquirer ID.

• acquirerName string
  The detected card acquirer name this value is human readable and may contain Hebrew characters.

• acquirerBusinessNumber string
  The business number of the credit card acquiring company for the detected card.

• acquirerPhoneNumber string
  The detected card acquirer's phone number. This value is used when telephony authorization is needed.

• issuer int
  The detected card issuer ID.

• issuerName string
  The detected card issuer name for this value is human-readable and may contain Hebrew characters.

• brand int
  The detected card brand ID.

• brandName string
  The detected card brand name this value is human readable and may contain Hebrew characters.

• isClub boolean
  The detected card is club card.

• isPrepaid boolean
  The detected card is prepaid card.

• isDebitCard boolean
  The detected card is debit card (AKA Immediate)

Credit Terms

• creditTerms CreditTerms
  The credit terms used for this transaction.
  (1) Show values

  1. CreditTerms

     Transaction Credit terms. Only for Israel Credit Card transaction

     • REGULAR Regular credit terms
     • SPECIAL Special Credit terms (Isracredit/ Adif30)
     • IMMEDIATE Immediate credit
     • CREDIT Credit transaction. The amount is equaled evenly by the Card issuer after the sale.
     • INSTALLMENTS Installments transaction. The amount is divided by the merchant during the sale.

• noOtherInstallmentPayments int
  The number of additional payments when using the INSTALLMENTS credit term. This number doesn't include the first payment. For example, for a transaction of four payments in installment terms, this value equals 3. This value is populated only if creditTerms is INSTALLMENTS.

• firstPayment long
  The amount of money charged on the first payment on the INSTALLMENTS transaction. The amount is specified in the smallest denomination of the applicable currency. See Monetary Amount. This value is populated only if creditTerms is INSTALLMENTS.

• otherPayment long
  The amount of money charged on the other payments (noOtherInstallmentPayments) for the INSTALLMENTS transaction. The amount is specified in the smallest denomination of the applicable currency. See Monetary Amount. This value is populated only if creditTerms is INSTALLMENTS.

• noCreditPayments int
  The number of credit payments when using the CREDIT credit term. This number represents the total number of credit payments. The card issuer divides. This value is populated only if creditTerms is CREDIT.

• paymentLinkedTo PaymentLinked
  The credit terms linking used for this transaction. This value is populated only if creditTerms is INSTALLMENTS or CREDIT
  (1) Show values

  1. PaymentLinked

     Link Credit / Installment payment

     • NONE None
     • INDEX To Index AKA צמוד מדד
     • FOREIGN_CURRENCY to Foreign currency

Update Info

• allowedCreditTerms CreditTerms[]
  An array with all allowed credit terms for this request with the read card. This value is populated only when the state is UPDATE.

• maxNumberInstallmentPayments int
  The highest number of payments allowed when choosing noOtherInstallmentPayments for INSTALLMENTS credit terms includes the first payment. For example, if it equals 18, the maximum value for noOtherInstallmentPayments is 17. This value is populated only when the state is UPDATE.

• maxNumberCreditPayments int
  The highest number of payments allowed when choosing noCreditPayments for CREDIT credit terms. This value is populated only when the state is UPDATE.

• minNumberCreditPayments int
  The lowest number of payments allowed when choosing noCreditPayments for CREDIT credit terms is. This value is populated only when the state is UPDATE.

• minAmountPerCreditPayments int
  The lowest amount of money allowed per payment when choosing CREDIT for credit terms is. The amount divided by noCreditPayments must be greater than this value. This value is populated only when the state is UPDATE.

• cvvRequired boolean
  Is CVV required according to host identification. This value is populated only when the state is UPDATE.

• cardHolderIdRequired boolean
  Is CardHolderId required according to host identification. This value is populated only when the state is UPDATE.

Card Balance

• balanceMessage string
  The balance of the card as received from the issuer. This value is represented as a string.

• balanceMustPrint boolean
  Indicates whether the balance message must be printed for the cardholder according to the specifications.

• balanceMustShow boolean
  Indicates whether the balance message must be shown to the cardholder according to the specifications.

Associated Data

• shiftId string
  An optional field associated with this transaction

• dealId string
  An optional field associated with this transaction

Receipts

• cardHolderReceipt Receipt
  The cardholder receipt copy for the transaction. This value is populated only if the transaction is approved
  (1) Show values

  1. Receipt

     Receipt object for a transaction. The receipt language and fields vary according to the Host specification.

     • language string
       Receipt language HEBREW or ENGLISH

     • fields ReceiptField[]
       The fields in an array. The order of the array is mandatory and can't be modified
       (1) Show values

       1. ReceiptField

          A field in the receipt for an Ashrait transaction

          • id string
            The ID of the field. This field is an enumerator and should not be printed on a copy of the receipt.

          • key string
            The name of the field to print. This value is human-readable and may contain Hebrew characters. This field must not be modified and is delivered as mentioned in host specifications.

          • value string
            The value of the field to print. This value is human-readable and may contain Hebrew characters. This field must not be modified and is delivered as mentioned in host specifications.

          Possible ID's

          id	Note	English Title	Hebrew Title
          POS_NAME		POS Name	שם מסוף
          POS_NUM		POS Num	מס מסוף
          SOFTWARE_VERSION		Version	גרסת תוכנה
          MERCHANT_ID		Merchant ID	מס עסק
          TRAN_DATE_TIME		Date and Time	תאריך ושעה
          CARD_NAME		Card Name	כרטיס
          CARD_NUMBER		Card Number	מס כרטיס
          POS_TRAN_ID		POS Tran ID	מס שובר
          UID		UID	UID
          RRN		RRN	RRN
          TRAN_TYPE		Tran Type	סוג עסקה
          ISSUER_AUTH_NUM		Issuer Auth Num	מס אישור
          AUTH_BY		Authorized by	גורם מאשר
          ENTRY_MODE		Entry Mode	אופן ביצוע
          CREDIT_TERMS		Credit Terms	סוג אשראי
          AMOUNT		Amount	סכום
          CURRENCY		Currency	מטבע
          INSTALLMENT_NUM		Installment	מס תשלומים
          FIRST_INSTALLMENT		First Installment	תשלום ראשון
          ADD_INSTALLMENT		Add. Installment	מס תשלומים נוספים
          ADD_INSTALLMENT_AMOUNT		Add. Installment Amount	תשלום נוסף
          DEFER		Defer	דחוי
          DUE_DATE		Due Date	חיוב במועד
          TIP		TIP	טיפ
          CASHBACK_AMOUNT		Cashback	סכום מזומן
          TOTAL_AMOUNT		Total Amount	סכום עם מזומן וטיפ
          VERIFIED_BY_PIN	This field has no value	Verified by PIN	Verified by PIN
          VERIFIED_BY_DEVICE	This field has no value	Verified by Device	Verified by Device
          AID		AID	AID
          ATC		ATC	סידורי ש
          PSN		PSN	סידורי כ
          TSI		TSI	TSI
          ARC		ARC	ARC
          TVR		TVR	TVR
          DSP_BALANCE		Balance	יתרה

       2. END

     • collectSignature boolean
       Should collect a signature from the card-holder on this copy

     • collectTelephoneNo boolean
       Should collect phone number from the card-holder on this copy

• merchantReceipt Receipt
  The merchant receipt copy for the transaction. This value is populated only if the transaction is approved
  (1) Show values

  1. Receipt

     Receipt object for a transaction. The receipt language and fields vary according to the Host specification.

     • language string
       Receipt language HEBREW or ENGLISH

     • fields ReceiptField[]
       The fields in an array. The order of the array is mandatory and can't be modified
       (1) Show values

       1. ReceiptField

          A field in the receipt for an Ashrait transaction

          • id string
            The ID of the field. This field is an enumerator and should not be printed on a copy of the receipt.

          • key string
            The name of the field to print. This value is human-readable and may contain Hebrew characters. This field must not be modified and is delivered as mentioned in host specifications.

          • value string
            The value of the field to print. This value is human-readable and may contain Hebrew characters. This field must not be modified and is delivered as mentioned in host specifications.

          Possible ID's

          id	Note	English Title	Hebrew Title
          POS_NAME		POS Name	שם מסוף
          POS_NUM		POS Num	מס מסוף
          SOFTWARE_VERSION		Version	גרסת תוכנה
          MERCHANT_ID		Merchant ID	מס עסק
          TRAN_DATE_TIME		Date and Time	תאריך ושעה
          CARD_NAME		Card Name	כרטיס
          CARD_NUMBER		Card Number	מס כרטיס
          POS_TRAN_ID		POS Tran ID	מס שובר
          UID		UID	UID
          RRN		RRN	RRN
          TRAN_TYPE		Tran Type	סוג עסקה
          ISSUER_AUTH_NUM		Issuer Auth Num	מס אישור
          AUTH_BY		Authorized by	גורם מאשר
          ENTRY_MODE		Entry Mode	אופן ביצוע
          CREDIT_TERMS		Credit Terms	סוג אשראי
          AMOUNT		Amount	סכום
          CURRENCY		Currency	מטבע
          INSTALLMENT_NUM		Installment	מס תשלומים
          FIRST_INSTALLMENT		First Installment	תשלום ראשון
          ADD_INSTALLMENT		Add. Installment	מס תשלומים נוספים
          ADD_INSTALLMENT_AMOUNT		Add. Installment Amount	תשלום נוסף
          DEFER		Defer	דחוי
          DUE_DATE		Due Date	חיוב במועד
          TIP		TIP	טיפ
          CASHBACK_AMOUNT		Cashback	סכום מזומן
          TOTAL_AMOUNT		Total Amount	סכום עם מזומן וטיפ
          VERIFIED_BY_PIN	This field has no value	Verified by PIN	Verified by PIN
          VERIFIED_BY_DEVICE	This field has no value	Verified by Device	Verified by Device
          AID		AID	AID
          ATC		ATC	סידורי ש
          PSN		PSN	סידורי כ
          TSI		TSI	TSI
          ARC		ARC	ARC
          TVR		TVR	TVR
          DSP_BALANCE		Balance	יתרה

       2. END

     • collectSignature boolean
       Should collect a signature from the card-holder on this copy

     • collectTelephoneNo boolean
       Should collect phone number from the card-holder on this copy