Void Bill Payment SOAP Service 1.0.0
SOAP
production
development
https://Sandboxapi.1link.net.pk/uat-1link/sandbox
Operations
VoidBillPayment
Operation VoidBillPayment
clientID
X-IBM-Client-Id
(apiKey located in header)
OAuth-BPS
OAuth-BPS
(oauth2 application)
Token URL
https://Sandboxapi.1link.net.pk/uat-1link/sandbox/oauth2/token
Scopes
1LinkApi
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken>
<wsse:Username>string</wsse:Username>
<wsse:Password>string</wsse:Password>
<wsse:Nonce EncodingType="string">string</wsse:Nonce>
<wsu:Created>string</wsu:Created>
</wsse:UsernameToken>
<wsu:Timestamp wsu:Id="string">
<wsu:Created>string</wsu:Created>
<wsu:Expires>string</wsu:Expires>
</wsu:Timestamp>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<ubps:VoidBillPaymentRequest xmlns:ubps="http://www.example.org/UBPS/"><!-- mandatory -->
<ubps:UserID><!-- mandatory -->string</ubps:UserID>
<ubps:Pwd><!-- mandatory -->string</ubps:Pwd>
<ubps:CLientID><!-- mandatory -->string</ubps:CLientID>
<ubps:ChannelID><!-- manExample Response
Try this operation
Definitions
Header for WS-Security
{
"xml": {
"namespace": "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd",
"prefix": "wsse"
},
"type": "object",
"properties": {
"UsernameToken": {
"xml": {
"namespace": "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd",
"prefix": "wsse"
},
"type": "object",
"properties": {
"Username": {
"xml": {
"namespace": "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd",
"prefix": "wsse"
},
"type": "string"
},
"Password": {
"xml": {
"namespace": "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd",
"prefix": "wsse"
},
"type": "string"
},
"Nonce": {
"xml": {
"namespace": "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd",
"prefix": "wsse"
},
"type": "string",
"properties": {
"EncodingType": {
"xml": {
"namespace": "",
"attribute": true
},
"type": "string"
}
}
},
"Created": {
"xml": {
"namespace": "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd",
"prefix": "wsu"
},
"type": "string"
}
}
},
"Timestamp": {
"xml": {
"namespace": "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd",
"prefix": "wsu"
},
"type": "object",
"properties": {
"Created": {
"xml": {
"namespace": "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd",
"prefix": "wsu"
},
"type": "string"
},
"Expires": {
"xml": {
"namespace": "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd",
"prefix": "wsu"
},
"type": "string"
},
"Id": {
"xml": {
"namespace": "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd",
"prefix": "wsu",
"attribute": true
},
"type": "string"
}
}
}
}
}
{
"type": "object",
"properties": {
"Envelope": {
"xml": {
"prefix": "soapenv",
"namespace": "http://schemas.xmlsoap.org/soap/envelope/"
},
"type": "object",
"properties": {
"Header": {
"$ref": "#/definitions/VoidBillPaymentHeader"
},
"Body": {
"type": "object",
"properties": {
"VoidBillPaymentRequest": {
"$ref": "#/definitions/VoidBillPaymentRequest_ubps"
}
},
"required": [
"VoidBillPaymentRequest"
],
"xml": {
"namespace": "http://schemas.xmlsoap.org/soap/envelope/",
"prefix": "soapenv"
}
}
},
"required": [
"Body"
]
}
},
"required": [
"Envelope"
]
}
{
"type": "object",
"properties": {
"Security": {
"$ref": "#/definitions/Security"
}
}
}
{
"type": "object",
"properties": {
"Envelope": {
"xml": {
"prefix": "soapenv",
"namespace": "http://schemas.xmlsoap.org/soap/envelope/"
},
"type": "object",
"properties": {
"Body": {
"type": "object",
"properties": {
"VoidBillPaymentResponse": {
"$ref": "#/definitions/VoidBillPaymentResponse_ubps"
}
},
"xml": {
"namespace": "http://schemas.xmlsoap.org/soap/envelope/",
"prefix": "soapenv"
}
}
},
"required": [
"Body"
]
}
},
"required": [
"Envelope"
]
}
{
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "object",
"properties": {
"UserID": {
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "string",
"maxLength": 16,
"minLength": 1,
"x-nullable": true,
"example": "api_123456"
},
"Pwd": {
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "string",
"maxLength": 16,
"minLength": 1,
"x-nullable": true,
"example": "api_112233"
},
"CLientID": {
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "string",
"maxLength": 10,
"minLength": 1,
"x-nullable": true,
"example": "api_123456"
},
"ChannelID": {
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "string",
"maxLength": 8,
"minLength": 1,
"x-nullable": true,
"example": "00000000"
},
"STAN": {
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "string",
"maxLength": 6,
"minLength": 1,
"x-nullable": true,
"example": "123567"
},
"CompanyCode": {
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "string",
"maxLength": 8,
"minLength": 1,
"x-nullable": true,
"example": "KESC0001"
},
"ConsumerNo": {
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "string",
"maxLength": 24,
"minLength": 1,
"x-nullable": true,
"example": "1700416100034"
},
"AuthorizationID": {
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "string",
"maxLength": 6,
"minLength": 1,
"x-nullable": true,
"example": "425499"
},
"Amount": {
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "string",
"maxLength": 12,
"minLength": 1,
"x-nullable": true,
"example": "000002500000"
},
"TransactionDateTime": {
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "string",
"maxLength": 14,
"minLength": 1,
"x-nullable": true,
"example": "20190411154530"
},
"BranchCode": {
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "string",
"maxLength": 10,
"x-nullable": true,
"example": "0101"
},
"BranchName": {
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "string",
"maxLength": 50,
"x-nullable": true,
"example": "Saddar Branch"
},
"Reserved1": {
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "string",
"maxLength": 999,
"x-nullable": true,
"example": "Reserved"
},
"Reserved2": {
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "string",
"maxLength": 999,
"x-nullable": true,
"example": "Reserved"
},
"Reserved3": {
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "string",
"maxLength": 999,
"x-nullable": true,
"example": "Reserved"
},
"Reserved4": {
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "string",
"maxLength": 999,
"x-nullable": true,
"example": "Reserved"
}
},
"required": [
"UserID",
"Pwd",
"CLientID",
"ChannelID",
"STAN",
"CompanyCode",
"ConsumerNo",
"AuthorizationID",
"Amount",
"TransactionDateTime"
]
}
{
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"type": "object",
"properties": {
"ResponseCode": {
"type": "string",
"x-nullable": true,
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"example": "00"
},
"ClientID": {
"type": "string",
"x-nullable": true,
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"example": "api_123456"
},
"ChannelID": {
"type": "string",
"x-nullable": true,
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"example": "00000000"
},
"STAN": {
"type": "string",
"x-nullable": true,
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"example": "123567"
},
"CompanyCode": {
"type": "string",
"x-nullable": true,
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"example": "KESC0001"
},
"ConsumerNo": {
"type": "string",
"x-nullable": true,
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"example": "1700416100034"
},
"AuthID": {
"type": "string",
"x-nullable": true,
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"example": "425499"
},
"RRN": {
"type": "string",
"x-nullable": true,
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"example": "512771100000"
},
"ResponseDetail": {
"type": "string",
"x-nullable": true,
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"example": "Success"
},
"Reserved1": {
"type": "string",
"x-nullable": true,
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"example": "Reserved"
},
"Reserved2": {
"type": "string",
"x-nullable": true,
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
},
"example": "Reserved"
},
"HASH": {
"type": "string",
"x-nullable": true,
"xml": {
"namespace": "http://www.example.org/UBPS/",
"prefix": "ubps"
}
}
},
"required": [
"ResponseCode",
"ClientID",
"ChannelID",
"STAN",
"CompanyCode",
"ConsumerNo",
"AuthID",
"RRN",
"ResponseDetail",
"Reserved1",
"Reserved2",
"HASH"
]
}