Void/Reverse Payment

General

Occasionally, a payment will need to be reversed or voided. This can occur for a number of reasons, such as a bounced check or a payment entry error. Here's what you need to know about reversing payments:

• Once a payment is reversed, it can no longer be edited.
• Unlike with an Edit Existing Payment request, reversing a payment does not create a new payment record.
• When a payment is reversed, its status in the database is updated to payment.status.voided.

👆

Pay special attention to the endpoint of this request.

This request does not use OData, so it's not included in the endpoint like most other LMS requests.

For an example of how updating payments works within the UI, take a look at our Edit or Reverse Payments article.

Database

For information on payments database tables, see the following articles:

• Database – Payment Reversed Transaction Snapshot (payment_reversed_tx_snapshot)
• Database – Payments (payment_entity)
• Database – Payment Defaults (defaults_payments)
• Database – Additional Payment Information (payment_info_entity)

{
    "reverseReason": "payment.reverse.checkBounce",
    "comments": "The check provided by the borrower could not be processed.",
    "nachaReturnCode": "nacha.returnCode.r05",
    "__logOnly": false
}

🚧

Try It Instructions

Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is a bit different.

We can’t provide sample values that will work for multiple users. But, if you’d like to see a sample of a 200 response, click the response examples located under the Try It button.

To receive a 200 response from the Try It button, you will have to try this request with your own tenant credentials. If you plan on doing so, make sure to change the headers to match your own authentication information.