API_Document
API_Document
1. Bill Inquiry
2. Bill Payment
3. Echo Message
1. Bill Inquiry
Bill Inquiry Transaction is required to check the validity of the
transaction. The details of the function are as under:
Input Parameters
For Utility
Company
Usually, This field
Id
contains UCID in case
string(8
there are multiple
)
companies attached
to the webservice on
the other end.
Banks’ Mnemonic
e.g.
BoK, QNB
etc
Signature
‘01’ in case of
invalid
consumer/mobile
number that
doesnot exists
‘02’ in caseof
valid
consumer/mobile
number that
is currently
blocked or
dormant/inactive
(i-e transactions
are not allowed)
‘03’
Unknown
Consumer_Detail This will M M M String (A) 30
contain
Consumer Name Left justified
in case of utility right padded
company and with spaces
Package Plan in
case of Telecom
company
“PREPAID” or
“POSTPAID”.
Bill_Status ‘U’ in case of M M M String (A) 1
unpaid
bill or bill on
which payment is
allowed
‘P’ in case of paid
payment is no
allowed
‘B’ in case of
blocked
bill
Partial(Multipl
e/
Excess) payment
companies will
always send ‘T’
because excess
Due_Date payments
DueDate can will
be M M M yyyyMMdd
be
provided in case of
Utility company
consumers and
Telecom PostPaid
customers. In case
of prepaid
customers, this field
will be filled with all
Amount_Within_Due Amount will be M M M AN14
provided
Date
in case of Utility
- Last 2
company
digits minor
consumers and
units
Telecom PostPaid
customers. In case - Left padded
of prepaid with zeros
customers, this field
will be filled with e.g.
Amount
spaces.
120.00 Rs
is formatted as
+000000001200
0
Amount -
120.00
Rs
te in case of Utility
- Last 2
company
digits minor
consumers and
units
Telecom PostPaid
customers. In case - Left padded
of prepaid with zeros
customers, this field
will be filled with e.g.
Amount
spaces.
is formatted as
+000000001200
0
Amount -
120.00
Rs
is formatted as
Billing_Month Billing Month will be M M M String
provided in case of
N(4)
Utility
company yyMM
consumers.
In case of Telecom,
this field will be
Date_Paid filled
In casewith
billspaces.
status is O O M String
‘P’ else white space N(8)
should be sent yyyyMMdd
according to
specified length
Input Parameters
e.g. 698243
AN12
- Last 2 digits
minor units
- Left padded
with zeros
e.g. Amount
120.00
Rs
is formatted as
000000012000
N(8)
YYYYMMD
D
Tran_Time (PK) Transaction Time M String
N(6)
HHMMS
S
Bank_Mnemonic This field M For Bank
contains Mnemonic
either Bank string(3)
Mnemonic or Utility
Company Id. For Utility Company
Id string(8)
Usually, This field
contains UCID in
case there are
multiple companies
attached to the
webservice on the
other end.
Banks’ Mnemonic
e.g.
BoK, QNB
etc
SSGC0001,
UFONE003
etc
Signature
3. Echo Transaction
Input Parameters
Parameter Description Mandatory/ Data Type
Optional
Username M String
Password M String
Ping Fixed Value M String
=
“ARE_YOU_ALIVE”
NOTE: All optional fields will either have white spaces or zeros as per
the field requirement.
4. Response Codes
5. Duplicate Transaction
It is possible that Web Service will receive same bill payment transaction multiple
times (duplicate transaction) so it is necessary that Web Service should able to
handle duplicate transaction. A bill payment transaction can be identified as unique
by using following fields.
1. Consumer_Number
2. Tran_Auth_Id
3. Tran_Date
4. Tran_Time
Sam ple WSDL