Get Payments By Invoice

Call GetPaymentsByInvoice API to retrieve list of payments associated to a invoice. Payment details are retrieved in xml format. This API receives GetPaymentsbyinvoiceXML as input and renders Response XML as output.

Syntax and Arguments

public string GetPaymentsByInvoice (string  GetPaymentsbyinvoiceXML, string ReferenceNo)

Input Arguments

Argument Name

Data Type

Is Mandatory

Description

GetPaymentsbyinvoiceXML

String

Yes

An XML string that contains invoice number.

ReferenceNo

String

Yes

An unique number provided to identify the request

GetInvoicesByPaymentXML

Request XML Elements

Element Name

Data Type

Length
(Bytes)

Is Mandatory

Description

INVOICE

String

16

Y

Invoice number.

Request XML Format

<REQUESTINFO>

<KEY_NAMEVALUE>

<KEY_NAME>INVOICE</KEY_NAME>

<KEY_VALUE>INV100</KEY_VALUE>

                        </KEY_NAMEVALUE>

</REQUESTINFO>

Output Parameters

Parameter Name

Data Type

Description

TRANSACTIONNO

String

An unique number generated for each request

ERRORNO

Integer

Returns Error Number

need to add.

MESSAGE

String

Returns "Success" or "Failed"

DATE

Date

Payment date

AMOUNT

Decimal

Payment amount

CUSTOMERNO

String

Customer number

CURRENCYCODE

String

Currency code

RECEIPTNO

String

Payment receipt number

REMARKS

String

Notes

Response XML Format

<RESPONSEINFO>

<STATUS>

      <TRANSACTIONNO>2551</TRANSACTIONNO>

      <ERRORNO>0</ERRORNO>

      <MESSAGE>SUCCESS</MESSAGE>

</STATUS> 

<DOCUMENT>

        <DOCHDR>

                 <DOCTYPE> PAYMENT</DOCTYPE>

                     <DOCNO> 81</DOCNO>

                    <CUSTOMERNO> 178</CUSTOMERNO>

                    <DATE> 04/27/2010</DATE>

                    <AMOUNT> 5.00</AMOUNT>

                    <CURRENCYCODE> RS</CURRENCYCODE>

                    <REMARKS> </REMARKS>

         </DOCHDR>

         <DOCBODY>

                    <PAYMENT>

                                    <PAYMODE MODE= "CHEQUE">

                                                    <CHEQUE NO> 123456</CHEQUE NO>

                                                    <CHEQUE DATE> 04/27/2010</CHEQUE DATE>                                                      </PAYMODE>

                                    <RECEIPTNO> </RECEIPTNO>

                    </PAYMENT>

     </DOCBODY>

</DOCUMENT>

<DOCUMENT>

          <DOCHDR>

                    <DOCTYPE> PAYMENT</DOCTYPE>

                     <DOCNO> 80</DOCNO>

                    <CUSTOMERNO> 86</CUSTOMERNO>

                    <DATE> 04/27/2010</DATE>

                    <AMOUNT> 500.00</AMOUNT>

                    <CURRENCYCODE> RS</CURRENCYCODE>

                    <REMARKS> </REMARKS>

           </DOCHDR>

           <DOCBODY>

                    <PAYMENT>

                                    <PAYMODE MODE= "CASH"/>

                                    <RECEIPTNO> </RECEIPTNO>

                       </PAYMENT>

          </DOCBODY>

</DOCUMENT>

<DOCUMENT>

               <DOCHDR>

                          <DOCTYPE>PAYMENT</DOCTYPE>

                           <DOCNO> 79</DOCNO>

                             <CUSTOMERNO>CUST100</CUSTOMERNO>

                            <DATE>01-04-2010</DATE>

                           <AMOUNT>200 </AMOUNT>

                            <CURRENCYCODE>USD</CURRENCYCODE>

                            <REMARKS>Testing</REMARKS>

                </DOCHDR>

               <DOCBODY>

                           <PAYMENT>

                                         <PAYMODE   MODE=”CREDIT  CARD”>

                                                  <AUTHCODE>53441534</AUTHCODE>

                                                  <EXTTRANSID>1425239</EXTTRANSID>

                                          </PAYMODE>                              

                                          <RECEIPTNO>19782545</RECEIPTNO>

                             </PAYMENT>

              </DOCBODY>

</DOCUMENT>

           </RESPONSEINFO>

Note: Refer to Error Codes and Description to view errors in detail.