Activate Card

The API will be used to activate inventory in our system.

📘

Header Parameters

For Header references Click here

Request Parameters

Name

Type

Mandatory (M), Optional (O)

Description

customers

Array

M

Customer Details

customers.type

String

M

Physical/ Virtual

customers.name

String

M

Customer Name

customers.mobile

String

M

Customer Mobile Number

customers.email

String

M

Customer Email Address

customers.amount

String

M

Amount

customers.kitNumber

String

M

Kit Number InstantPay Provided

customers.shortCardNumber

String

M

Last 4 digits of the Card Number.

latitude

String

M

Current Location Latitude

longitude

String

M

Current Location Longitude

externalRef

String

M

Unique Reference Number

iPin

String

M

Intantpay Pin Number

Sample Request

curl --location --request PATCH 'https://api.instantpay.in/cards/gift' \
--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 '{
    "customers": [
        {
            "type": "Physical",
            "name": "S*****z **i",
            "mobile": "98******07",
            "email": "s*****[email protected]",
            "amount": "5",
            "kitNumber": "31******56",
            "shortCardNumber": "5**2"
        }
    ],
    "latitude": "2*.**51",
    "longitude": "7*.**64",
    "externalRef": "1******9",
    "iPin": "0**6"
}'
PATCH /cards/gift 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

{
   "customers": [
        {
            "type": "Physical",
            "name": "S*****z **i",
            "mobile": "98******07",
            "email": "s*****[email protected]",
            "amount": "5",
            "kitNumber": "31******56",
            "shortCardNumber": "5**2"
        }
    ],
    "latitude": "2*.**51",
    "longitude": "7*.**64",
    "externalRef": "1******9",
    "iPin": "0**6"
}

Response Parameters

Name

Type

Description

statuscode

String

InstantPay Status Code

actcode

String

Action Code

status

String

Status Message

data

Array

Response Data (If Present)

timestamp

String

Current 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

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Physical GiftCard successfully issued to customer",
    "data": {
        "kitNumber": "31******56",
        "shortCardNumber": "5**2",
        "bin": "8****9",
        "expiryDate": "2024-02-29",
        "network": "RuPay"
    },
    "timestamp": "2022-04-11 12:01:07",
    "ipay_uuid": "h06896091bde-c986-442e-aee6-bb7aceb9f179",
    "orderid": "12**************WX",
    "environment": "LIVE"
}
Language
Click Try It! to start a request and see the response here!