API – Reverse Payments

Payment reversal in LoanPro will mark a payment as reversed, and will then optionally forward it on to payment processors for voiding.

Voiding Payments

To void a payment, send a POST request to the endpoint Loans({loanid})/VoidPayment({payId}). Replace {loanid} with the id of the associated loan, and {payId} with the id of the payment to reverse.

 

Note, {payId} is not the display id of the payment, but is the payment system Id. The {payId} can be found by sending a GET request to the url https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(id=#)/Payments. Substitute the # for the id of the specific loan you are working in.

 

Below is an example:

POST https://loanpro.simnang.com/api/public/api/1/Loans(209)/VoidPayment(105)

Payload

Below is a sample payload:

{
 "reverseReason": "payment.reverse.checkBounce",
 "comments": "The check didn't go through with WellsFargo",
 "nachaReturnCode": "nacha.returnCode.r05",
 "__logOnly": true
}
  • reverseReason (required)
    • This field gives is a collection value that describes the reverse reason.
    • To get a full list of options, do `GET https://loanpro.simnang.com/api/public/api/1/collections(payment.reverse)/items`
  • comments (required)
    • This is comments describing more about why the reversal happened
  • 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 – that 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
    • Defaults to “false” if not specified

 

Related Articles

Leave A Comment?