Card Registration API Specifications
Introduction
We created a complete and detailed description of the Standard Workflow. Here you can find all parameter descriptions.
Hosts
- Test:
- Live:
Security / Authentication
All requests must be sent over SSL (Secure Socket Layer).
The memberId and checksum are in need to authenticate every request against a
particular terminal.
And the POST parameters are used to send the authentication data.
Testing
For testing purpose you can use below card/account details:
Test Card Details
| Brand | Number | CVV | Expiry Date |
|---|---|---|---|
| VISA | 4000000000000051 | 745 | Add Any Future Date |
| MASTER | 5101082187256503
5101080000000009 |
123 | Add Any Future Date |
| AMEX |
375510513169537 378282246310005 |
123 | Add Any Future Date |
Payment Parameters
This reference lists all the Standard flow parameters to be send in request.
| Parameter | Description | Format | Required |
|---|---|---|---|
| memberId | Merchant’s unique ID – assigned by . Required to authenticate a transaction's request. |
N10
[0-9] |
Yes |
| totype | Merchant's Partner name. Required to authenticate a transaction's request |
AN30
[a-zA-Z0-9] |
Yes |
| checksum | Cryptographic hash generated by MD5 as follows. All the processes has different combination of parameters to generate hash (all values separated by pipe). Kindly refer sample given in tutorial for each case |
AN32
[a-zA-Z0-9] |
Yes |
| country | Customer’s Country Code (ISO). | AN3
[a-zA-Z0-9]{2,3} |
No |
| city | City of the customer's shipping address. | A30
[a-zA-Z0-9\\\\#&\\p{Space}\\p{L}\\p{M}\\-;.,~` ]{0,30} |
No |
| state | State or region of the customer's shipping address. | A30
[\\ra-zA-Z0-9\\\\!@#$*%^&{}\\[\\]()_+\\p{L}\\p{M}\\-=,.~'` ]{0,30} |
No |
| postcode | Postal code/ Zip code of the customer's shipping address. | AN9
[A-Za-z0-9]{2,9} |
No |
| street | Building name, and/or street name of the customer's shipping address. | A100
[a-zA-Z0-9\\p{Space}\\,]+ |
No |
| phone | Phone number of the customer. | N15
[0-9\+-. ]{6,25} |
No |
| telnocc | Country code of the customer. | N4 [0-9\+-. ]{1,4} |
No |
| Email address of the customer. | AN50 [A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4} |
No | |
| customerId | Customer ID in merchant's system. | AN100
[a-zA-Z0-9]{1,20} |
Conditional |
| merchantRedirectUrl | Redirect url where the customer to be redirected after processing. Redirect URL provided in request will redirect customer on merchant's website. | AN100
[a-zA-Z0-9.:/] |
Yes |
Response Parameters
| Parameter | Description | Format | Required |
|---|---|---|---|
| resultCode | Unique response code for successful or failed transaction.See the Response codes for more detailed information. | N10
[0-9] |
Yes |
| resultDescription | Response description of the response code. | AN255
[a-zA-Z0-9\\p{Space}\\,]+[a-zA-Z0-9\\p{Space}\\,]+ |
Yes |
| timestamp | Shows at what time the transaction has been placed. | date
yyyy-MM-dd hh:mm:ss |
Yes |
| firstName | First name of the cardholder. | AN20
[A-Za-z0-9] |
Yes |
| lastName | Last name of the cardholder. | AN20
[A-Za-z0-9] |
Yes |
| checksum | Response checksum for security the combination of checksum is "paymentId|merchantTransactionId|amount|status|key" |
AN32
[a-zA-Z]{1,32} |
Yes |
| status | Status of the transaction processed. Possible values are, ‘Y’ – Successfully processed ‘N’ – Failed |
AN2
[Y|N] |
Yes |
| registrationId | Unique token sent by . | AN255
[a-zA-Z0-9] |
Yes |
| cardBin | First six digits of the card number | N6
[0-9]{6} |
No |
| cardLast4Digits | Last four digits of the card number | N4
[0-9]{4} |
No |