Get payment status within a date range (gateway only)
Customer Payment
REST API
Use the Payment Status endpoint of Customer Services API to retrieve the payment status of any business or customer account.
GET https://<ServerURL>/CustomerServices/v1.0/businesses/{businessID}/paymentstatuses
The results can be filtered based on the
Status
of the payment.AccountId
is used to uniquely identify the account.StartDatetime
andEndDateTime
are used to indicate the date range for the payments.
SOAP API
Use the GetCustomerPaymentByStatusForDateRange to get the payment schedule with payment status found in between the date range provided in the request.
This API is meant to be used only for gateway billing clients. For full-service clients, no data is returned.
Sample request
<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:GetCustomerPaymentByStatusForDateRange>
<deb:request>
<deb1:DateCreated>2021-01-14</deb1:DateCreated>
<deb1:Id>123</deb1:Id>
<deb1:RequestInitiator>Kin123</deb1:RequestInitiator>
<deb1:User>
<deb1:Password>#Password</deb1:Password>
<deb1:Username>Username</deb1:Username>
</deb1:User>
<deb2:ContractPrefix>QP4EE</deb2:ContractPrefix>
<deb2:EndDate>2020-02-03</deb2:EndDate>
<deb2:StartDate>2020-01-20</deb2:StartDate>
<deb2:Status>Failed</deb2:Status>
</deb:request>
</deb:GetCustomerPaymentByStatusForDateRange>
</soapenv:Body>
</soapenv:Envelope>
Sample response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<ActivityId CorrelationId="816f44fa-ef70-4877-a827-88c80e811c13" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
</s:Header>
<s:Body>
<GetCustomerPaymentByStatusForDateRangeResponse xmlns="Debitsuccess.WebServices.WCF">
<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">2021-01-14T10:55:00.2806506+13:00</DateCreated>
<Id xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">06dbe0e0-0dcb-4496-8f2b-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:PaymentSchedules xmlns:b="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core.Entities">
<b:PayScheduleWithStatus>
<Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
<b:AccountRef>QP4EE888779</b:AccountRef>
<b:ContractPrefix>QP4EE</b:ContractPrefix>
<b:Description>f13cd5a5-8c50-4d79-97cb-95fd6d6f2e54</b:Description>
<b:ErrorCode>Insufficient Funds</b:ErrorCode>
<b:ExternalIdentifier>f13cd5a5-8c50-4d79-97cb-95fd6d6f2e54</b:ExternalIdentifier>
<b:Installment>533.05</b:Installment>
<b:PaymentStatus>Failed</b:PaymentStatus>
<b:ScheduleId>61299397</b:ScheduleId>
<b:StartDate>2020-01-31T00:00:00</b:StartDate>
<b:StatusDate>2020-01-31T19:18:24</b:StatusDate>
</b:PayScheduleWithStatus>
<b:PayScheduleWithStatus>
<Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
<b:AccountRef>QP4EE888788</b:AccountRef>
<b:ContractPrefix>QP4EE</b:ContractPrefix>
<b:Description>a7569718-06a0-4a8b-b682-c4fb1b1bce39</b:Description>
<b:ErrorCode>Insufficient Funds</b:ErrorCode>
<b:ExternalIdentifier>a7569718-06a0-4a8b-b682-c4fb1b1bce39</b:ExternalIdentifier>
<b:Installment>117.72</b:Installment>
<b:PaymentStatus>Failed</b:PaymentStatus>
<b:ScheduleId>61002101</b:ScheduleId>
<b:StartDate>2020-01-29T00:00:00</b:StartDate>
<b:StatusDate>2020-01-31T08:32:45</b:StatusDate>
</b:PayScheduleWithStatus>
<b:PayScheduleWithStatus>
<Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
<b:AccountRef>QP4EE888798</b:AccountRef>
<b:ContractPrefix>QP4EE</b:ContractPrefix>
<b:Description>1692b039-a5e5-49c9-85f7-bb5eb2d73810</b:Description>
<b:ErrorCode>Insufficient Funds</b:ErrorCode>
<b:ExternalIdentifier>1692b039-a5e5-49c9-85f7-bb5eb2d73810</b:ExternalIdentifier>
<b:Installment>992.64</b:Installment>
<b:PaymentStatus>Failed</b:PaymentStatus>
<b:ScheduleId>61087341</b:ScheduleId>
<b:StartDate>2020-01-30T00:00:00</b:StartDate>
<b:StatusDate>2020-02-03T08:29:56</b:StatusDate>
</b:PayScheduleWithStatus>
</a:PaymentSchedules>
</GetCustomerPaymentByStatusForDateRangeResult>
</GetCustomerPaymentByStatusForDateRangeResponse>
</s:Body>
</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.
This API is meant to be used only for gateway billing clients. For full-service clients, no data is returned.
This call has been deprecated. For a new implementation we recommend using GetCustomerPaymentByStatusForDateRange instead.
Sample request
<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>
<deb:request>
<deb1:DateCreated>2020-08-10T00:00:00</deb1:DateCreated>
<deb1:Id>123</deb1:Id>
<deb1:RequestInitiator>ReqInit1</deb1:RequestInitiator>
<deb1:User>
<deb1:Id>123</deb1:Id>
<deb1:Password>#password</deb1:Password>
<deb1:Username>username</deb1:Username>
</deb1:User>
<deb2:ContractPrefix>QP8OM</deb2:ContractPrefix>
<deb2:EndDate>2020-03-26</deb2:EndDate>
<deb2:StartDate>2020-03-25</deb2:StartDate>
<deb2:Status>Settled</deb2:Status>
</deb:request>
</deb:GetPaymentHistoryByStatusForDateRange>
</soapenv:Body>
</soapenv:Envelope>
Sample Response
<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>
<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 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>
<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:Accounts xmlns:b="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core.Entities">
<b:AccountWithPayments>
<Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
<b:AccountReferenceNo>QP8OM888812</b:AccountReferenceNo>
<b:ExternalAccountReferenceNo>5DBC9C39-5C6B-4B1D-8652-0DF2F49E120A</b:ExternalAccountReferenceNo>
<b:Payments>
<b:PaymentWithPaySchedule>
<Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
<b:PaySchedules>
<b:PayScheduleQik>
<Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
<b:Description>2a2e3ba7-cf75-4358-b031-d4a9301eaf42</b:Description>
<b:ExternalIdentifier>2a2e3ba7-cf75-4358-b031-d4a9301eaf42</b:ExternalIdentifier>
<b:InRetry>false</b:InRetry>
<b:Installment>34.11</b:Installment>
<b:Paid>34.11</b:Paid>
<b:PaymentStatus>Settled</b:PaymentStatus>
<b:ScheduleId>64753345</b:ScheduleId>
<b:StartDate>2020-03-21T00:00:00</b:StartDate>
<b:StatusDate>2020-03-25T10:57:50.023</b:StatusDate>
</b:PayScheduleQik>
</b:PaySchedules>
<b:PaymentAmount>34.11</b:PaymentAmount>
<b:PaymentCode>OneOffPayment</b: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" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
<b:AccountReferenceNo>QP8OM888797</b:AccountReferenceNo>
<b:ExternalAccountReferenceNo>864C4E06-527B-4242-9DF9-F475C999F189</b:ExternalAccountReferenceNo>
<b:Payments>
<b:PaymentWithPaySchedule>
<Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
<b:PaySchedules>
<b:PayScheduleQik>
<Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"/>
<b:Description>757757c3-6f28-40e0-b7df-29d09807caa7</b:Description>
<b:ExternalIdentifier>757757c3-6f28-40e0-b7df-29d09807caa7</b:ExternalIdentifier>
<b:InRetry>false</b:InRetry>
<b:Installment>192.27</b:Installment>
<b:Paid>192.27</b:Paid>
<b:PaymentStatus>Settled</b:PaymentStatus>
<b:ScheduleId>65084988</b:ScheduleId>
<b:StartDate>2020-03-24T00:00:00</b:StartDate>
<b:StatusDate>2020-03-26T10:57:47.12</b:StatusDate>
</b:PayScheduleQik>
</b:PaySchedules>
<b:PaymentAmount>192.27</b:PaymentAmount>
<b:PaymentCode>OneOffPayment</b:PaymentCode>
<b:PaymentErrorCode>NoError</b:PaymentErrorCode>
<b:PaymentId>1530035833</b:PaymentId>
<b:PaymentType>DirectDebit</b:PaymentType>
</b:PaymentWithPaySchedule>
</b:Payments>
</b:AccountWithPayments>
</a:Accounts>
</GetPaymentHistoryByStatusForDateRangeResult>
</GetPaymentHistoryByStatusForDateRangeResponse>
</s:Body>
</s:Envelope>
Related Articles
-
GetCustomerPaymentByStatusForDateRange — Returns the schedule with payment status found in between the date range provided in the request.
-
-
GetPaymentHistoryByStatusForDateRange — Returns a list of payments and provides the associated schedule between a specified date range by status for the current user.
On this page:
- 1 Customer Payment
- 1.1 REST API
- 1.2 SOAP API
- 1.2.1 Sample request
- 1.2.2 Sample response
- 2 Payment History
- 2.1 Sample request
- 2.2 Sample Response
- 3 Related Articles
© 2021 Debitsuccess. All rights reserved