apiVersion |
Numerical |
Required |
“1.0.1” |
apiType |
Alphabetical |
Required |
“pxyhpci” |
userName |
Alphanumeric |
Required |
API Username |
userPassKey |
Alphanumeric |
Required |
API PassKey |
pxyCreditCard.creditCardNumber |
Numerical |
Required |
HostedPCI Token Representing Credit Card |
pxy.CreditCard.cardCodeVerification |
Numerical |
Optional |
HostedPCI Token Representing CVV Code |
pxyCreditCard.expirationMonth |
Numerical |
Required |
Expiration month with 2 digits for example, for December use “12” |
pxyCreditCard.expirationYear |
Numerical |
Required |
Expiration year with 4 digits for example, for 2025, use “2025” |
pxyOrder.description |
Alphabetical |
Required |
Description of the order |
pxyOrder.taxAmount |
Numerical |
Required |
Tax amount |
pxyOrder.taxReference |
Numerical |
Required |
Sub-total of order |
pxyTransaction.txnFingerPrintData |
Alphanumeric |
Required |
Device Session ID |
pxyTransaction.txnInstallmentCount |
Numerical |
Required |
The number of installments |
pxyTransaction.txnCurISO |
Alphabetical |
Required |
3 letter ISO Currency Code for example, “USD” or “CAD” |
pxyTransaction.txnAmount |
Numerical |
Required |
Amount to Authorize, for example for $10.50 use 10.50 |
pxyTransaction.merchantRefId |
Numerical |
Required |
Merchant reference number can be order id or invoice id |
pxyTransaction.txnPayName |
Alphanumeric |
Required |
HostedPCI payment profile name, for example “DEF” |
pxyCustomerInfo.email |
Alphanumeric |
Required |
Customer’s Email Address |
pxyCustomerInfo.customerIP |
Numerical |
Required |
Customer’s IP Address |
pxyCustomerInfo.customerId |
Numerical |
Required |
Customer ID |
pxyCustomerInfo.sessionId |
Numerical |
Required |
Transaction Cookie |
pxyCustomerInfo.billingLocation.firstName |
Alphabetical |
Required |
Customer’s(Payer) First Name |
pxyCustomerInfo.billingLocation.lastName |
Alphabetical |
Required |
Customer’s(Payer) Last Name |
pxyCustomerInfo.billingLocation.phoneNumber |
Numerical |
Required |
Billing Phone Number |
pxyCustomerInfo.billingLocation.address |
Alphanumeric |
Required |
Customer’s(Payer) Billing Address |
pxyCustomerInfo.billingLocation.city |
Alphabetical |
Required |
Customer’s(Payer) Billing City |
pxyCustomerInfo.billingLocation.state |
Alphabetical |
Required |
Customer’s(Payer) Billing State or Province |
pxyCustomerInfo.billingLocation.zipCode |
Numerical |
Required |
Customer’s (Payer) Billing Zip Code or Postal Code |
pxyCustomerInfo.billingLocation.country |
Alphabetical |
Required |
Customer’s Billing Country |
pxyCustomerInfo.shippingLocation.firstName |
Alphabetical |
Required |
Customer’s (Buyer) First Name |
pxyCustomerInfo.shippingLocation.lastName |
Alphabetical |
Required |
Customer’s (Buyer) Last Name |
pxyCustomerInfo.shippingLocation.address |
Alphanumeric |
Optional |
Customer’s (Buyer) Shipping Address |
pxyCustomerInfo.shippingLocation.city |
Alphabetical |
Optional |
Customer’s (Buyer) Shipping City |
pxyCustomerInfo.shippingLocation.state |
Alphabetical |
Optional |
Customer’s Shipping State or Province |
pxyCustomerInfo.shippingLocation.zipCode |
Alphabetical |
Optional |
Customer’s Shipping Zip Code or Postal Code |
pxyCustomerInfo.shippingLocation.country |
Alphabetical |
Optional |
Customer’s Shipping Country |