Corporate iNet Straight Through Payments (STP) API

Integration Manual for STP Method

Version 1.0
Contents

1. Introduction. 2

2. Component of the API message. 2

2.1. Local Funds Transfer title fetch. 2

2.1.1. Request Parameters LFT_Title Fetch. 2

2.1.2. Response Parameters LFT_Title Fetch. 2

2.2. Interbank Funds Transfer title fetch. 3

2.2.1. Request Parameters IBFT Title_Fetch. 3

2.2.2. Response Parameters IBFT Title_Fetch. 3

2.3. Local Funds Transfer Payment Request (LFT_Payment) 3

2.3.1. Request Parameters LFT_Payment 3

2.3.2. Response Parameters LFT_Payment 4

2.4. IBFT Payment Request (IBFT_Payment) 5

2.4.1. Request Parameters IBFT_Payment 5

2.4.2. Response Parameters IBFT_Payment 5

3. Transaction Status. 6

3.1. Method 1. 6

3.1.1. Transaction Status Parameters. 6

3.2. Method 2. 6

3.2.1. Request Parameters Transactions Status. 7

3.2.2. Response Parameters Transaction Status. 7

4. Details of Response Codes. 7

Details of Response Codes (IBFT Title_Fetch) 8

 1. Introduction
Through this document we intend to request ITG to develop an API through which our
payment customers can send payment instruction through API for STP (Straight through
processing) means transaction received will be directly processed end to end and without
requiring customer to login on Corporate iNet and status of the transactions will be shared
with client through response API. This communication will take place through point to point
VPN between client and AKBL and by locking client IP to ensure security of the system

However, below are some basic assumptions in this

· User ids of maker, reviewer, signatories, publisher to be cross checked from

Corporate iNet company setup

· Transaction amount to be cross checked

2. Component of the API message

Product wise tags of API message are mentioned below

2.1. Local Funds Transfer title

fetch
2.1.1.Request Parameters LFT_Title Fetch

Tag Type Length Mandatory Description

UserID Alpha/Numeric 20 Yes Registered details in

C. iNet and will be
shared with client by
bank (Maker User
ID)

Password Alpha/Numeric 20 Yes Hard coded details

in C. iNet and will
 be shared with
client by bank
(Maker Password)

Authcode Numeric 8 Yes Hard coded details

in C. iNet and will
be shared with
client by bank
(Maker Auth Code)

UniqueRefNo Alpha/Numeric 20 No Optional

DebitAccountNumber Alpha/Numeric 24 No IBAN or FLEXCUBE

format

CreditAccountNumber Alpha/Numeric 24 Yes Bene AKBL.

account number.
IBAN or FLEXCUBE
FORMAT

2.1.2.Response Parameters LFT_Title Fetch

Tag Type Description

ResponseCode Alpha/Numeric Service Status Code

ResponseDescription Alpha/Numeric Service Status Code Description or Acc Title in

case of 00

UniqueTrxRefNo Alpha/Numeric Unique Transaction No (it is contain

company code + date time + 3

Digit random number)

Date Time format :

 Year : YYYY (i.e. 2017,2018 etc)

Month: MON (i.e. JAN, FEB, MAR...DEC)

Day : DD (i.e. 01,02… 28..31)

Hours : HH24 (i.e. 09,10...13,14…23,00) in

24

Minutes : MM (i.e. 00,01…59)

Second: SS (i.e. 00,01..59)

Random number : 999 (i.e. 001,002..999)

UniqueTrxRefNo example
PEOPLE20170918134212001

2.2. Interbank Funds Transfer title

fetch
2.2.1.Request Parameters IBFT Title_Fetch

Tag Type Length Mandatory Description

UserID Alpha/Numeric 20 Yes Registered details

in C. iNet and will
be shared with
client by bank

Password Alpha/Numeric 20 Yes Hard coded.

details in C. iNet
and will be shared
with client by bank
Authcode Numeric 8 Yes Hard coded.
details in C. iNet
and will be shared
with client by bank

UniqueRefNo Alpha/Numeric 20 No Optional

Debit_Account_Number Alpha/Numeric 24 No IBAN or

FLEXCUBE format

CreditAccountNumber Alpha/Numeric 24 Yes Bene Account No.

or IBAN

CNIC/NTN No Alpha/Numeric 13 No For validation

through RAAST

BeneBankCode Alpha/Numeric 5 Yes Identification of

bene bank

2.2.2.Response Parameters IBFT Title_Fetch

Tag Type Description

ResponseCode Alpha/Numeric Service Status Code

ResponseDescription Alpha/Numeric Service Status Code Description or Acc Title

UniqueTrxRefNo Alpha/Numeric Unique Transaction No (it is contain
company code + date time + 3

Digit random number)

Date Time format :

Year : YYYY (i.e. 2017,2018 etc)

Month: MON (i.e. JAN, FEB, MAR...DEC)

Day : DD (i.e. 01,02… 28..31)

Hours : HH24 (i.e. 09,10...13,14…23,00) in

24

Minutes : MM (i.e. 00,01…59)

Second: SS (i.e. 00,01..59)

