Versions Compared

Version Old Version 12 New Version 13
Changes made by

Kin Chee (Unlicensed)

chitra.b (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Customer Payment

HistoryThe GetPaymentHistoryByStatusForDateRange returns a list of payments and provides the associated schedule between a specified date range by status for the current user

Use the GetCustomerPaymentByStatusForDateRange to get the payment schedule with payment status found in between the date range provided in the request.

Info

This API can be used only for gateway clients.

Sample request

Code Block
languagexml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:deb="Debitsuccess.WebServices.WCF" xmlns:deb1="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:deb2="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core.RequestMessages">
   <soapenv:Header/>
   <soapenv:Body>
      <deb:GetPaymentHistoryByStatusForDateRange>GetCustomerPaymentByStatusForDateRange>
         <deb:request>
            <deb1:DateCreated>2020DateCreated>2021-08-10T00:00:00<01-14</deb1:DateCreated>
            <deb1:Id>123</deb1:Id>
            <deb1:RequestInitiator>ReqInit1<RequestInitiator>Kin123</deb1:RequestInitiator>
            <deb1:User>
               <deb1:Id>123<Password>#Password</deb1:Id>Password>
               <deb1:Password>#password<Username>Username</deb1:Password>Username>
               <deb1:Username>username<</deb1:Username>User>
            </deb1:User>             <deb2:ContractPrefix>QP8OM<ContractPrefix>QP4EE</deb2:ContractPrefix>
            <deb2:EndDate>2020-0302-26<14</deb2:EndDate>
            <deb2:StartDate>2020-0301-25<15</deb2:StartDate>
            <deb2:Status>Settled<Status>Unattempted</deb2:Status>
         </deb:request>
      </deb:GetPaymentHistoryByStatusForDateRange>GetCustomerPaymentByStatusForDateRange>
   </soapenv:Body>
</soapenv:Envelope>

Sample

Response

response

Code Block
languagexml
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="606611a9816f44fa-b30cef70-4b254877-a2e3a827-8f4c847becf488c80e811c13" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
   </s:Header>
   <s:Body>
      <GetPaymentHistoryByStatusForDateRangeResponse<GetCustomerPaymentByStatusForDateRangeResponse xmlns="Debitsuccess.WebServices.WCF">
         <GetPaymentHistoryByStatusForDateRangeResult<GetCustomerPaymentByStatusForDateRangeResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core.ResponseMessages" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <DateCreated xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">2020>2021-0801-11T1114T10:1155:0200.31565752806506+1213:00</DateCreated>
            <Id xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">2483ea0b>06dbe0e0-d1a30dcb-484c4496-98d18f2b-9a13e3c46de3<c458e1fbc494</Id>
            <ResponseNotes xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">
               <ResponseMessageNote>
                  <Code>00</Code>
                  <Note>Success</Note>
                  <NoteType>Info</NoteType>
               </ResponseMessageNote>
            </ResponseNotes>
            <Status xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">Succeed</Status>
            <a:AccountsPaymentSchedules xmlns:b="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core.Entities">
               <b:AccountWithPayments>PayScheduleWithStatus>
                  <Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
                  <b:AccountReferenceNo>QP8OM888812</b:AccountReferenceNo>Description>4d74bd9d-3b6f-46df-a23b-203b51634a96</b:Description>
                  <b:ExternalAccountReferenceNo>5DBC9C39ExternalIdentifier>4d74bd9d-5C6B3b6f-4B1D46df-8652a23b-0DF2F49E120A<203b51634a96</b:ExternalAccountReferenceNo>ExternalIdentifier>
                  <b:Payments>:Installment>209.71</b:Installment>
                  <b:PaymentStatus>Unattempted</b:PaymentStatus>
          <b:PaymentWithPaySchedule>        <b:ScheduleId>61087707</b:ScheduleId>
                <Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/> <b:StartDate>2020-01-30T00:00:00</b:StartDate>
                   <b:StatusDate>2020-01-30T18:21:17.91</b:StatusDate>
    <b:PaySchedules>            </b:PayScheduleWithStatus>
               <b:PayScheduleQik>
       PayScheduleWithStatus>
                      <Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
                              <b:Description>2a2e3ba7-cf75-4358-b031-d4a9301eaf42<<b:Description>4d74bd9d-3b6f-46df-a23b-203b51634a96</b:Description>
     
                        <b:ExternalIdentifier>2a2e3ba7ExternalIdentifier>4d74bd9d-cf753b6f-435846df-b031a23b-d4a9301eaf42<203b51634a96</b:ExternalIdentifier>
                  <b:Installment>209.71</b:Installment>
                  <b:InRetry>false<PaymentStatus>Unattempted</b:InRetry>PaymentStatus>
                  <b:ScheduleId>61087707</b:ScheduleId>
           <b:Installment>34.11</b:Installment>           <b:StartDate>2020-01-30T00:00:00</b:StartDate>
                    <b:Paid>34.11<<b:StatusDate>2020-01-31T06:07:15.223</b:Paid>StatusDate>
               </b:PayScheduleWithStatus>
               <b:PaymentStatus>Settled</b:PaymentStatus>PayScheduleWithStatus>
                  <Id       i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
    <b:ScheduleId>64753345</b:ScheduleId>              <b:Description>4d74bd9d-3b6f-46df-a23b-203b51634a96</b:Description>
                  <b:StartDate>2020-03-21T00:00:00<ExternalIdentifier>4d74bd9d-3b6f-46df-a23b-203b51634a96</b:StartDate>ExternalIdentifier>
                  <b:Installment>209.71</b:Installment>
                  <b:StatusDate>2020-03-25T10:57:50.023<PaymentStatus>Unattempted</b:StatusDate>PaymentStatus>
                  <b:ScheduleId>61087707</b:ScheduleId>
            </b:PayScheduleQik>      <b:StartDate>2020-01-30T00:00:00</b:StartDate>
                  <<b:StatusDate>2020-02-03T10:04:04.657</b:PaySchedules>StatusDate>
               </b:PayScheduleWithStatus>
        <b:PaymentAmount>34.11</b:PaymentAmount>    </a:PaymentSchedules>
         </GetCustomerPaymentByStatusForDateRangeResult>
      </GetCustomerPaymentByStatusForDateRangeResponse>
   <b:PaymentCode>OneOffPayment<</bs:PaymentCode>
                        <b:PaymentErrorCode>NoError</b:PaymentErrorCode>
                        <b:PaymentId>1529954115</b:PaymentId>
                        <b:PaymentType>DirectDebit</b:PaymentType>
                     </b:PaymentWithPaySchedule>
                  </b:Payments>
               </b:AccountWithPayments>
               <b:AccountWithPayments>
                  <Id i:nil="true" xmlnsBody>
</s:Envelope>

Payment History

The GetPaymentHistoryByStatusForDateRange returns a list of payments and provides the associated schedule between a specified date range by status for the current user.

Info

This API can be used only for gateway clients.

Note

This call has been deprecated. For a new implementation we recommend using GetCustomerPaymentByStatusForDateRange instead.

Sample request

Code Block
languagexml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:deb="Debitsuccess.WebServices.WCF" xmlns:deb1="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:deb2="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core.RequestMessages"/>
   <soapenv:Header/>
   <soapenv:Body>
      <deb:GetPaymentHistoryByStatusForDateRange>
   <b:AccountReferenceNo>QP8OM888797</b:AccountReferenceNo>      <deb:request>
            <b<deb1:ExternalAccountReferenceNo>864C4E06DateCreated>2020-527B-4242-9DF9-F475C999F189</b:ExternalAccountReferenceNo>08-10T00:00:00</deb1:DateCreated>
                  <b:Payments><deb1:Id>123</deb1:Id>
            <deb1:RequestInitiator>ReqInit1</deb1:RequestInitiator>
        <b:PaymentWithPaySchedule>    <deb1:User>
               <deb1:Id>123</deb1:Id>
    <Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>         <deb1:Password>#password</deb1:Password>
               <b:PaySchedules>
 <deb1:Username>username</deb1:Username>
            </deb1:User>
            <b:PayScheduleQik><deb2:ContractPrefix>QP8OM</deb2:ContractPrefix>
            <deb2:EndDate>2020-03-26</deb2:EndDate>
                 <Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
<deb2:StartDate>2020-03-25</deb2:StartDate>
            <deb2:Status>Settled</deb2:Status>
         </deb:request>
      <b:Description>757757c3-6f28-40e0-b7df-29d09807caa7</b:Description></deb:GetPaymentHistoryByStatusForDateRange>
   </soapenv:Body>
   </soapenv:Envelope>

Sample Response

Code Block
languagexml
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="606611a9-b30c-4b25-a2e3-8f4c847becf4" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
   </s:Header>
     <b:ExternalIdentifier>757757c3-6f28-40e0-b7df-29d09807caa7</b:ExternalIdentifier><s:Body>
      <GetPaymentHistoryByStatusForDateRangeResponse xmlns="Debitsuccess.WebServices.WCF">
         <GetPaymentHistoryByStatusForDateRangeResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core.ResponseMessages" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <DateCreated <b:InRetry>false</b:InRetry>xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">2020-08-11T11:11:02.3156575+12:00</DateCreated>
               <Id xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">2483ea0b-d1a3-484c-98d1-9a13e3c46de3</Id>
              <b:Installment>192.27</b:Installment><ResponseNotes xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">
                     <ResponseMessageNote>
        <b:Paid>192.27</b:Paid>            <Code>00</Code>
                  <b:PaymentStatus>Settled</b:PaymentStatus><Note>Success</Note>
                  <NoteType>Info</NoteType>
           <b:ScheduleId>65084988</b:ScheduleId>    </ResponseMessageNote>
            </ResponseNotes>
            <Status <b:StartDate>2020-03-24T00:00:00</b:StartDate>xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">Succeed</Status>
            <a:Accounts xmlns:b="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core.Entities">
                 <b:StatusDate>2020-03-26T10:57:47.12</b:StatusDate>AccountWithPayments>
                  <Id    i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
    </b:PayScheduleQik>              <b:AccountReferenceNo>QP8OM888812</b:AccountReferenceNo>
          </b:PaySchedules>          <b:ExternalAccountReferenceNo>5DBC9C39-5C6B-4B1D-8652-0DF2F49E120A</b:ExternalAccountReferenceNo>
               <b:PaymentAmount>192.27</b:PaymentAmount>   <b:Payments>
                     <b:PaymentCode>OneOffPayment</b:PaymentCode>PaymentWithPaySchedule>
                        <Id  <b:PaymentErrorCode>NoError</b:PaymentErrorCode>i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
                        <b:PaymentId>1530035833</b:PaymentId>PaySchedules>
                        <b:PaymentType>DirectDebit</b:PaymentType>   <b:PayScheduleQik>
                  </b:PaymentWithPaySchedule>            <Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
    </b:Payments>                </b:AccountWithPayments>             </a:Accounts><b:Description>2a2e3ba7-cf75-4358-b031-d4a9301eaf42</b:Description>
         </GetPaymentHistoryByStatusForDateRangeResult>
      </GetPaymentHistoryByStatusForDateRangeResponse>    </s:Body>
</s:Envelope>

Customer Payment

Use the GetCustomerPaymentByStatusForDateRange to get the payment schedule with payment status found in between the date range provided in the request.

Info

This API can be used only for gateway clients.

Sample request

Code Block
languagexml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:deb="Debitsuccess.WebServices.WCF" xmlns:deb1="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:deb2="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core.RequestMessages">
   <soapenv:Header/>
   <soapenv:Body>            <b:ExternalIdentifier>2a2e3ba7-cf75-4358-b031-d4a9301eaf42</b:ExternalIdentifier>
                              <b:InRetry>false</b:InRetry>
                              <b:Installment>34.11</b:Installment>
       <deb:GetCustomerPaymentByStatusForDateRange>          <deb:request>             <deb1:DateCreated>2021-01-14</deb1:DateCreated><b:Paid>34.11</b:Paid>
                 <deb1:Id>123</deb1:Id>             <deb1<b:RequestInitiator>Kin123<PaymentStatus>Settled</deb1b:RequestInitiator>PaymentStatus>
              <deb1:User>                <deb1<b:Password>#Password<ScheduleId>64753345</deb1b:Password>ScheduleId>
                 <deb1:Username>Username</deb1:Username>             </deb1:User><b:StartDate>2020-03-21T00:00:00</b:StartDate>
                 <deb2:ContractPrefix>QP4EE</deb2:ContractPrefix>             <deb2<b:EndDate>2020StatusDate>2020-02-14</deb2:EndDate>03-25T10:57:50.023</b:StatusDate>
              <deb2:StartDate>2020-01-15</deb2:StartDate>             <deb2:Status>Unattempted<</deb2:Status>b:PayScheduleQik>
             </deb:request>       </deb:GetCustomerPaymentByStatusForDateRange>    </soapenvb:Body>
</soapenv:Envelope>

Sample response

Code Block
languagexml
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">PaySchedules>
               <s:Header>       <ActivityId CorrelationId="816f44fa-ef70-4877-a827-88c80e811c13" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId> <b:PaymentAmount>34.11</b:PaymentAmount>
       </s:Header>    <s:Body>       <GetCustomerPaymentByStatusForDateRangeResponse xmlns="Debitsuccess.WebServices.WCF">     <b:PaymentCode>OneOffPayment</b:PaymentCode>
    <GetCustomerPaymentByStatusForDateRangeResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core.ResponseMessages" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">                  <DateCreated xmlns="http<b://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">2021-01-14T10:55:00.2806506+13:00</DateCreated>PaymentErrorCode>NoError</b:PaymentErrorCode>
                        <b:PaymentId>1529954115</b:PaymentId>
            <Id xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">06dbe0e0-0dcb-4496-8f2b-c458e1fbc494</Id>           <b:PaymentType>DirectDebit</b:PaymentType>
 <ResponseNotes xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">                <ResponseMessageNote>   </b:PaymentWithPaySchedule>
               <Code>00</Code>   </b:Payments>
               <Note>Success<</Note>b:AccountWithPayments>
               <b:AccountWithPayments>
    <NoteType>Info</NoteType>              <Id  </ResponseMessageNote>i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
                  <b:AccountReferenceNo>QP8OM888797</b:AccountReferenceNo>
    </ResponseNotes>             <Status xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">Succeed</Status><b:ExternalAccountReferenceNo>864C4E06-527B-4242-9DF9-F475C999F189</b:ExternalAccountReferenceNo>
               <a:PaymentSchedules xmlns:b="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core.Entities">   <b:Payments>
                     <b:PayScheduleWithStatus>PaymentWithPaySchedule>
                        <Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
                  <b:Description>4d74bd9d-3b6f-46df-a23b-203b51634a96</b:Description>      <b:PaySchedules>
            <b:ExternalIdentifier>4d74bd9d-3b6f-46df-a23b-203b51634a96</b:ExternalIdentifier>               <b:PayScheduleQik>
   <b:Installment>209.71</b:Installment>                      <b:PaymentStatus>Unattempted</b:PaymentStatus>     <Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
           <b:ScheduleId>61087707</b:ScheduleId>                   <b:StartDate>2020-01-30T00:00:00<Description>757757c3-6f28-40e0-b7df-29d09807caa7</b:StartDate>
  Description>
               <b:StatusDate>2020-01-30T18:21:17.91</b:StatusDate>                <<b:ExternalIdentifier>757757c3-6f28-40e0-b7df-29d09807caa7</b:PayScheduleWithStatus>ExternalIdentifier>
                <b:PayScheduleWithStatus>              <b:InRetry>false</b:InRetry>
    <Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>                         <b:Description>4d74bd9d-3b6f-46df-a23b-203b51634a96<Installment>192.27</b:Description>Installment>
                              <b:ExternalIdentifier>4d74bd9d-3b6f-46df-a23b-203b51634a96<Paid>192.27</b:ExternalIdentifier>Paid>
                              <b:Installment>209.71<PaymentStatus>Settled</b:Installment>PaymentStatus>
                       <b:PaymentStatus>Unattempted</b:PaymentStatus>       <b:ScheduleId>65084988</b:ScheduleId>
           <b:ScheduleId>61087707</b:ScheduleId>                   <b:StartDate>2020-0103-30T0024T00:00:00</b:StartDate>
                              <b:StatusDate>2020-0103-31T0626T10:0757:1547.223<12</b:StatusDate>
                      </b:PayScheduleWithStatus>     </b:PayScheduleQik>
          <b:PayScheduleWithStatus>              </b:PaySchedules>
    <Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>                   <b:Description>4d74bd9d-3b6f-46df-a23b-203b51634a96<PaymentAmount>192.27</b:Description>PaymentAmount>
                        <b:ExternalIdentifier>4d74bd9d-3b6f-46df-a23b-203b51634a96</b:ExternalIdentifier>PaymentCode>OneOffPayment</b:PaymentCode>
                        <b:Installment>209.71<PaymentErrorCode>NoError</b:Installment>PaymentErrorCode>
                        <b:PaymentStatus>Unattempted<PaymentId>1530035833</b:PaymentStatus>PaymentId>
                        <b:ScheduleId>61087707<PaymentType>DirectDebit</b:ScheduleId>PaymentType>
                     <b:StartDate>2020-01-30T00:00:00<</b:StartDate>PaymentWithPaySchedule>
                  <b:StatusDate>2020-02-03T10:04:04.657<</b:StatusDate>Payments>
               </b:PayScheduleWithStatus>AccountWithPayments>
            </a:PaymentSchedules>Accounts>
         </GetCustomerPaymentByStatusForDateRangeResult>GetPaymentHistoryByStatusForDateRangeResult>
      </GetCustomerPaymentByStatusForDateRangeResponse>GetPaymentHistoryByStatusForDateRangeResponse>
   </s:Body>
</s:Envelope>
Filter by label (Content by label)
showLabelsfalse
showSpacefalse
excerptTypesimple
cqllabel in ( "getpaymenthistorybystatusfordaterange" , "getcustomerpaymentbystatusfordaterange" )

On this page:

Table of Contents