API – Reverse Payments

Introduction

Payment reversal in LoanPro will mark a payment as reversed and will then optionally forward it on to payment processors for voiding. This article explains how to reverse payments through the API, but you can also edit or reverse payments with the UI.

Voiding Payments

To void a payment, send a request to the following endpoint:

POST https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans({loanId})/VoidPayment({paymentId})

Replace {loanid} with the ID of the associated loan and {paymentId} with the ID of the payment to reverse.

The {paymentId} value in the endpoint above is not the display ID of the payment—it's the system ID. The system ID can be found by sending a GET request to the following URL:
https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans({loanId})/Payments

You will need to format the payload of the request like the following:

{
"reverseReason": "payment.reverse.checkBounce",
"comments": "The check didn't go through with WellsFargo",
"nachaReturnCode": "nacha.returnCode.r05",
"__logOnly": true
}

Field

Description

reverseReason (required)

This field uses a collection value that describes the reverse reason.

Here's a full list of the available collection options for this field.

comments (required)

This field is used to list comments that describe the reversal.

nachaReturnCode (optional)

This specifies a NACHA return code to be sent to the payment processor. Upon receiving a code, the processor may or may not perform an action, and action is not determined by LoanPro.

If not specified, no NACHA return code will be sent to the payment processor.

__logOnly (optional)

If set to “true”, then no information will be forwarded to payment processors—including NACHA return codes.

If set to “false”, voiding information will be forwarded to payment processors. This field defaults to “false” if a value is not specified.


How did we do?


Powered by HelpDocs (opens in a new tab)