Canceling a SMART-Disburse Payment

Overview

There may be instances where a SMART-Disburse payment needs to be canceled. Mistakes such as using incorrect delivery email address or needing to modify remittance details can prompt this action. Fortunately, the SMART-Disburse payment can be revoked, even if the payable is currently "In Process".

Step 1: Prepare the PUT request

• Endpoint: /payables/{recordNumber}/cancel. Replace {recordNumber} with the unique identifier of the SMART-Disburse payment you wish to cancel.

• Method: PUT

Step 2: Send the PUT request

Using your preferred method (command line, Postman, or a script), send the PUT request to the endpoint. 

Step 3: Handle the response

Upon successfully cancelling the SMART-Disburse payment, the API will respond with a "202 Accepted" status code. The status of the payable will then be updated to "Canceled". Additionally, the existing SMART-Disburse link associated with the payment will be revoked.

Note: Once a SMART-Disburse payment has been canceled, it can be modified and re-initiated using the relevant update API call.