StopPayment
Usage
Stops a customer’s payments for a period of time.
Payments owing will continue to accrue based on payment schedules irrespective of a stop in customer’s payments. In order to halt the accumulation of payments owing to a suspension should be used (See SuspendAccountForNumberOfPaymentCycles and SuspendAccountBetweenDates).
The StopCreditControlLetters property controls whether overdue letters will be sent to the customer for the period that payments are stopped.
Collection Stop Reason is populated to ‘Manual Payment Stop’ when WS StopPayment successfully executed and clear the Collection Stop Reason when WS ResumePayment is successfully executed.
The WS ResumePayment request is rejected if Collection Stop Reason is not ‘Manual Payment Stop’
Parameters
Name | Data Type | Length | Description | |
|---|---|---|---|---|
User | ||||
| String | Required | Provided by Debitsuccess | |
| String | Required | Provided by Debitsuccess | |
RequestInitiator | String | 100 | Optional | Optional – allows requesting user to be logged |
AccountReferenceNo | String | 15 | Optional* | Debitsuccess account reference |
ExternalAccountReferenceNo | String | 50 | Optional* | External account reference |
StopPaymentsUntil | DateTime | Optional | Date after which payments should resume for the customer | |
StopCreditControlLetters | Boolean | Required | false – Overdue letters will be sent to the customer if the account becomes overdue true – Overdue letters will not be sent to the customer if the account becomes overdue |
* At least one of the following parameters must be supplied: AccountReferenceNo, ExternalAccountReferenceNo
Response
Name | Data Type | Description |
|---|---|---|
DateCreated | DateTime | Date/time message was processed |
Id | String | Unique ID for the message |
ResponseNotes () | Collection of validation messages | |
| String | |
| String | |
| Enum | Error, Warning, Info |
Status | Enum | Failed, Succeed, Unknown |
Error Messages
Type | Error Code | Error Message |
|---|---|---|
Error | 13011 | Invalid date. The StopPaymentsUntil date must be in the future |
Warning | 14020 | DateTime field '{0}' contains time part, but the time is ignored by message. |
Error | 02 | Invalid user credentials |
Error | 12016 | Missing required reference number. Must provide either ExternalAccountReferenceNo or AccountReferenceNo or both. |
Error | 08 | There is no record found with this criteria |
Error | 10 | Account is not active |
Error | 07 | Multiple accounts found with this criteria |
Warning | 14001 | StopPayment has already been set to true. |
Warning | 14002 | The account is due to bill today and may still get billed if the payment processing is in progress. |
Info | 00 | Success |
Related Pages
Filter by label
There are no items with the selected labels at this time.
On this page:
PUT Update Account
© 2021 Debitsuccess. All rights reserved