Alias REST

Alias REST 1.0.0

0
No votes yet
forum Discuss this API in the forum
production
development
https://Sandboxapi.1link.net.pk/uat-1link/sandbox

Paths

/create

post /create
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)

[email protected]

api-key-1
X-IBM-Client-Secret
(apiKey located in header)
Body
Required in body
object
CreateAliasRequestBody
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://Sandboxapi.1link.net.pk/uat-1link/sandbox/alias-rest/create
Try this operation
https://Sandboxapi.1link.net.pk/uat-1link/sandbox/alias-rest/create
content-type
accept

/update

post /update
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)

[email protected]

api-key-1
X-IBM-Client-Secret
(apiKey located in header)
body
Required in body
object
UpdateAliasRequestBody
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://Sandboxapi.1link.net.pk/uat-1link/sandbox/alias-rest/update
Try this operation
https://Sandboxapi.1link.net.pk/uat-1link/sandbox/alias-rest/update
content-type
accept

/delete

post /delete
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)

[email protected]

api-key-1
X-IBM-Client-Secret
(apiKey located in header)
body
Required in body
object
DeleteAliasRequestBody
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://Sandboxapi.1link.net.pk/uat-1link/sandbox/alias-rest/delete
Try this operation
https://Sandboxapi.1link.net.pk/uat-1link/sandbox/alias-rest/delete
content-type
accept

/inquiry

post /inquiry
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)

[email protected]

api-key-1
X-IBM-Client-Secret
(apiKey located in header)
body
Required in body
object
InquiryAliasRequestBody
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://Sandboxapi.1link.net.pk/uat-1link/sandbox/alias-rest/inquiry
Try this operation
https://Sandboxapi.1link.net.pk/uat-1link/sandbox/alias-rest/inquiry
content-type
accept

Definitions 

{
    "properties": {
        "CNIC": {
            "type": "string",
            "example": "4200012312312"
        },
        "ProcessingCode": {
            "type": "string",
            "example": "570000"
        },
        "TransmissionDateandTime": {
            "type": "string",
            "example": "1230569875"
        },
        "STAN": {
            "type": "string",
            "example": "999999"
        },
        "Time": {
            "type": "string",
            "example": "123456"
        },
        "Date": {
            "type": "string",
            "example": "1234"
        },
        "DateExpiration": {
            "type": "string",
            "example": "1234"
        },
        "MerchantType": {
            "type": "string",
            "example": "1234"
        },
        "TransactionFeeAmount": {
            "type": "string",
            "example": "00000678"
        },
        "FromBankIMD": {
            "type": "string",
            "example": "123456"
        },
        "RRN": {
            "type": "string",
            "example": "123456789012"
        },
        "ChannelID": {
            "type": "string",
            "example": "1Link"
        },
        "City": {
            "type": "string",
            "example": "karachi"
        },
        "CountryCode": {
            "type": "string",
            "example": "PK"
        },
        "AccountNo": {
            "type": "string",
            "example": "133513"
        },
        "Reserved_NAT7": {
            "$ref": "#/definitions/Reserved_NAT7"
        },
        "Reserved_NAT8": {
            "$ref": "#/definitions/Reserved_NAT8"
        },
        "Reserved1": {
            "type": "string",
            "example": "Reserved1"
        },
        "Reserved2": {
            "type": "string",
            "example": "Reserved2"
        }
    },
    "additionalProperties": false,
    "required": [
        "CNIC",
        "TransmissionDateandTime",
        "STAN",
        "Time",
        "Date",
        "MerchantType",
        "FromBankIMD",
        "RRN",
        "Reserved_NAT7",
        "ProcessingCode",
        "CountryCode",
        "ChannelID",
        "City",
        "AccountNo"
    ]
}
              
{
    "properties": {
        "Alias": {
            "type": "string",
            "example": "[email protected]"
        },
        "UniqueID": {
            "type": "string",
            "example": "UniqueID129"
        },
        "AccountTitle": {
            "type": "string",
            "example": "AccountTitle"
        },
        "PassportNo": {
            "type": "string",
            "example": "PassportNo"
        },
        "MobileNo": {
            "type": "string",
            "example": "03001010706"
        },
        "Email": {
            "type": "string",
            "example": "[email protected]"
        },
        "POI_Method": {
            "type": "string",
            "example": "ATM"
        },
        "Status": {
            "type": "string",
            "example": "Status"
        },
        "Address1": {
            "type": "string",
            "example": "Address1"
        },
        "Address2": {
            "type": "string",
            "example": "Address2"
        },
        "Address3": {
            "type": "string",
            "example": "Address3"
        }
    },
    "additionalProperties": false,
    "required": [
        "Alias",
        "UniqueID"
    ]
}
              
