Skip to main content

Hyp Yaad Pay PCI

This page provides an overview of the payments methods provided by the Hyp Yaad Pay PCI adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating Hyp Yaad Pay PCI within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY's API.

Payment Methods

Payment MethodTransaction FlowsTransaction Types
Creditcardpayment.js, iFrame FormRegister, Debit, Preauthorize, Capture, Refund, Void

parameters for Register Preauthorize, Debit

ParameterRequiredValueDescription
merchantMetaDatatrueMerchant meta data
additionalId1truecontains the invoice number
item.identificationconditionalItems are not required, but when adding Items, this field is mandatory
item.nameconditionalItems are not required, but when adding Items, this field is mandatory
item.quantityconditionalItems are not required, but when adding Items, this field is mandatory
item.priceconditionalItems are not required, but when adding Items, this field is mandatory
extraData.Fild1falsestringOptional filled for the website owner
extraData.Fild2falsestringOptional filled for the website owner
extraData.Fild3falsestringOptional filled for the website owner
extraData.sendemailfalseaccepts [True, False], default : FalseSend the customer a payment confirmation by email
extraData.SendHeshfalseaccepts [True, False], default : Falsesend invoice in email
extraData.phonefalsestringphone number
extraData.sendHeshSMSfalseaccepts [True, False] default: FalseThe invoice send by SMS to cell parameter
extraData.EZ_langfalseaccepts [en, he] default: heLanguage of invoice and email
extraData.EZ_email_textfalseAdd additional text into the body of an email
extraData.EZ_commentfalseAdd additional text into the body of a invoice document
extraData.EZ_cc_emailsfalseAn array of valid cc emails the invoice will be sent to
extraData.EZ_vatfalsedefault = 0.17The invoice VAT if not supported the current VAT will be used (format: [1 = 1.00, 0 = 0.00])
extraData.EZ_descriptionfalseAdd additional description into the body of a invoice document
extraData.EZ_customer_crnfalseThe customer company number/ID/ etc… (BN Number) (Required by law when document value is greater than 5,000 ILS)
extraData.EZ_create_org_as_foreignfalseboolean (accepts [0,1]) default: 0Default 0.use when you have permission to create original documents in English or foreign currency.

parameters for Refund, Void

ParameterRequiredValeDescription
extraData.SendHeshfalseaccepts [True, False], default : Falsesend invoice in email