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” |
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 |
Optional |
Customer’s Email Address |
pxyCustomerInfo.gender |
Alphabetical |
Optional |
Customer’s Gender |
pxyCustomerInfo.officialDocNumber |
Numerical |
Optional |
Official Document Number |
pxyCustomerInfo.billingLocation.firstName |
Alphabetical |
Optional |
Customer’s First Name |
pxyCustomerInfo.billingLocation.lastName |
Alphabetical |
Optional |
Customer’s Last Name |
pxyCustomerInfo.billingLocation.phoneNumber |
Numerical |
Optional |
Billing Phone Number |
pxyCustomerInfo.billingLocation.district |
Alphabetical |
Optional |
Billing District |
pxyCustomerInfo.billingLocation.addressNumber |
Numerical |
Optional |
Billing Address Street Number |
pxyCustomerInfo.billingLocation.address |
Alphanumeric |
Optional |
Customer’s Billing Address |
pxyCustomerInfo.billingLocation.address2 |
Alphanumeric |
Optional |
Secondary Billing Address |
pxyCustomerInfo.billingLocation.city |
Alphabetical |
Optional |
Customer’s Billing City |
pxyCustomerInfo.billingLocation.state |
Alphabetical |
Optional |
Customer’s Billing State or Province |
pxyCustomerInfo.billingLocation.zipCode |
Numerical |
Optional |
Customer’s Billing Zip Code or Postal Code |
pxyCustomerInfo.billingLocation.country |
Alphabetical |
Optional |
Customer’s Billing Country |
pxyCustomerInfo.shippingLocation.addressNumber |
Numerical |
Optional |
Shipping Address Street Number |
pxyCustomerInfo.shippingLocation.address |
Alphanumeric |
Optional |
Customer’s Shipping Address |
pxyCustomerInfo.shippingLocation.city |
Alphabetical |
Optional |
Customer’s 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 |
pxyOrder.itemDescription |
Alphabetical |
Optional |
Order Description |
pxyOrder.itemReference |
Numerical |
Optional |
Order Reference Number |
pxyOrder.itemId |
Numerical |
Optional |
Order item ID |
pxyOrder.itemName |
Alphabetical |
Optional |
Item Name |
pxyOrder.itemQuantity |
Numerical |
Optional |
Number of items |
pxyOrder.itemPrice |
Numerical |
Optional |
Item Price |
pxyOrder.unitCostInCents |
Numerical |
Optional |
Unit Price in Cents |
pxyOrder.totalCostInCents |
Numerical |
Optional |
Total Cost in Cents |