Random number : 999 (i.e. 001,002..999)

UniqueTrxRefNo example
PEOPLE20170918134212001

2.3. Local Funds Transfer Payment

Request (LFT_Payment)
2.3.1.Request Parameters LFT_Payment

Tag Type Length Mandatory Description

UserID Alpha/Numeric 20 Yes Registered

details in C.
iNet and will
be shared
with client by
bank (Maker
 User ID)

Password Alpha/Numeric 20 Yes Hard coded

details in C.
iNet and will
be shared
with client by
bank (Maker
Password)

Authcode Numeric 5 Yes Hard coded

details in C.
iNet and will
be shared
with client by
bank (Maker
Auth Code)

ProductCode Alpha/Numeric 10 Yes LFT or as

per C.iNet

DebitAccountNumber Alpha/Numeric 24 Yes As per setup

done in
C.iNet

CreditAccountNumber Alpha/Numeric 24 Yes Normal

account and
IBAN both

BeneficiaryCNIC_NTN Alpha/Numeric 13 No Without

Dash

BeneficiaryTitle Alpha/Numeric 50 No

Amount Numeric 20 Yes Limits to be

checked
from
authorization
matrix
 defined in
C.iNet

UniqueRefNo Alpha/Numeric 20 Mandatory Must be

Unique for
each
transaction

ReviewerUserID Alpha/Numeric 20 Optional To be

validated in
case
provided in
message

Sig1 User ID Alpha/Numeric 20 Mandatory To be

validated
from
authorization
matrix
defined in
C.iNet

Sig2 User ID Alpha/Numeric 20 Optional/Mandatory To be

validated
from
authorization
matrix
defined in
C.iNet

Publisher User ID Alpha/Numeric 20 Mandatory To be

validated
from
authorization
matrix
defined in
C.iNet

Beneficiary Mobile No Numeric 11 Optional Without

dash. If
provided
Credit
 Confirmation
SMS to be
sent to
Beneficiary

Beneficiary email Alpha/Numeric As per Optional If provided

address standar Credit
d Confirmation
Email to be
sent to
Beneficiary

Add1 Alpha/Numeric 100 Optional Additional

field for
future usage

Add2 Alpha/Numeric 100 Optional Additional

field for
future usage

Add3 Alpha/Numeric 100 Optional Additional

field for
future usage

Add4 Alpha/Numeric 100 Optional Additional

field for
future usage

Add5 Alpha/Numeric 100 Optional Additional

field for
future usage

2.3.2.Response Parameters LFT_Payment

Tag Type Description

ResponseCode Alpha/Numeric Service Status Code

ResponseDescription Alpha/Numeric Service Status Code Description. Success means

transactions received by bank for processing

UniqueTrxRefNo Alpha/Numeric Unique Transaction No (it is contain

company code + date time + 3

Digit random number)

Date Time format :

Year : YYYY (i.e. 2017,2018 etc)

Month: MON (i.e. JAN, FEB, MAR...DEC)

Day : DD (i.e. 01,02… 28..31)

Hours : HH24 (i.e. 09,10...13,14…23,00) in

24

Minutes : MM (i.e. 00,01…59)

Second: SS (i.e. 00,01..59)

Random number : 999 (i.e. 001,002..999)

UniqueTrxRefNo example
PEOPLE20170918134212001

2.4. IBFT Payment Request

(IBFT_Payment)
 2.4.1. Request Parameters IBFT_Payment

Tag Type Length Mandatory Description

UserID Alpha/Numeric 20 Yes Registered

details in C.
iNet and will
be shared
with client by
bank (Maker
User ID)

Password Alpha/Numeric 20 Yes Hard coded

details in C.
iNet and will
be shared
with client by
bank (Maker
Password)

Authcode Numeric 5 Yes Hard coded

details in C.
iNet and will
be shared
with client by
bank (Maker
Auth Code)

ProductCode Alpha/Numeric 10 Yes IBFT or as

per C.iNet

DebitAccountNumber Alpha/Numeric 24 Yes As per setup

done in
C.iNet

CreditAccountNumber Alpha/Numeric 24 Yes Normal

account and
IBAN both

BeneficiaryCNIC_NTN Alpha/Numeric 13 No Without

Dash
BeneficiaryTitle Alpha/Numeric 50 No

Amount Numeric 20 Yes Limits to be

checked
from
authorization
matrix
defined in
C.iNet

BeneficiaryBankCode Numeric 10 Yes

UniqueRefNo Alpha/Numeric 20 Mandatory Must be

Unique for
each
transaction

ReviewerUserID Alpha/Numeric 20 Optional To be

validated in
case
provided in
message

Sig1 User ID Alpha/Numeric 20 Mandatory To be

validated
from
authorization
matrix
defined in
C.iNet

Sig2 User ID Alpha/Numeric 20 Optional/Mandatory To be

validated
from
authorization
matrix
defined in
C.iNet

Publisher User ID Alpha/Numeric 20 Mandatory To be

validated
 from
authorization
matrix
defined in
C.iNet

Beneficiary Mobile No Numeric 11 Optional Without

