production
development
https://Sandboxapi.1link.net.pk/uat-1link/sandbox
Paths
/voidbillpayment
post /voidbillpayment
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
OAuth-VoidBPs
OAuth-VoidBPs
(oauth2 application)
Token URL
https://Sandboxapi.1link.net.pk/uat-1link/sandbox/oauth2/token
Scopes
1LinkApi
VoidBillPaymentReq
Optional in body
object
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/void-bill-payment-rest-service/voidbillpayment
Try this operation
Definitions
{
"properties": {
"ResponseCode": {
"type": "string",
"example": "00"
},
"ClientID": {
"type": "string",
"example": "HBL001"
},
"ChannelID": {
"type": "string",
"example": "00000003"
},
"STAN": {
"type": "string",
"example": "444666"
},
"CompanyCode": {
"type": "string",
"example": "PTCL0012"
},
"ConsumerNo": {
"type": "string",
"example": "555555"
},
"AuthID": {
"type": "string",
"example": "112233"
},
"RRN": {
"type": "string",
"example": "061311290001"
},
"ResponseDetail": {
"type": "string"
},
"Reserved1": {
"type": "string"
},
"Reserved2": {
"type": "string"
},
"HASH": {
"type": "string",
"example": "tAHBuBE2JK/zIr8FvnxklcxmcrH9lbRnRHLNE0ZCmn63ZfYfKSDX/DLNk6eeSQaFreQZFNsIaRaKnm9Oh5S9rlhI7TmmsotIq8MB5aow8i1PSo6L13x9omlRNyc4hhsSmc378VjPKzS4pH0P2BEE0ur1/rnWqP4eBEuiAWM2itNlZZzbdBjBFA38DELZNmB29sdfAviD4E9ZUN6wIgcuf2loDepjEr16R1MVLH1fvTAmsUCvL1yjH7M/050Bt7/TqniuAg6uihVEZskA91ubR6/9eM7t3qNdxgVLO+3cUrgJu/tjhWRsg92PbfIvIV4f7+Gz4SFe5wf23yr0aHZ+OQ=="
}
},
"additionalProperties": false
}
{
"properties": {
"UserID": {
"type": "string",
"description": "To authenticate client connecting to UBPS",
"minLength": 1,
"maxLength": 16,
"pattern": "^[a-zA-Z0-9_-]+$",
"example": "api_123456"
},
"Pwd": {
"type": "string",
"description": "To authenticate client connecting to UBPS",
"minLength": 1,
"maxLength": 16,
"pattern": "^[a-zA-Z0-9_-]+$",
"example": "api_112233"
},
"CLientID": {
"type": "string",
"example": "api_123456",
"description": "Represents identification for client institution",
"minLength": 1,
"maxLength": 10,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"ChannelID": {
"type": "string",
"example": "00000000",
"minLength": 1,
"maxLength": 8,
"pattern": "^[0-9]+$"
},
"STAN": {
"type": "string",
"description": "System Trace Audit Number",
"example": "123456",
"minLength": 1,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"CompanyCode": {
"type": "string",
"description": "Utility company ID that represent a biller. Bill aggregator entity is the issuing authority for the value in this field.",
"example": "KESC0001",
"minLength": 1,
"maxLength": 8,
"pattern": "^[a-zA-Z0-9_-]+$"
},
"ConsumerNo": {
"type": "string",
"description": "It represents customer of biller. System should return the single record of latest bill available to pay against a consumer number",
"minLength": 1,
"maxLength": 24,
"pattern": "^[a-zA-Z0-9_-]+$",
"example": "1700416100034"
},
"AuthorizationID": {
"type": "string",
"description": "Treated as transaction reference number. Included in keys used to uniquely identify a transaction",
"minLength": 1,
"maxLength": 6,
"pattern": "^[0-9]+$",
"example": "425499"
},
"Amount": {
"type": "string",
"example": "000002500000",
"minLength": 1,
"maxLength": 12,
"pattern": "^[+|\\-|0-9]+$"
},
"TransactionDateTime": {
"type": "string",
"description": "yyyyMMddHHmmss",
"example": "20190411154530",
"minLength": 1,
"maxLength": 14,
"pattern": "^[0-9]+$"
},
"BranchCode": {
"type": "string",
"description": "If bill is paid from some Bank Branch or other exchange.",
"example": "0101",
"pattern": "^[0-9]+$"
},
"BranchName": {
"type": "string",
"description": "Send Branch Name.",
"example": "Saddar_Branch",
"pattern": "^[a-zA-Z0-9_-]+$"
},
"Reserved1": {
"type": "string",
"description": "Reserved for future use",
"example": ""
},
"Reserved2": {
"type": "string",
"description": "Reserved for future use",
"example": ""
},
"Reserved3": {
"type": "string",
"description": "Reserved for future use",
"example": ""
},
"Reserved4": {
"type": "string",
"description": "Reserved for future use",
"example": ""
}
},
"additionalProperties": false,
"required": [
"UserID",
"Pwd",
"CLientID",
"ChannelID",
"CompanyCode",
"STAN",
"ConsumerNo",
"AuthorizationID",
"Amount",
"TransactionDateTime"
]
}