Bambora Rest Payment Integration
About Bambora:
Bambora Rest payment solution provides a RESTful API interface to a secure payment gateway. It enables businesses to accept and manage payments efficiently, create and store customer payment profiles for future transactions, and generate credit card tokens to help minimize PCI compliance requirements.
Implemented Features:
| Feature | Level of Support |
|---|
| Auth | Implemented |
| Sale (Auth+Capture) | Implemented |
| Capture | Implemented |
| Void | Implemented |
| Credit | Implemented |
| Gateway Tokenize | Implemented |
| Credentials on File | Implemented |
Authentication and Security Credentials:
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.address | Alphanumeric | Required | Customer’s Billing Address |
| pxyCustomerInfo.billingLocation.address2 | Alphanumeric | Optional | Secondary Billing Address |
| pxyCustomerInfo.billingLocation.city | Alphabetical | Required | Customer’s Billing City |
| pxyCustomerInfo.billingLocation.state | Alphabetical | Required | Customer’s Billing State or Province |
| pxyCustomerInfo.billingLocation.zipCode | Numerical | Required | Customer’s Billing Zip Code or Postal Code |
| pxyCustomerInfo.billingLocation.country | Alphabetical | Required | Customer’s Billing Country |
| pxyCustomerInfo.shippingLocation.firstName | Alphabetical | Optional | Customer’s First Name for Shipping |
| pxyCustomerInfo.shippingLocation.lastName | Alphabetical | Optional | Customer’s Last Name for Shipping |
| pxyCustomerInfo.shippingLocation.phoneNumber | Numerical | Optional | Shipping Phone Number |
| 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:
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]
Bambora Credentials on File
Credentials on FIle with Bambora can be set up during the Bambora Payment profile setup. In Order to set up the Beanstream payment profile as Card on File the parameter Card On File defaults needs to be set up as enable=Y;merInitReason=R. The parameter enable=Y tells the system to income the Credentials on the FIle process. The parameter merInitReason=R will set cardOnFileTxnType to R (Recurring). It can be overridden with the parameter listed below. Otherwise, the Card on FIle process is initiated based on the availability of CVV.
Bambora Credentials on File Override Parameters
| PARAMETERS | VALUES |
|---|
| pxyTransaction.cardOnFileTxnRef | [0 /1] – 1 for MIT transaction |
| pxyTransaction.cardOnFileTxnType | [C/R] – CIT or Reaccuring |
| pxyTransaction.cardOnFileIssuerId | [cardOnFile Issuer ID] |
Bambora Rest Gateway Tokenization
Parameters Required for Gateway Tokenization:
| PARAMETERS | VALUE |
|---|
| pxyCreditCard.creditCardNumber | [HostedPCI Token] |
| pxyCreditCard.cardCodeVerification | [HostedPCI CVV place holder] |
| pxyCreditCard.expirationMonth | [Credit Card expire month] |
| pxyCreditCard.expirationYear | [Credit Card expire year] |
| pxyTransaction.txnPayName | [Profile Name provided by HostedPCI] |
| pxyCustomerInfo.billingLocation.firstName | [Client’s first name as it appears on the card] |
| pxyCustomerInfo.billingLocation.lastName | [Client’s last name as it appears on the card] |
Gateway Tokenization API Call
Request:
pxyCreditCard.creditCardNumber=4111..........&apiVersion=1.0.1&userPassKey=[APIPasskey]&pxyCreditCard.expirationMonth=09&pxyCreditCard.expirationYear=2030&pxyCustomerInfo.billingLocation.lastName=Paul&pxyCustomerInfo.billingLocation.firstName=Test&userName=[APIUsername]&pxyCreditCard.cardCodeVerification=200&pxyTransaction.txnPayName=DEF_BAMBORAREST&apiType=pxyhpci
Response:
status=success&operId=&tokenId=583653439&mappedCC=4444000015201111&ccBIN=&pxyResponse.threeDSEnrolled=&pxyResponse.threeDSAcsUrl=&pxyResponse.threeDSErrorDesc=&pxyResponse.processorRefId=hpci-3378370464775&pxyResponse.processorType=anetResponse&pxyResponse.threeDSMessageId=&pxyResponse.threeDSSessionId=&pxyResponse.cardOnFileIssuerId=&pxyResponse.mappedParams=txnResponse.ccTypeEst%3DVISA&pxyResponse.threeDSARS=&pxyResponse.threeDSOrderId=&pxyResponse.gatewayToken.status=&pxyResponse.responseStatus.name=approved&pxyResponse.responseAVS2=&pxyResponse.responseStatus=approved&pxyResponse.gatewayToken=1516360471_TKNSEP_1514483575&pxyResponse.responseAVS1=&pxyResponse.responseAVS4=&pxyResponse.responseStatus.description=Successful.&pxyResponse.threeDSCAVV=&pxyResponse.responseAVS3=&pxyResponse.gatewayToken.fullNativeResp=&pxyResponse.threeDSXid=&pxyResponse.threeDSProtoVersion=&pxyResponse.responseStatus.reasonCode=&pxyResponse.threeDSPARequest=&pxyResponse.responseCVV1=&pxyResponse.threeDSECI=&pxyResponse.responseCVV2=&pxyResponse.fullNativeResp=%5B1%2C1%2C1%2CThis+transaction+has+been+approved.%2CAIIVUM%2CY%2C40056403397%2Cnone%2CTest+transaction+for+ValidateCustomerPaymentProfile.%2C0.00%2CCC%2Cauth_only%2C14105-110000002%2CTest%2CPaul%2C%2C12596+%26nbsp%3BWest+Bayaud+Ave%2CLakewood%2CCO%2C80228%2CUnited+States%2C%2C%2Cnull%40brandwise.com%2C%2C%2C%2C%2C%2C%2C%2C%2C0.00%2C0.00%2C0.00%2CFALSE%2Cnone%2C%2CP%2C2%2C%2C%2C%2C%2C%2C%2C%2C%2C%2C%2CXXXX1111%2CVisa%2C%2C%2C%2C%2C%2C%2C0UTM30HTGJV72DOA7R6TTKO%2C%2C%2C%2C%2C%2C%2C%2C%2C%2C%5D&pxyResponse.threeDSAcsPageData=&pxyResponse.gatewaySubToken2=1514483575&pxyResponse.threeDSTransactionId=&pxyResponse.gatewaySubToken1=1516360471&pxyResponse.gatewaySubToken3=&pxyResponse.merchantRefId=hpci-3378370464775&pxyResponse.threeDSErrorId=&pxyResponse.txnPayName=DEF&pxyResponse.responseStatus.code=I00001&pxyResponse.threeDSSRS=