dash. If
provided
Credit
Confirmation
SMS to be
sent to
Beneficiary

Beneficiary email Alpha/Numeric As per Optional If provided

address standar Credit
d Confirmation
Email to be
sent to
Beneficiary

Add1 Alpha/Numeric 100 Optional Additional

field for
future usage

Add2 Alpha/Numeric 100 Optional Additional

field for
future usage

Add3 Alpha/Numeric 100 Optional Additional

field for
future usage

Add4 Alpha/Numeric 100 Optional Additional

field for
future usage

Add5 Alpha/Numeric 100 Optional Additional

field for
future usage
 2.4.2. Response Parameters IBFT_Payment

Tag Type Description

ResponseCode Alpha/Numeric Service Status Code

ResponseDescription Alpha/Numeric Service Status Code Description. Success means

transactions received by bank for processing

UniqueTrxRefNo Alpha/Numeric Unique Transaction No (it is contain

company code + date time + 3

Digit random number)

Date Time format :

Year : YYYY (i.e. 2017,2018 etc)

Month: MON (i.e. JAN, FEB, MAR...DEC)

Day : DD (i.e. 01,02… 28..31)

Hours : HH24 (i.e. 09,10...13,14…23,00) in

24

Minutes : MM (i.e. 00,01…59)

Second: SS (i.e. 00,01..59)

Random number : 999 (i.e. 001,002..999)

UniqueTrxRefNo example
PEOPLE20170918134212001
 3. Transaction Status
Upon completion of transaction and status update in Corporate iNet for both IFT/IBFT
system should automatically send transaction status to customer through API message
details given below

3.1. Method 1
Customer will host this API and AKBL will consume this API and transmit payment
confirmation status upon completion of payment cycle

3.1.1. Transaction Status Parameters.

Tag Type Description

UserID Alpha/Numeric To be provided by client and hard coded at

our end

Password Alpha/Numeric To be provided by client and hard coded at

our end

UniqueRefNo Alpha/Numeric Ref no of the transaction whose cycle is

completed and its the same no provided by
customer at the time of payment request.

Reason Alpha/Numeric Success in case of paid status else reason as per

Corporate iNet DB

TransactionStatus Alpha/Numeric Status as per details in Corporate iNet DB. It can

be Paid/Unpaid
 UniqueTrxRefNo Alpha/Numeric Unique Transaction No (it is contain
company code + date time + 3

Digit random number)

Date Time format :

Year : YYYY (i.e. 2017,2018 etc)

Month: MON (i.e. JAN, FEB, MAR...DEC)

Day : DD (i.e. 01,02… 28..31)

Hours : HH24 (i.e. 09,10...13,14…23,00) in 24

Minutes : MM (i.e. 00,01…59)

Second: SS (i.e. 00,01..59)

Random number : 999 (i.e. 001,002..999)

UniqueTrxRefNo example
PEOPLE20170918134212001

3.2. Method 2
In this scenario AKBL will be hosting this API message and customer will consume this API
message to identify transaction status

3.2.1. Request Parameters Transactions Status

Tag Type Length Mandatory Description

UserID Alpha/Numeric 20 Yes Registered details

in C. iNet and will
be shared with
client by bank
(Maker User ID)
Password Alpha/Numeric 20 Yes Hard coded details
in C. iNet and will
be shared with
client by bank
(Maker Password)

Authcode Numeric 5 Yes Hard coded details

in C. iNet and will
be shared with
client by bank
(Maker Auth Code)

UniqueRefNo Alpha/Numeric 20 Mandatory UniqueRefNo

which was used at
the time of
payment

3.2.2. Response Parameters Transaction Status

Tag Type Description

ResponseCode Alpha/Numeric Service Status Code

TransactionStatus Alpha/Numeric Paid / Unpaid

Reason Alpha/Numeric Success in case of paid status else reason as per

Corporate iNet DB
UniqueTrxRefNo Alpha/Numeric Unique Transaction No (it is contain
company code + date time + 3

Digit random number)

Date Time format :

Year : YYYY (i.e. 2017,2018 etc)

Month: MON (i.e. JAN, FEB, MAR...DEC)

Day : DD (i.e. 01,02… 28..31)

Hours : HH24 (i.e. 09,10...13,14…23,00) in 24

Minutes : MM (i.e. 00,01…59)

Second: SS (i.e. 00,01..59)

Random number : 999 (i.e. 001,002..999)

UniqueTrxRefNo example
PEOPLE20170918134212001

4. Details of Response Codes

Response Code Description

-1 Dynamic error of web service exception

00 Success

01 Invalid action performed

02 Invalid Account Number

03 Invalid Credentials UserID / Password

04 Invalid authentication Code

05 Response Time out

06 Title Fetch time out

07 Unknown Failure

08 Duplicate ref No.

Details of Response Codes (IBFT Title_Fetch)

Response Code Description

00 Success

Invalid Action performed

01 Invalid Account Number

02 Invalid Credentials UserID / Password

03 Invalid authentication Code

04 Response Time out

05 Title Fetch time out

06 Unknown Failure

07 Link Down