PagSeguro Payment Integration

About PagSeguro :

PagSeguro is a financial services and digital payments company based in São Paulo, Brazil and incorporated in the Grand Cayman, Cayman Islands. Founded in 2006, the company primarily offers payment processing software for e-commerce websites and mobile applications, and point of sale terminals.

Implemented Features:

Feature	Level of Support
Sale (Auth+Capture)	Implemented
Capture	Implemented
Credit	Implemented

Authentication and Security Credentials:

• Store ID
• API Key

Supported Parameters:

Key Name	Format	Mandatory	Descriptions
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.customerIP	Numerical	Optional	Customer’s IP Address
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.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.address	Alphanumeric	Optional	Customer’s Shipping Address
pxyCustomerInfo.shippingLocation.address2	Alphanumeric	Optional	Secondary 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

API Endpoint URL:

https://[HPCI_API_HOSTENAME]/iSynSApp/paymentAuth.action

API Request Body:

pxyCreditCard.creditCardNumber=411111..........&pxyOrder.orderItems[0].itemPrice=10.00&pxyCustomerInfo.billingLocation.city=Rio+de+Janeiro&pxyOrder.orderItems[0].itemQuantity=1&pxyOrder.orderItems[0].itemDescription=Item+Description+1&pxyOrder.orderItems[0].itemTaxable=N&userPassKey={API PASSKEY]&pxyCustomerInfo.billingLocation.address2=31&pxyTransaction.txnAmount=10.00&pxyTransaction.txnComment=New+Sa54&pxyCreditCard.cardCodeVerification=134&pxyTransaction.txnPayName=DEF_PagSeguro&pxyTransaction.merchantCompanyName=Bold&apiVersion=1.0.1&pxyCustomerInfo.customerIP=172.0.0.1&pxyCustomerInfo.billingLocation.firstName=Lid&pxyCustomerInfo.billingLocation.state=RJ&pxyCustomerInfo.billingLocation.country=BR&pxyCustomerInfo.billingLocation.phoneNumber=%2B5511991234556&pxyOrder.orderItems[0].itemName=Item-Name1&pxyTransaction.merchantProductName=PRODUCT+1234567&pxyCreditCard.expirationMonth=03&pxyCustomerInfo.customerId=CCMAS581030784&userName=[API USERNAME]&pxyTransaction.txnCurISO=BRL&pxyCustomerInfo.billingLocation.zipCode=87030010&pxyCustomerInfo.email=ro%40pn.ca&pxyOrder.orderItems[0].itemId=Item-1-ADER45200923&pxyCustomerInfo.billingLocation.neighborhood=Janeiro&pxyCustomerInfo.officialDocNumber=53033315550&pxyCreditCard.expirationYear=2030&pxyOrder.orderItems[0].note1=digital&pxyCustomerInfo.billingLocation.lastName=Plon&pxyCustomerInfo.billingLocation.address=Rebel+St&apiType=pxyhpci&pxyTransaction.merchantRefId=ADER45200923&pxyCustomerInfo.billingLocation.addressNumber=2&pxyCustomerInfo.billingLocation.district=Rio+de+Janeiro