Create a one-off schedule

Owned by chitra.b (Unlicensed)
Last updated: May 25, 2021
2 min read

REST API

Use the OneOffSchedule endpoint of Customer Services API to create a charge for a full-service type customer account:

POST https://<ServerURL>/CustomerServices/v1.0/accounts/{accountId}/oneOffSchedules

  • dueDate is required and must not be in the past

  • amountis required and must be at least $1.00

SOAP API

The create a charge for a full-service type customer account

For example, a customer has got a Personal Training booking for a fee of $50. Use the CreateSchedule call when you want to create a one-off schedule on a recurring payment.

Sample request message

<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"> <soapenv:Header/> <soapenv:Body> <deb:CreateSchedule> <deb:request> <deb1:User> <deb1:Password>#password</deb1:Password> <deb1:Username>test</deb1:Username> </deb1:User> <deb1:AccountReferenceNo>test888994</deb1:AccountReferenceNo> <deb1:DeleteFutureSchedules>false</deb1:DeleteFutureSchedules> <deb1:NewPaySchedule> <deb1:Description>PT booking</deb1:Description> <deb1:Installment>50</deb1:Installment> <deb1:PaymentFrequency>OneOff</deb1:PaymentFrequency> <deb1:MinimumEffectiveDate>2020-12-05</deb1:MinimumEffectiveDate> <deb1:ExternalScheduleIdentifier>abc1234</deb1:ExternalScheduleIdentifier> </deb1:NewPaySchedule> <deb1:OverrideBillingCycleAlignment>false</deb1:OverrideBillingCycleAlignment> </deb:request> </deb:CreateSchedule> </soapenv:Body> </soapenv:Envelope>

Sample response message

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <ActivityId CorrelationId="ad01f63f-e007-4591-a7f5-ab7eba454f58" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId> </s:Header> <s:Body> <CreateScheduleResponse xmlns="Debitsuccess.WebServices.WCF"> <CreateScheduleResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:DateCreated>2020-12-03T10:01:30.2146916+13:00</a:DateCreated> <a:Id>7deed93e-6fb2-4ca0-8b67-f1e161ccea12</a:Id> <a:ResponseNotes> <a:ResponseMessageNote> <a:Code>00</a:Code> <a:Note>Success</a:Note> <a:NoteType>Info</a:NoteType> </a:ResponseMessageNote> </a:ResponseNotes> <a:Status>Succeed</a:Status> <a:NewScheduleId>72577691</a:NewScheduleId> </CreateScheduleResult> </CreateScheduleResponse> </s:Body> </s:Envelope>

 

 

 

© 2021 Debitsuccess. All rights reserved