Next: Approval For Launch

Authorization Header :

Header Name: Authorization
Header Value Format: ‘Basic <Base 64 Encoded value <Merchant Key:Application Key>>’

E.g. If merchant key is ‘hac42JpvdXT9Jb9bVzKuzR’ and application key is ‘7ADYdcB3xGxw3psxqKx57m’ then the header value is going to be: ‘Basic aGFjNDJKcHZkWFQ5SmI5YlZ6S3V6Ujo3QURZZGNCM3hHeHczcHN4cUt4NTdt’

Steps to arrive at this value (using merchant-key (hac42JpvdXT9Jb9bVzKuzR) and application-key (7ADYdcB3xGxw3psxqKx57m):

1. Concatenate merchant-key followed by application-key separated by a colon delimiter ‘:’
Result: hac42JpvdXT9Jb9bVzKuzR:7ADYdcB3xGxw3psxqKx57m

2. The value above needs to be encoded in Base-64 format.
Result: aGFjNDJKcHZkWFQ5SmI5YlZ6S3V6Ujo3QURZZGNCM3hHeHczcHN4cUt4NTdt

3. Concatenate the string ‘Basic’ with the Base-64 value generated in step 2 separated by a space character ‘ ‘.
Result: ‘Basic aGFjNDJKcHZkWFQ5SmI5YlZ6S3V6Ujo3QURZZGNCM3hHeHczcHN4cUt4NTdt’

4. Set the resultant string generated in step 3 as the value for the Header with name: ‘Authorization’ .

 

Get payment status for a particular transaction for server to server integration:

This API is used to get the payment status for a given request token id.

URL:

https://api.ipayy.com/v001/c/pay/getpaymentstatus

Authorization Header must be generated as mentioned above and passed in the request.

Request

Request XML:

<web-payment-status-request>

<request-token-id></request-token-id>

</web-payment-status-request>

 

Request Parameters:

Request ParameterDescription
request-token-idRequest ID used for the transaction

Success Response



Response XML:

Success Response XML :

Returns a success response for the specified request

<payment-response>
  <response-parameter-map>
    <entry>
      <key>msisdn</key>
      <value>####</value>
    </entry>
    <entry>
      <key>application-name</key>
      <value>####</value>
    </entry>
    <entry>
      <key>amount-charged</key>
      <value>10.00</value>
    </entry>
    <entry>
      <key>payment-status</key>
      <value>SUCCESS</value>
    </entry>
    <entry>
      <key>transaction-id</key>
      <value>66149949</value>
    </entry>
    <entry>
      <key>request-token-id</key>
      <value>####</value>
    </entry>
    <entry>
      <key>customer-code</key>
      <value>####I</value>
    </entry>
    <entry>
      <key>currency</key>
      <value>INR</value>
    </entry>
  </response-parameter-map>
</payment-response>

 

 

Failure Response

Return an error response with the error-code and error-description.

Please refer to the [Error Codes] for more details

Failure Response XML :

<payment-response>
<response-parameter-map>
<entry>
 <key>msisdn</key>
<value>91xxxxxxxxxx</value>
</entry>
<entry>
<key>application-name</key>
<value>test</value>
</entry>
<entry>
<key>amount-charged</key>
<value>0.00</value>
</entry>
<entry>
<key>payment-status</key>
<value>FAILURE</value>
</entry>
<entry>
<key>failure-reason</key>
<value>LOW_BALANCE</value>
</entry>
<entry>
<key>transaction-id</key>
<value>66152011</value>
</entry>
<entry>
<key>request-token-id</key>
<value>abcd1234</value>
</entry>
<entry>
<key>customer-code</key>
<value>xxxxxxxx</value>
</entry>
<entry>
<key>currency</key>
<value>INR</value>
</entry>
</response-parameter-map>
</payment-response>

 

 

Get payment status for a particular customer for web/SDK integration :

This API is used to get the payment status for a given request token id.

URL: https://api.ipayy.com/v001/c/os/getpaymentstatus

Authorization Header must be generated as mentioned above and passed in the request.

Request

Request XML:

<server-payment-status-request>
<request-id></request-id>
</server-payment-status-request>

 

Response



Response XML:

Returns a success response for the specified request

<server-payment-status-response>
<request-id></request-id>
<status>SUCCESS</status>
<transaction-id></transaction-id>
<customer-code></customer-code>
</server-payment-status-response>

 

 

Get the transaction details done by a customer :

This API is for retrieving the list of transactions The API would allow pagination with start and maxRows (subject to upper limits being set to both the parameters) .

URL: https://api.ipayy.com/v001/c/txn/gettransactionbycustomer

This is available in 2 different variants :

Authorization Header must be generated as mentioned above and passed in the request.

Request

Request XML:

<transactions-by-customer-request>

<customer-code></customer-code>

<start></start>

<max-results></max-results>

</transactions-by-customer-request>

Sample Request :

Request Parameters:

Request Parameter Description
start Pagination start for the result set. Starting value = 0
max-results No of results from the start point
customercode customer code as passed in js tracking

Response

<transaction-by-customer-response>

<merchant-key></merchant-key>

<application-name></application-name>

<status>success</status>

<customer-code></customer-code>

<transaction-list>

<transaction>

<transaction-id></transaction-id>

<transaction-date class=”sql-timestamp”></transaction-date>

<transaction-state></transaction-state>

</transaction>

</transaction-list>

<total-count></total-count>

<current-size></current-size>

</transaction-by-customer-response>

Sample Response :

<error>

<http-status-code></http-status-code>

<error-response-code></error-response-code>

<error-description></error-description>

</error>

Sample Response:

Authorization Header must be generated as mentioned above and passed in the request.

Request

Sample Request XML:

<transactions-by-customer-request>

<msisdn></msisdn>

<start></start>

<max-results></max-results>

</transactions-by-customer-request>

Request Parameters:

Request Parameter Description
start Pagination start for the result set. Starting value = 0
max-results No of results from the start point
msisdn User msisdn need to be passed, if js tracking respons is false

Response

Response XML:

<transaction-by-customer-response>
<merchant-key></merchant-key>
<application-name></application-name>
<status>success</status>
<customer-code></customer-code>
<transaction-list>
<transaction>
<transaction-id></transaction-id>
<transaction-date ></transaction-date>
<transaction-state></transaction-state>
</transaction>
</transaction-list>
<total-count></total-count>
<current-size></current-size>
</transaction-by-customer-response>

Response XML:

<error>
<http-status-code></http-status-code>
<error-response-code></error-response-code>
<error-description></error-description>
</error>

 

Get Transaction Details :

This API is used to get the transaction details for a  given transaction id along with the iPayy credentials.

URL: https://api.ipayy.com/v001/c/txn/gettransactiondetails

Authorization Header must be generated as mentioned above and passed in the request.


Request


Request XML:

<transaction-detail-request>
<transaction-id></transaction-id>
</transaction-detail-request>

Sample XML:

Request Parameters:

Request ParameterDescription
tranasction-id transaction id of billing


Response

Response XML:

<transaction-detail-response>
<merchant-key></merchant-key>
<application-name></application-name>
<status></status>
<customer-code></customer-code>
<transaction-date ></transaction-date>
<amount></amount>
<currency></currency>
<request-id></request-id>
<transaction-state></transaction-state>
<billing-response></billing-response>
<preferred-price></preferred-price>
<operator-name></operator-name>
<application-launch-status></application-launch-status>
<merchant-launch-status></merchant-launch-status>
<items>
<item-details>
<price></price>
<item-id></item-id>
<item-name></item-name>
</item-details>
</items>
<support-email></support-email>
<support-phone></support-phone>
</transaction-detail-response>

Sample Response:

Response XML:

<error>
<http-status-code></http-status-code>
<error-response-code></error-response-code>
<error-description></error-description>
</error>

Sample Response:


Next: Approval For Launch