Redsys Rest Payment Integration
About Redsys Rest:
Redsys Rest services were integrated by HostedPCI in 2023, we support the following credit card processing features.
Implemented Features:
| Feature | Level of Support |
|---|
| Auth | Implemented |
| Sale (Auth+Capture) | Implemented |
| Capture | Implemented |
| Void | Implemented |
| Credit | Implemented |
| 3D Secure 2 | Implemented |
| Card On FIle | Implemented |
Authentication and Security Credentials:
- Username
- Password
- Terminal
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 |
| pxyCustomerInfo.billingLocation.tax1 | Numerical | Optional | Billing Tax 1 |
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]
Redsys Rest 3D Secure 2 Implementation
In order to implement 3D Secure 2, the Redsys Rest payment profile must include the 3DS OTP Notification URL during the payment profile setup.
| PARAMETER NAME | Possible VALUE |
|---|
| 3DS OTP Notification URL | https://ccframe.hostedpci.com/iSynSApp/appUserVerify3DResp!verifyResp.action |
3ds 2.0 Redsys Rest “verifyenroll” call
- In Order to implement ThreeDSecure 2.0 with Redsys Rest the following parameters are required.
- The table below contains the parameter required for the verifyenroll call.
| PARAMETERS | VALUES |
|---|
| pxyCustomerInfo.browserAcceptHeader | [browserAcceptHeader] |
| pxyCustomerInfo.browserUserAgentHeader | [browserUserAgentHeader] |
| pxyThreeDSecAuth.callMode | [reportall] |
| pxyTransaction.txnPayName | [3dsecProfileName] |
| pxyThreeDSecAuth.actionName | [verifyenroll] |
Redsys Rest 3DS 2 “verifyenroll” Request sample:
apiType=pxyhpci&apiVersion=1.0.1&pxyCreditCard.cardCodeVerification=200&pxyCreditCard.creditCardNumber=491800..........&pxyCreditCard.expirationMonth=01&pxyCreditCard.expirationYear=2028&pxyCustomerInfo.billingLocation.address=15+Main+St&pxyCustomerInfo.billingLocation.addressNumber=15&pxyCustomerInfo.billingLocation.city=Paris&pxyCustomerInfo.billingLocation.country=FR&pxyCustomerInfo.billingLocation.firstName=Test&pxyCustomerInfo.billingLocation.lastName=Name&pxyCustomerInfo.billingLocation.phoneNumber=4168351525&pxyCustomerInfo.billingLocation.zipCode=45784&pxyCustomerInfo.browserAcceptHeader=text%2Fhtml%2Capplication%2Fxhtml%2Bxml%2Capplication%2Fxml%3Bq%3D0.9%2C%2A%2F%2A%3Bq%3D0.8%2Capplication%2Fjson&pxyCustomerInfo.browserUserAgentHeader=Mozilla%2F5.0+%28Windows+NT+10.0%3B+Win64%3B+x64%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F71.0.3578.98+Safari%2F537.36&pxyCustomerInfo.customerIP=127.0.0.1&pxyCustomerInfo.customerId=hpcitest1&pxyCustomerInfo.email=hpt1%40mailtor.com&pxyDeviceInfo.colorDepth=24&pxyDeviceInfo.javaEnabled=false&pxyDeviceInfo.javaScriptEnabled=false&pxyDeviceInfo.language=en-US&pxyDeviceInfo.screenHeight=1250&pxyDeviceInfo.screenWidth=1320&pxyDeviceInfo.timezone=52&pxyOrder.description=Test+Order&pxyOrder.invoiceNumber=Order%3A+AD135111&pxyOrder.orderItems[0].itemDescription=Best&pxyOrder.orderItems[0].itemId=Item-1-AD135111&pxyOrder.orderItems[0].itemName=item&pxyOrder.orderItems[0].itemPrice=01&pxyOrder.orderItems[0].itemQuantity=1&pxyOrder.orderItems[0].itemTaxable=N&pxyOrder.totalAmount=01&pxyThreeDSecAuth.actionName=verifyenroll&pxyThreeDSecAuth.callMode=reportall&pxyTransaction.merchantRefId=AD135111&pxyTransaction.txnAmount=12&pxyTransaction.txnCurISO=EUR&pxyTransaction.txnPayName=DEF_RedsysRest&userName=%5BAPIUsername%5D&userPassKey=%3A%5BAPIUserPasskey%5D
Redsys Rest 3DS 2 “verifyenroll” Response:
pxyResponse.cardOnFileIssuerId=&pxyResponse.cardOnFileSettlementDate=&pxyResponse.declineSource=&pxyResponse.gatewaySubToken1=&pxyResponse.gatewaySubToken2=&pxyResponse.gatewaySubToken3=&pxyResponse.gatewayToken.fullNativeResp=&pxyResponse.gatewayToken.status=&pxyResponse.gatewayToken=&pxyResponse.macCode=&pxyResponse.macDescription=&pxyResponse.mappedParams=txnResponse.ccTypeEst%3DVISA&pxyResponse.merchantRefId=AD135111&pxyResponse.processorRefId=AD135111&pxyResponse.processorType=redsysrestResponse&pxyResponse.responseAVS1=&pxyResponse.responseAVS2=&pxyResponse.responseAVS3=&pxyResponse.responseAVS4=&pxyResponse.responseCVV1=&pxyResponse.responseCVV2=&pxyResponse.responseStatus.description=0&pxyResponse.responseStatus.name=&pxyResponse.responseStatus.reasonCode=&pxyResponse.responseStatus=3dsecure&pxyResponse.threeDSARS=&pxyResponse.threeDSAcsTxnId=&pxyResponse.threeDSAcsUrl=https%3A%2F%2Fsis-d.redsys.es%2Fsis-simulador-web%2FauthenticationRequest.jsp&pxyResponse.threeDSCAVV=&pxyResponse.threeDSDDCPageData=&pxyResponse.threeDSDDCUrl=&pxyResponse.threeDSECI=&pxyResponse.threeDSEnrolled=Y&pxyResponse.threeDSErrorDesc=&pxyResponse.threeDSErrorId=&pxyResponse.threeDSErrorSubId=&pxyResponse.threeDSMessageId=&pxyResponse.threeDSOrderId=AD135111&pxyResponse.threeDSPARequest=eyJ0aHJlZURTU2VydmVyVHJhbnNJRCI6IjkxMzVjMGQ0LTA3YWYtNDYzOC04ZGZhLTQxYWY3Y2YxZWY0OSIsImFjc1RyYW5zSUQiOiJkYjAwZmNiNy03ZmE0LTQzZWUtYjc0MC1hMjcxYmI3NTlmNDgiLCJtZXNzYWdlVHlwZSI6IkNSZXEiLCJtZXNzYWdlVmVyc2lvbiI6IjIuMS4wIiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1In0&pxyResponse.threeDSProtoVersion=2.1.0&pxyResponse.threeDSProvider=redsysrest&pxyResponse.threeDSReasonCode=&pxyResponse.threeDSReasonDesc=&pxyResponse.threeDSSessionId=&pxyResponse.threeDSTransactionId=9135c0d4-07af-4638-8dfa-41af7cf1ef49&pxyResponse.threeDSXid=&status=error
3ds 2.0 Redsys Rest “verifyresp” call
- If ‘verifyenroll’ was successful it will return parameters required for ‘verifyresp’ call.
- The table below contains parameters required to make the second auth call with Redsys Rest 3ds 2.0.
| PARAMETERS | VALUES |
|---|
| pxyThreeDSecAuth.authTxnId | [pxyResponse.threeDSTransactionId] – returned from the ‘verifyenroll’ call] |
| pxyTransaction.txnPayName | [3dPayProfileName] |
| pxyThreeDSecAuth.actionName | [verifyresp] |
| pxyThreeDSecAuth.protocolVersion | [pxyResponse.threeDSProtoVersion] – response from the verifyenroll call |
Redsys Rest 3DS 2 “verifyresp” Request sample:
apiType=pxyhpci&apiVersion=1.0.1&pxyCreditCard.cardCodeVerification=200&pxyCreditCard.creditCardNumber=491800...........&pxyCreditCard.expirationMonth=01&pxyCreditCard.expirationYear=2028&pxyCustomerInfo.billingLocation.address=15+Main+St&pxyCustomerInfo.billingLocation.addressNumber=15&pxyCustomerInfo.billingLocation.city=France&pxyCustomerInfo.billingLocation.country=FR&pxyCustomerInfo.billingLocation.firstName=Test&pxyCustomerInfo.billingLocation.lastName=Name&pxyCustomerInfo.billingLocation.phoneNumber=4168351525&pxyCustomerInfo.billingLocation.zipCode=45784&pxyCustomerInfo.browserAcceptHeader=text%2Fhtml%2Capplication%2Fxhtml%2Bxml%2Capplication%2Fxml%3Bq%3D0.9%2C%2A%2F%2A%3Bq%3D0.8%2Capplication%2Fjson&pxyCustomerInfo.browserUserAgentHeader=Mozilla%2F5.0+%28Windows+NT+10.0%3B+Win64%3B+x64%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F71.0.3578.98+Safari%2F537.36&pxyCustomerInfo.customerIP=127.0.0.1&pxyCustomerInfo.customerId=hpcitest1&pxyCustomerInfo.email=hpt1%40mailtor.com&pxyDeviceInfo.colorDepth=24&pxyDeviceInfo.javaEnabled=false&pxyDeviceInfo.javaScriptEnabled=false&pxyDeviceInfo.language=en-US&pxyDeviceInfo.screenHeight=1250&pxyDeviceInfo.screenWidth=1320&pxyDeviceInfo.timezone=52&pxyOrder.description=Test+Order&pxyOrder.invoiceNumber=Order%3A+AD135111&pxyOrder.orderItems[0].itemDescription=Best&pxyOrder.orderItems[0].itemId=Item-1-AD135111&pxyOrder.orderItems[0].itemName=item&pxyOrder.orderItems[0].itemQuantity=1&pxyOrder.orderItems[0].itemTaxable=N&pxyThreeDSecAuth.actionName=verifyresp&pxyThreeDSecAuth.authTxnId=%5Bverifyenroll%3ApxyResponse.threeDSTransactionId%5D&pxyThreeDSecAuth.callMode=reportall&pxyThreeDSecAuth.protocolVersion=%5Bverifyenroll%3ApxyResponse.threeDSProtoVersion%5D&pxyTransaction.merchantRefId=AD135111&pxyTransaction.txnAmount=12&pxyTransaction.txnCurISO=EUR&pxyTransaction.txnPayName=DEF_RedsysRest&userName=%5BAPIUsername%5D&userPassKey=%3A%5BAPIUserPasskey%5D
Redsys Rest 3DS 2 “verifyresp” Response:
pxyResponse.cardOnFileIssuerId=&pxyResponse.cardOnFileSettlementDate=&pxyResponse.declineSource=&pxyResponse.gatewaySubToken1=&pxyResponse.gatewaySubToken2=&pxyResponse.gatewaySubToken3=&pxyResponse.gatewayToken.fullNativeResp=&pxyResponse.gatewayToken.status=&pxyResponse.gatewayToken=0&pxyResponse.macCode=&pxyResponse.macDescription=&pxyResponse.mappedParams=txnResponse.ccTypeEst%3DVISA&pxyResponse.merchantRefId=AD135111&pxyResponse.processorRefId=AD135111&pxyResponse.processorType=redsysrestResponse&pxyResponse.responseAVS1=&pxyResponse.responseAVS2=&pxyResponse.responseAVS3=&pxyResponse.responseAVS4=&pxyResponse.responseCVV1=&pxyResponse.responseCVV2=&pxyResponse.responseStatus.description=0&pxyResponse.responseStatus.name=&pxyResponse.responseStatus.reasonCode=&pxyResponse.responseStatus=approved&pxyResponse.threeDSARS=&pxyResponse.threeDSAcsTxnId=&pxyResponse.threeDSAcsUrl=&pxyResponse.threeDSCAVV=&pxyResponse.threeDSDDCPageData=&pxyResponse.threeDSDDCUrl=&pxyResponse.threeDSECI=&pxyResponse.threeDSEnrolled=&pxyResponse.threeDSErrorDesc=&pxyResponse.threeDSErrorId=&pxyResponse.threeDSErrorSubId=&pxyResponse.threeDSMessageId=&pxyResponse.threeDSOrderId=&pxyResponse.threeDSPARequest=&pxyResponse.threeDSProtoVersion=&pxyResponse.threeDSReasonCode=&pxyResponse.threeDSReasonDesc=&pxyResponse.threeDSSessionId=&pxyResponse.threeDSTransactionId=9135c0d4-07af-4638-8dfa-41af7cf1ef49&pxyResponse.threeDSXid=9135c0d4-07af-4638-8dfa-41af7cf1ef49&saleId=827249907&status=success