Create a charge for gateway billing type account which does not have a recurring schedule

REST API

Use the One-off schedule endpoint of Customer API to create a one-off schedule for an account.

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

dueDate is required and must not be in the past
amount is required and must be at least $1.00

SOAP API

For example, one-off schedule amount, each week or month a new schedule is passed for the customer to debit $100.

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:DateCreated>2020-09-22</deb1:DateCreated>
            <deb1:Id>333</deb1:Id>
            <deb1:RequestInitiator>Kin333</deb1:RequestInitiator>
            <deb1:User>
               <deb1:Id>33333</deb1:Id>
               <deb1:Password>#password</deb1:Password>
               <deb1:Username>Username</deb1:Username>
            </deb1:User>
            <deb1:AccountReferenceNo>DEA2884487</deb1:AccountReferenceNo>
            <deb1:ExternalAccountReferenceNo></deb1:ExternalAccountReferenceNo>
            <deb1:NewPaySchedule>
               <deb1:Description> OneOff schedule 1</deb1:Description>
               <deb1:Installment>10</deb1:Installment>
               <deb1:PaymentFrequency>OneOff</deb1:PaymentFrequency>
               <deb1:MinimumEffectiveDate>2020-10-23</deb1:MinimumEffectiveDate>
               <deb1:ExternalScheduleIdentifier>ext12349</deb1:ExternalScheduleIdentifier>
            </deb1:NewPaySchedule>
         </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="364842ae-e15c-4819-993c-f262e052a4ba" 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-10-23T14:55:00.7596469+13:00</a:DateCreated>
            <a:Id>718dae19-a86f-4432-b211-9375b5763cc2</a:Id>
            <a:ResponseNotes>
               <a:ResponseMessageNote>
                  <a:Code>00</a:Code>
                  <a:Note>Success</a:Note>
                  <a:NoteType>Info</a:NoteType>
               </a:ResponseMessageNote>
               <a:ResponseMessageNote>
                  <a:Code>14063</a:Code>
                  <a:Note>New Schedule start date is today and the request is after the Cut off time, so the next bill date is set to next working date.</a:Note>
                  <a:NoteType>Warning</a:NoteType>
               </a:ResponseMessageNote>
            </a:ResponseNotes>
            <a:Status>Succeed</a:Status>
            <a:NewScheduleId>66484948</a:NewScheduleId>
         </CreateScheduleResult>
      </CreateScheduleResponse>
   </s:Body>
</s:Envelope>

Create a charge for gateway billing type account which does not have a recurring schedule

REST API

SOAP API

Sample request message

Sample response message

Related Articles