{
    "properties": {
        "Name": {
            "type": "string",
            "example": "Name"
        },
        "Surname": {
            "type": "string",
            "example": "Surname"
        },
        "NickName": {
            "type": "string",
            "example": "NickName"
        },
        "Gender": {
            "type": "string",
            "example": "M"
        },
        "BirthDate": {
            "type": "string",
            "example": "01012021"
        },
        "OpeningDate": {
            "type": "string",
            "example": "01012021"
        },
        "ClosingDate": {
            "type": "string",
            "example": "01012021"
        },
        "StartDate": {
            "type": "string",
            "example": "01012021"
        },
        "ExpirationDate": {
            "type": "string",
            "example": "01012021"
        },
        "DocumentNo": {
            "type": "string",
            "example": "doc number"
        },
        "DocValidityDate": {
            "type": "string",
            "example": "01012021"
        },
        "Type": {
            "type": "string",
            "example": "Type"
        },
        "Aliasses": {
            "type": "string",
            "example": "Aliasses"
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "CNIC": {
            "type": "string"
        },
        "ProcessingCode": {
            "type": "string"
        },
        "TransmissionDateandTime": {
            "type": "string"
        },
        "STAN": {
            "type": "string"
        },
        "Time": {
            "type": "string"
        },
        "Date": {
            "type": "string"
        },
        "MerchantType": {
            "type": "string"
        },
        "TransactionFeeAmount": {
            "type": "string"
        },
        "FromBankIMD": {
            "type": "string"
        },
        "RRN": {
            "type": "string"
        },
        "AuthorizationIDReponse": {
            "type": "string"
        },
        "ResponseCode": {
            "type": "string"
        },
        "ChannelID": {
            "type": "string"
        },
        "City": {
            "type": "string"
        },
        "CountryCode": {
            "type": "string"
        },
        "AccountNo": {
            "type": "string"
        },
        "Alias": {
            "type": "string"
        },
        "UniqueID": {
            "type": "string"
        },
        "Status": {
            "type": "string"
        },
        "Reserved1": {
            "type": "string"
        },
        "Reserved2": {
            "type": "string"
        },
        "ResponseDetail": {
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "CNIC",
        "ProcessingCode",
        "STAN",
        "Time",
        "Date",
        "MerchantType",
        "FromBankIMD",
        "RRN",
        "AuthorizationIDReponse",
        "ResponseCode",
        "ChannelID",
        "City",
        "CountryCode",
        "AccountNo",
        "Alias",
        "UniqueID"
    ]
}
              
{
    "properties": {
        "CNIC": {
            "type": "string",
            "example": "4200012312312"
        },
        "ProcessingCode": {
            "type": "string",
            "example": "580000"
        },
        "TransmissionDateandTime": {
            "type": "string",
            "example": "1230569875"
        },
        "STAN": {
            "type": "string",
            "example": "999999"
        },
        "Time": {
            "type": "string",
            "example": "123456"
        },
        "Date": {
            "type": "string",
            "example": "1234"
        },
        "DateExpiration": {
            "type": "string",
            "example": "1234"
        },
        "MerchantType": {
            "type": "string",
            "example": "1234"
        },
        "TransactionFeeAmount": {
            "type": "string",
            "example": "00000678"
        },
        "FromBankIMD": {
            "type": "string",
            "example": "123456"
        },
        "RRN": {
            "type": "string",
            "example": "123456789012"
        },
        "ChannelID": {
            "type": "string",
            "example": "1Link"
        },
        "City": {
            "type": "string",
            "example": "karachi"
        },
        "CountryCode": {
            "type": "string",
            "example": "PK"
        },
        "AccountNo": {
            "type": "string",
            "example": "133513"
        },
        "Reserved_NAT7": {
            "$ref": "#/definitions/Reserved_NAT7"
        },
        "Reserved_NAT8": {
            "$ref": "#/definitions/Reserved_NAT8"
        },
        "Reserved1": {
            "type": "string",
            "example": "Reserved1"
        },
        "Reserved2": {
            "type": "string",
            "example": "Reserved2"
        }
    },
    "additionalProperties": false,
    "required": [
        "CNIC",
        "TransmissionDateandTime",
        "STAN",
        "Time",
        "Date",
        "MerchantType",
        "FromBankIMD",
        "RRN",
        "Reserved_NAT7",
        "ProcessingCode",
        "CountryCode",
        "ChannelID",
        "City",
        "AccountNo"
    ]
}
              
{
    "properties": {
        "CNIC": {
            "type": "string"
        },
        "ProcessingCode": {
            "type": "string"
        },
        "TransmissionDateandTime": {
            "type": "string"
        },
        "STAN": {
            "type": "string"
        },
        "Time": {
            "type": "string"
        },
        "Date": {
            "type": "string"
        },
        "MerchantType": {
            "type": "string"
        },
        "TransactionFeeAmount": {
            "type": "string"
        },
        "FromBankIMD": {
            "type": "string"
        },
        "RRN": {
            "type": "string"
        },
        "AuthorizationIDReponse": {
            "type": "string"
        },
        "ResponseCode": {
            "type": "string"
        },
        "ChannelID": {
            "type": "string"
        },
        "City": {
            "type": "string"
        },
        "CountryCode": {
            "type": "string"
        },
        "AccountNo": {
            "type": "string"
        },
        "Alias": {
            "type": "string"
        },
        "UniqueID": {
            "type": "string"
        },
        "Status": {
            "type": "string"
        },
        "Reserved1": {
            "type": "string"
        },
        "Reserved2": {
            "type": "string"
        },
        "ResponseDetail": {
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "CNIC",
        "ProcessingCode",
        "STAN",
        "Time",
        "Date",
        "MerchantType",
        "FromBankIMD",
        "RRN",
        "AuthorizationIDReponse",
        "ResponseCode",
        "ChannelID",
        "City",
        "CountryCode",
        "AccountNo",
        "Alias",
        "UniqueID"
    ]
}
              
{
    "properties": {
        "CNIC": {
            "type": "string",
            "example": "4200012312312"
        },
        "ProcessingCode": {
            "type": "string",
            "example": "590000"
        },
        "TransmissionDateandTime": {
            "type": "string",
            "example": "1230569875"
        },
        "STAN": {
            "type": "string",
            "example": "999999"
        },
        "Time": {
            "type": "string",
            "example": "123456"
        },
        "Date": {
            "type": "string",
            "example": "1234"
        },
        "DateExpiration": {
            "type": "string",
            "example": "1234"
        },
        "MerchantType": {
            "type": "string",
            "example": "1234"
        },
        "TransactionFeeAmount": {
            "type": "string",
            "example": "00000678"
        },
        "FromBankIMD": {
            "type": "string",
            "example": "123456"
        },
        "RRN": {
            "type": "string",
            "example": "123456789012"
        },
        "ChannelID": {
            "type": "string",
            "example": "1Link"
        },
        "City": {
            "type": "string",
            "example": "karachi"
        },
        "CountryCode": {
            "type": "string",
            "example": "PK"
        },
        "AccountNo": {
            "type": "string",
            "example": "133513"
        },
        "Reserved_NAT7": {
            "$ref": "#/definitions/DeleteReserved_NAT7"
        },
        "Reserved1": {
            "type": "string",
            "example": "Reserved1"
        },
        "Reserved2": {
            "type": "string",
            "example": "Reserved2"
        }
    },
    "additionalProperties": false,
    "required": [
        "CNIC",
        "TransmissionDateandTime",
        "STAN",
        "Time",
        "Date",
        "MerchantType",
        "FromBankIMD",
        "RRN",
        "Reserved_NAT7",
        "ProcessingCode",
        "CountryCode",
        "ChannelID",
        "City",
        "AccountNo"
    ]
}
              
{
    "properties": {
        "CNIC": {
            "type": "string"
        },
        "ProcessingCode": {
            "type": "string"
        },
        "TransmissionDateandTime": {
            "type": "string"
        },
        "STAN": {
            "type": "string"
        },
        "Time": {
            "type": "string"
        },
        "Date": {
            "type": "string"
        },
        "MerchantType": {
            "type": "string"
        },
        "TransactionFeeAmount": {
            "type": "string"
        },
        "FromBankIMD": {
            "type": "string"
        },
        "RRN": {
            "type": "string"
        },
        "AuthorizationIDReponse": {
            "type": "string"
        },
        "ResponseCode": {
            "type": "string"
        },
        "AccountNo": {
            "type": "string"
        },
        "Alias": {
            "type": "string"
        },
        "Reserved1": {
            "type": "string"
        },
        "Reserved2": {
            "type": "string"
        },
        "ResponseDetail": {
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "CNIC",
        "ProcessingCode",
        "STAN",
        "Time",
        "Date",
        "MerchantType",
        "FromBankIMD",
        "RRN",
        "AuthorizationIDReponse",
        "ResponseCode",
        "AccountNo",
        "Alias"
    ]
}
              
{
    "properties": {
        "Alias": {
            "type": "string",
            "example": "[email protected]"
        },
        "POI_Method": {
            "type": "string",
            "example": "ATM"
        }
    },
    "additionalProperties": false,
    "required": [
        "Alias"
    ]
}
              
{
    "properties": {
        "CNIC": {
            "type": "string",
            "example": "4200012312312"
        },
        "ProcessingCode": {
            "type": "string",
            "example": "600000"
        },
        "TransmissionDateandTime": {
            "type": "string",
            "example": "1230569875"
        },
        "STAN": {
            "type": "string",
            "example": "999999"
        },
        "Time": {
            "type": "string",
            "example": "123456"
        },
        "Date": {
            "type": "string",
            "example": "1234"
        },
        "DateExpiration": {
            "type": "string",
            "example": "1234"
        },
        "MerchantType": {
            "type": "string",
            "example": "1234"
        },
        "POSConditionCode": {
            "type": "string",
            "example": "01"
        },
        "TransactionFeeAmount": {
            "type": "string",
            "example": "00000678"
        },
        "FromBankIMD": {
            "type": "string",
            "example": "123456"
        },
        "RRN": {
            "type": "string",
            "example": "123456789012"
        },
        "ChannelID": {
            "type": "string",
            "example": "1Link"
        },
        "AccountNo": {
            "type": "string",
            "example": "karachi"
        },
        "Reserved_NAT7": {
            "$ref": "#/definitions/InquiryReserved_NAT7"
        },
        "Reserved1": {
            "type": "string",
            "example": "Reserved1"
        },
        "Reserved2": {
            "type": "string",
            "example": "Reserved2"
        }
    },
    "additionalProperties": false,
    "required": [
        "CNIC",
        "TransmissionDateandTime",
        "STAN",
        "Time",
        "Date",
        "MerchantType",
        "FromBankIMD",
        "RRN",
        "ProcessingCode",
        "ChannelID",
        "POSConditionCode"
    ]
}
              
{
    "properties": {
        "Alias": {
            "type": "string",
            "example": "[email protected]"
        },
        "MobileNo": {
            "type": "string",
            "example": "03331714785"
        },
        "Email": {
            "type": "string",
            "example": "[email protected]"
        },
        "POI_Method": {
            "type": "string",
            "example": "ATM"
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "CNIC": {
            "type": "string"
        },
        "ProcessingCode": {
            "type": "string"
        },
        "TransmissionDateandTime": {
            "type": "string"
        },
        "STAN": {
            "type": "string"
        },
        "Time": {
            "type": "string"
        },
        "Date": {
            "type": "string"
        },
        "MerchantType": {
            "type": "string"
        },
        "POSConditionCode": {
            "type": "string"
        },
        "TransactionFeeAmount": {
            "type": "string"
        },
        "FromBankIMD": {
            "type": "string"
        },
        "RRN": {
            "type": "string"
        },
        "AuthorizationIDReponse": {
            "type": "string"
        },
        "ResponseCode": {
            "type": "string"
        },
        "AccountNo": {
            "type": "string"
        },
        "Alias": {
            "type": "string"
        },
        "Reserved1": {
            "type": "string"
        },
        "Reserved2": {
            "type": "string"
        },
        "ResponseDetail": {
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "CNIC",
        "ProcessingCode",
        "STAN",
        "Time",
        "Date",
        "MerchantType",
        "FromBankIMD",
        "RRN",
        "AuthorizationIDReponse",
        "ResponseCode",
        "AccountNo",
        "POSConditionCode"
    ]
}