Standard Checkout
In a standard checkout merchant needs to post the intial request to Caibo hosted checkout page where customer will provide card/account details. Once the payment is verified customer is redirected back to the merchantRedirectUrl along with the payment status.
The initial request must contain all the required information:
- - authentication credentials
- - mode, brand , type and amount of transaction
- - merchantTransactionId
- - merchantRedirectUrl
Standard checkout request has to be sent to our endpoint i.e. /transaction/Checkout using POST method.
In our API Specifications you can find a full list of parameters that can be sent in the initial request.
Workflow
1. Post an Initial Payment
Merchant needs to post the intial request to Caibo hosted checkout page.
2. Redirect to Caibo hosted page
Customer will provide his/her card/account details on Caibo hosted checkout page.
3. Return to Merchant's Website
After payment confirmation, customer will be redirected to merchant's website.
1. Post an Initial Payment
To start the process, merchant has to send an initial payment request to the Server for the Hosted Payment Page. Here merchantRedirectUrl has to be url-encoded.
Sample Request
Brand:
Params params = new Params(memberId:'11344',language:'ENG',accountid:'2967',checksum:'85b7005f7956548a50520923a2d62b',totype:'docspartner',merchantTransactionId:'Transaction01',amount:'1.00',TMPL_AMOUNT:'1.00',orderDescription:'Test Transaction',merchantRedirectUrl:'https://www.merchantRedirectUrl.com',notificationUrl:'https://www.merchantNotificationUrl.com',country:'UK',city:'Aston',state:'NA',postcode:'CH5 3LJ',street:'19 Scrimshire Lane',telnocc:'+44',phone:'07730432996',email:'john.d@domain.com',ip:'192.168.0.1',currency:'EUR',TMPL_CURRENCY:'EUR',terminalid:'1106',reservedField1:'',paymentMode:'CC',paymentBrand:'VISA') <g:form method="POST" action="https://ipg-beta.caibo.digital/transaction/Checkout"> ${params.memberId} ${params.language} ${params.accountid} ${params.checksum} ${params.totype} ${params.merchantTransactionId} ${params.amount} ${params.TMPL_AMOUNT} ${params.orderDescription} ${params.merchantRedirectUrl} ${params.notificationUrl} ${params.country} ${params.city} ${params.state} ${params.postcode} ${params.street} ${params.telnocc} ${params.phone} ${params.email} ${params.ip} ${params.currency} ${params.TMPL_CURRENCY} ${params.terminalid} ${params.reservedField1} ${params.paymentMode} ${params.paymentBrand} </g:form>
2. Redirect to Caibo hosted page
The account holder will be redirected to Caibo hosted page, where the account holder can fill the card/account details.
3. Return to Merchant's Website
Once the payment has been processed, the customer will be redirected to your merchantRedirectUrl along with a POST parameters.
You can also check the payment confirmation with our Backoffice Inquiry API.
Sample code for reading the response
def response = { def trackingid = params.trackingid def paymentId = params.paymentId def token = params.token def registrationId = params.registrationId def desc = params.desc def merchantTransactionId = params.merchantTransactionId def paymentBrand = params.paymentBrand def paymentMode = params.paymentMode def amount = params.amount def currency = params.currency def status = params.status def splitTransaction = params.splitTransaction def checksum = params.checksum def descriptor = params.descriptor def mandateid = params.mandateid def tmpl_currency = params.tmpl_currency def tmpl_amount = params.tmpl_amount def resultCode = params.resultCode def resultDescription = params.resultDescription def cardBin = params.cardBin def cardLast4Digits = params.cardLast4Digits def custEmail = params.custEmail def custBankId = params.custBankId def custMerchantId = params.custMerchantId def firstName = params.firstName def lastName = params.lastName def eci = params.eci def timestamp = params.timestamp }
Hashing Rule For Request
Caibo supports MD5 Cryptographic Hash for the authenticity of payment request sent to the server.
Below are the description of fields used for generating checksum.
- memberId <Merchant ID as shared by Caibo>
- totype <Name of PSP>
- amount <Amount of transaction>
- merchantTransactionId <Unique transaction ID provided by merchant>
- merchantRedirectUrl <Customer is redirected to this url >
- secureKey <Secure Key that can be generated through Caibo's dashboard>
How to generate Checksum for request ?
Checksum can be calculated with the following combination and needs to be send along with the authentication parameters in each server-to-server request:
<memberId>|<totype>|<amount>|<merchantTransactionId>|<merchantRedirectUrl>|<secureKey>
Sample Code
import java.security.MessageDigest def generateMD5Checksum() { String values= "11344|docspartner|1.00|Transaction01|https://www.merchantRedirectUrl.com|secureKey"; MessageDigest digest = MessageDigest.getInstance(MD5) digest.update(values.bytes); new BigInteger(1, digest.digest()).toString(16).padLeft(32, '0') }
Hashing Rule For Response
Caibo supports MD5 Cryptographic Hash for the authenticity of payment response to be sent to the merchant.
Below are the description of fields used for generating checksum.
- PaymentId <Payment ID of the transaction>
- merchantTransactionId <Unique transaction ID provided by merchant>
- amount <Amount of transaction>
- status <Status of the transaction>
- secureKey <Secure Key that can be generated through Caibo's dashboard>
How to generate Checksum for response ?
Checksum can be calculated with the following combination.
<PaymentId>|<merchantTransactionId>|<amount>|<status>|<secureKey>
Standard Notification/ Callback
Checksum can be calculated with the following combination.
<paymentId>|<merchantTransactionId>|<amount>|<short status of transaction>|<secret key>
Example :
77251|011E1D8A5C034|156.00|N|<merchant secret key>
Payment Modes and Brands
Find below the list of payment modes and brands for standard checkout.
| Mode | Brand |
|---|