Fields and values

Standard fields and values

*Note:  M=Mandatory, O=Optional

Field

M/O

Description

Expected Value

Format

product_id

M

Product Identifier for PAYDirect.

<to be provided>

Numeric

amount

M

Transaction amount in small (kobo or cents) denomination. E.g., 200000 for 2,000.00

<variable>

alphanumeric

currency

M

Currency of the transaction

566 (For Naira)

alphanumeric

site_redirect_url

M

URL of the page on your web site/portal user is to be redirected to after payment. You may want to add encrypted authentication information to allow a user renter the web site/portal transparently without being challenged

<variable>

alphanumeric

txn_ref

M

Transaction Reference Number. This Reference Number must be generated by your web site/portal and a unique value must be sent for each transaction

<variable>

alphanumeric

hash

M

A Hashed value of selected combined parameters. See How to compute the request hash.

<variable>

date time

pay_item_id

M

PAYDirect Payment Item ID

<to be provided>

numeric

site_name

O

Internet site name of the web site/ portal from which http post is coming from. E.g. www.abc.com. This internet site name will be authenticated.

<to be provided>

alphanumeric

cust_id

O

Unique Customer Identification Number

<variable>

alphanumeric

cust_id_desc

O

Customer Identification Number description. A descriptive name/label for Customer Identification Number above.

<variable>

alphanumeric

cust_name

O

Customer Name

<variable>

alphanumeric

cust_name_desc

O

Customer Name Description. A descriptive name/label for Customer Name above.

<variable>

alphanumeric

pay_item_name

O

PAYDirect Payment Item Name

<to be provided>

alphanumeric

local_date_time

O

Local Transaction Date Time: DD-MMM-YY HH:MM:SS

<variable>

date time

Advanced fields and values

Field

Description

Expected Value

Format

payment_params

For miscellaneous payment parameters

<variable>

alphanumeric

xml_data

Any other data that needs to be sent will be packaged as xml and put in this field

<variable>

xml

‘xml_data’ format

<payment_item_detail>
<item_details detail_ref=“XXXAFTXXX” institution=“ABC” sub_location=““location=““>
<item_detail item_id=“1” item_name=“Butter” item_amt=“0000” bank_id=“0” acct_num=“435678” />
<item_detail item_id=“2” item_name=“Juice” item_amt=“0000” bank_id=“9” acct_num=“6010153866” />
</item_details>
</payment_item_detail>

The addition of the item_amt in the split data must be the equal to the amount-transaction fee
Hence (item_amt+item_amt+…item_amt) = (amount-transaction fee). This is to say that you would like to split a specified amount after the transaction fee has been deducted.

Sample request

<form name="form1" action="https://testwebpay.interswitchng.com/test_paydirect/pay method="post">
    <input name="product_id" type="hidden" value="XX" />
    <input name="amount" type="hidden" value="XXXXXXX" />
    <input name="currency" type="hidden" value="566" />
    <input name="site_redirect_url" type="hidden" value="http://abc.com/new_page/getresponse.aspx?echo=" />
    <input name="site_name" type="hidden" value="http://www.abc.com" />
    <input name="cust_id" type="hidden" value="a" />
    <input name="cust_id_desc" type="hidden" value="Value Name" />
    <input name="cust_name" type="hidden" value="Name <B>Surname</B>" />
    <input name="cust_name_desc" type="hidden" value="Full name" />
    <input name="txn_ref" type="hidden" value=" XXXAFTXXX”" />
    <input name="pay_item_id" type="hidden" value="XXXXX" />
    <input name="pay_item_name" type="hidden" value="Name of Fees/Payment" />
    <input name="local_date_time" type="hidden" value="" />
    <input name="hash" type="hidden" value="BB292DF9268F05CB9CBBC5E0C13CC1B13ACA34DC" />
    <input name="payment_params" type="hidden" value="payment_split" />
    <input name="xml_data" type="hidden" value='<payment_item_detail>
    <item_details detail_ref=“XXXAFTXXX” institution=“ABC” sub_location=““location=““>
    <item_detail item_id=“1” item_name=“Butter” item_amt=“0000” bank_id=“0” acct_num=“435678” />
    <item_detail item_id=“2” item_name=“Juice” item_amt=“0000” bank_id=“9” acct_num=“6010153866” />
    </item_details>
    </payment_item_detail>' />