Credit Cards

One-shot Credit Card Bill Payment. Accepts all visa & master, diners, amex card

Header Parameters

NameTypeDescriptionMandatory (M) , Optional (O)Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-CodeStringAuth Code -1 (Fixed)MY
X-Ipay-Client-IdStringUnique Client IDMY
X-Ipay-Client-SecretStringUnique secret keyMY
X-Ipay-Endpoint-IpStringEnd Customer IP AddressMN

📘

Info :

Click Here to know how to get the Credentials.

Request Parameters

Parameter NameTypeRequirementDescription
payerArrayMandatoryPayer details
payer.bankProfileIdStringMandatoryUnique Bank Profile Id
payer.accountNumberStringMandatoryInstantpay Registered Mobile Number
payeeArrayMandatoryPayee details
payee.nameStringMandatoryAccount Holder Name
payee.accountNumberStringMandatoryCredit Card Number
transferModeStringMandatoryModes Will be CREDITCARD
transferAmountStringMandatoryAmount to be transferred
externalRefStringMandatoryYour unique transaction Id
latitudeStringMandatoryEnd Customer Latitude.
longitudeStringMandatoryEnd Customer Longitude.
RemarksStringOptionalPayment Remarks
alertEmailStringOptionalEnd User email for alert

Sample Request

curl --location --request POST 'https://api.instantpay.in/payments/payout' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "payer" : {
        "bankProfileId" : "0",
        "accountNumber" : "9999999999"
    },
    "payee" : {
        "name" : "ABC ZYX",
        "accountNumber" : "538787667671678"
    },
    "transferMode" : "CREDITCARD",
    "transferAmount" : "5.00",
    "externalRef" : "BILLPAY1",
    "latitude" : "20.**36",
    "longitude" : "78.**28",
    "remarks" : "Credit Card BILL",
    "alertEmail" : ""
}'
POST /payments/payout HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
Content-Type: application/json
{
"payer" : {
        "bankProfileId" : "0",
        "accountNumber" : "9999999999"
    },
    "payee" : {
        "name" : "ABC ZYX",
        "accountNumber" : "538**********78"
    },
    "transferMode" : "CREDITCARD",
    "transferAmount" : "5.00",
    "externalRef" : "BILLPAY1",
    "latitude" : "20.**36",
    "longitude" : "78.**28",
    "remarks" : "Credit Card BILL",
    "alertEmail" : ""
}

Response Parameters

Parameter NameTypeDescription
statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus message
dataArrayResponse Data (If Present)
timestampStringResponse time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )
environmentStringLive/Sandbox
internalCodeStringIt will be null

Sample Response

{
        "statuscode": "TXN",
        "actcode": null,
        "status": "Transaction Successful",
        "data": {
            "externalRef": "TX1223323",
            "poolReferenceId": "122031XXXXXXXXAWFQ",
            "txnValue": "4.00",
            "txnReferenceId": "00",
            "pool": {
                "account": "9999999999",
                "openingBal": "3697.27",
                "mode": "DR",
                "amount": "9.90",
                "closingBal": "3687.37"
            },
            "payer": {
                "account": "9999999999",
                "name": "ABC ENTERPRISES"
            },
            "payee": {
                "account": "3798XXXXXXXX2004",
                "name": ""
            }
        },
        "timestamp": "2022-03-15 18:08:13",
        "ipay_uuid": "h00595d34e99-1646-4838-93bc-8ab6ca4d8f06",
        "orderid": "12203**********WFQ",
        "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.

Language
Click Try It! to start a request and see the response here!