This method returns the list of payment request information for a given vendor id or invoice number. The payment request key returned from this method can be inserted in the ConfirmPayment method when confirming payment information.

Edit
Edit
Edit
Parameter Data Type Description Required Details
providerid
String
Unique provider identifier
Yes
length: 36
Possible Values:
fab15deb-0f1e-4edf-a1d7-b4dc64d9ad3b
username
String
Username
Yes
length:100
password
String
Password
Yes
licensekey
String
License Key
Yes
system
String
System name
Yes
length: 3
Possible Values:
osa
Edit
Parameter Data Type Description Required Details
VendorID
String
Unique vendor ID to retreive payment request.
No
Possible Values: Use the GetAPVendor method to find the vendorid.
InvoiceNumber
String
Invoice number to retrieve payment request.
No
Possible Values: Use the GetInvoice method to retrieve the invoice number.
password
String
Unique Company ID you have access to retreive payment information.
Yes
Edit
Edit
Edit
Parameter Data Type Description
Code
String
Error code (if applicable)
Success
String
Success indentifier
Message
String
Successful or error message
Edit
Parameter Data Type Description
PaymentRequestKey
String
Unqiue payment request key
PaymentAmount
String
Total amount of payment made
CheckNumber
String
Check number of the payment
Status
String
Payment Request Status
Currency
String
Currency of the payment
InvoiceNumber
String
Invoice number for the selected payment transaction
LocationID
String
Unique location ID. You can use the GetLocationList to retreive the details of this location ID
PaymentMethod
String
Payment method of the payment request
Edit
Edit
				
					<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:tem="http://tempuri.org/">
    <soapenv:Header/>
    <soapenv:Body>
        <tem:ConfirmPayment>
         <tem:auth>
            <tem:providerid>*********************</tem:providerid>
            <tem:username>username</tem:username>
            <tem:password>password</tem:password>
            <tem:licensekey>*********************</tem:licensekey>
            <tem:system>osa</tem:system>
         </tem:auth>
            <tem:ConfirmPayment>
                <tem:CompanyUserID>companyuserid</tem:CompanyUserID>
                <tem:CompanyPassword>companypassword</tem:CompanyPassword>
                <tem:PaymentRequestKey>423710</tem:PaymentRequestKey>
                <tem:PropertyID>companyid</tem:PropertyID>
            </tem:ConfirmPayment>
        </tem:ConfirmPayment>
    </soapenv:Body>
</soapenv:Envelope>				
			
Edit
				
					<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <ConfirmPaymentResponse xmlns="http://tempuri.org/">
         <ConfirmPaymentResult>
            <ConfirmPayment xmlns="">
               <MethodResult>
                  <Success>true</Success>
                  <Code>RPX-00000</Code>
                  <Message>Payment Request Confirmed</Message>
               </MethodResult>
            </ConfirmPayment>
         </ConfirmPaymentResult>
      </ConfirmPaymentResponse>
   </s:Body>
</s:Envelope>				
			
Edit
Click here to add content.