Rakuten Payment Integration

About Rakuten:

Rakuten pay a payment method that allows Rakuten members to pay for goods and services with their Rakuten ID. By introducing this type of payment, you are able to reach Rakuten members (approximately 116 million as of September 2016) with the strong consumer purchasing power. Reaching them is expected to significantly drive your sales growth.

Users of the Rakuten Pay (Online Payment) can easily and safely make payments by just entering their Rakuten ID and password. Also, they can earn and use Rakuten Super Points when making online purchases.

Implemented Features:

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

Authentication and Security Credentials:

• wp_id
• wp_password
• Service ID
• Service access 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”
pxyTransaction.txnComment	Alphabetical	Optional	Short comment
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.fax	Numerical	Optional	Billing Fax Phone Number
pxyCustomerInfo.billingLocation.companyName	Alphanumeric	Optional	Billing Company Name
pxyCustomerInfo.billingLocation.address	Alphanumeric	Optional	Customer’s 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

API Endpoint URL:

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

API Request Body:

apiVersion=1.0.1&apiType=pxyhpci&userName=[APIuserName]&userPassKey=[APIPassKey]&pxyCreditCard.creditCardNumber=[CreditCardToken]&pxyCreditCard.cardCodeVerification=[CVVToken]&pxyCreditCard.expirationMonth=[ExpiryMonth]&pxyCreditCard.expirationYear=[ExpiryYear]&pxyTransaction.txnCurISO=[Currency]&pxyTransaction.txnAmount=[Amount]&pxyTransaction.merchantRefId=[UniqueMerchantRefID]&pxyTransaction.txnPayName=[ProfileName]&pxyTransaction.txnComment=[ShortComment]&pxyCustomerInfo.billingLocation.firstName=[CustomerFirstName]&pxyCustomerInfo.billingLocation.lastName=[CustomerLastName]&pxyCustomerInfo.billingLocation.address=[BillingStreetAddress]&pxyCustomerInfo.billingLocation.city=[BillingCity]&pxyCustomerInfo.billingLocation.state=[State/Province]&pxyCustomerInfo.billingLocation.zipCode=[ZipCode/PostalCode]&pxyCustomerInfo.billingLocation.country=[Country]&pxyCustomerInfo.shippingLocation.firstName=[ShippingFirstName]&pxyCustomerInfo.shippingLocation.lastName=[ShippingLastName]&pxyCustomerInfo.shippingLocation.address=[ShippingStreetAddress]&pxyCustomerInfo.shippingLocation.city=[ShippingCity]&pxyCustomerInfo.shippingLocation.state=[ShippingState/Province]&pxyCustomerInfo.shippingLocation.zipCode=[ShippingZipCode/PostalCode]&pxyCustomerInfo.shippingLocation.country=[ShippingCountry]