Instantpay's Credit Cards API solution is designed to streamline and simplify the process of paying credit card bills. This API offers the convenience of one-shot payments, allowing users to settle their bills easily. It supports all major credit cards, including Visa, Mastercard, Diners, and American Express, making it versatile and accommodating for a wide range of users.
It ensures a swift and secure method for settling credit card bills. This solution allows users to enjoy a seamless payment experience, contributing to overall positive customer satisfaction.
The API's capabilities cater to the modern demand for quick, secure, and hassle-free credit card bill payments, making it a valuable tool for businesses and individuals alike.
Header Parameters
| Name | Type | Description | Mandatory (M) , Optional (O) | Provided by INSTANTPAY (Y/N) |
|---|---|---|---|---|
| X-Ipay-Auth-Code | String | Auth Code -1 (Fixed) | M | Y |
| X-Ipay-Client-Id | String | Unique Client ID | M | Y |
| X-Ipay-Client-Secret | String | Unique secret key | M | Y |
| X-Ipay-Endpoint-Ip | String | End Customer IP Address | M | N |
Info :
Click Here to know how to get the Credentials.
Request Parameters
Parameter Name | Type | Requirement | Description |
|---|---|---|---|
payer | Array | Mandatory | Payer details |
payer.bankProfileId | String | Mandatory | Bank Profile Id will be 0 |
payer.name | String | Mandatory | Name of the Sender |
payer.accountNumber | String | Mandatory | Account Details of the Sender |
payer.paymentMode | String | Mandatory | Indicates the type of the payment done Allowed Values : PAY_CARD, NETBANKING, UPI PAY_CARD : If the sender has made the payment via DEBIT CARD. NETBANKING: If the sender has made the payment via NETBANKING. UPI: If the sender has made the payment via UPI |
payer.cardNumber | String | Optional (Mandatory if paymentMode is PAY_CARD) | If the paymentMode is PAY_CARD then enter the Debit Card Number in aes-256-cbc encryption. |
payer.cardSecurityCode | String | Optional | CVV of the sender's card in aes-256-cbc encryption. |
payer.referenceNumber | String | Optional (Mandatory when paymentMode is UPI) | Unique transaction reference number. |
payer.cardExpiry | Array | Optional | Card Expiry Details |
payer.cardExpiry.month | String | Optional | Card Expiry Month of the sender card(MM Format) in aes-256-cbc encryption. |
payer.cardExpiry.year | String | Optional | Card Expiry Year of the sender card(YY Format) in aes-256-cbc encryption. |
payee | Array | Mandatory | Payee details |
payee.name | String | Mandatory | Account Holder Name |
payee.accountNumber | String | Mandatory | Credit Card Number in aes-256-cbc encryption |
transferMode | String | Mandatory | Modes Will be CREDITCARD |
transferAmount | String | Mandatory | Amount to be transferred |
externalRef | String | Mandatory | Your unique transaction Id |
latitude | String | Mandatory | End Customer Latitude. |
longitude | String | Mandatory | End Customer Longitude. |
Remarks | String | Optional | Payment Remarks |
alertEmail | String | Optional | Email of the end user. If passing the email, then Instantpay will send the email notification. |
Sample Request
curl --location 'https://api.instantpay.in/payments/payout' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 82e4755d7c1cf636816addfe1460936d7b64612208df87f3000aa5b56fc926d1' \
--header 'X-Ipay-Endpoint-Ip: 14.142.186.142' \
--data '{
"payer": {
"bankId": "0",
"bankProfileId": "0",
"accountNumber": "7428585742",
"name": "Instantpay",
"paymentMode": "NETBANKING",
"cardNumber": "",
"cardSecurityCode": "",
"cardExpiry": {
"month": "",
"year": ""
},
"referenceNumber": ""
},
"payee": {
"accountNumber": "L3SdKhkUvb18gqdhXcQ0WMlL7qYny3azGcqyQh",
"name": "Instantpay"
},
"transferMode": "CREDITCARD",
"transferAmount": "1.00",
"externalRef": "BILLPAY1",
"latitude": "20.5936",
"longitude": "78.9628",
"remarks": "Credit Card BILL",
"alertEmail": ""
}'POST /payments/payout HTTP/1.1
Host: api.instantpay.in
Accept: application/json
Content-Type: application/json
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 82e4755d7c1cf636816addfe1460936d7b64612208df87f3000aa5b56fc926d1
X-Ipay-Endpoint-Ip: 14.142.186.142
Content-Length: 705
{
"payer": {
"bankId": "0",
"bankProfileId": "0",
"accountNumber": "7428585742",
"name": "Instantpay",
"paymentMode": "NETBANKING",
"cardNumber": "",
"cardSecurityCode": "",
"cardExpiry": {
"month": "",
"year": ""
},
"referenceNumber": ""
},
"payee": {
"accountNumber": "L3SdKhkUvb18gqdhXcQ0WMlL7qYny3azGcqyQh",
"name": "Instantpay"
},
"transferMode": "CREDITCARD",
"transferAmount": "1.00",
"externalRef": "BILLPAY1",
"latitude": "20.5936",
"longitude": "78.9628",
"remarks": "Credit Card BILL",
"alertEmail": ""
}Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| statuscode | String | InstantPay Status Code |
| actcode | String | Action Code |
| status | String | Status message |
| data | Array | Response Data (If Present) |
| timestamp | String | Response time (YYYY-MM-DD HH:II:SS) |
| ipay_uuid | String | Request reference number |
| orderid | String | Transaction Id ( If transaction otherwise it is null ) |
| environment | String | Live/Sandbox |
| internalCode | String | It will be null |
Sample Response
{
"statuscode": "TXN",
"actcode": null,
"status": "Transaction Successful",
"data": {
"externalRef": "TX1223323",
"poolReferenceId": "1211112165649WFTYK",
"txnValue": "4.00",
"txnReferenceId": "00",
"pool": {
"account": "7428585742",
"openingBal": "3697.27",
"mode": "DR",
"amount": "9.90",
"closingBal": "3687.37"
},
"payer": {
"account": "7428585742",
"name": "Sample Store"
},
"payee": {
"account": "3798XXXXXXXX2004",
"name": "Instantpay India Ltd"
}
},
"timestamp": "2022-03-15 18:08:13",
"ipay_uuid": "h00595d34e99-1646-4838-93bc-8ab6ca4d8f06",
"orderid": "1211112165649WFTYK",
"environment": "LIVE",
"internalCode": null
}Note :
1 - Latitude and Longitude must be represented in degrees with 4 digits after decimal.
2- externalRef must be unique and in alpha numeric characters.
3- Remarks should be in alphabet and it can be of maximum 20 characters.
4- Consider the Transaction as Pending when you get No Response or Timeout Response and then check the status of the transactions through Transaction Status API.
Note :
Before initiating Credit Card Payment verify the card details through Card BIN Checker API. Click Here for API Documents.
Encryption of Card number should be done in aes-256-cbc encryption using the encryption key which you will get from the credentials page.