Edit Existing Payment

This request allows you to update existing payments.

   Click here to learn more about this request

Payments have a wide array of settings and store a lot of information:

• When a payment is edited, an entirely new payment record that references the original payment is created. The new payment record becomes active, while the original payment is set to an inactive status and becomes uneditable in the future. Thus, a payment ID can only be updated once, since it's replaced by a new payment.
• There are a lot of body parameters that can be used, but not all will apply to every payment.
• The comments field is always required when updating payments. This help's keep a history of what changes to payments have been made and why.

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

Database

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

• Database – Payments (payment_entity)
• Database – Payment Defaults (defaults_payments)
• Database – Additional Payment Information (payment_info_entity)

Sample Payload

{
    "Payments": {
        "results": [
            {
                "id": 1616,
                "displayId": 7239,
                "payoffFlag": 0,
                "info": "ReadMe API Test",
                "date": "2022-01-01",
                "priorcutoff": false,
                "amount": "150",
                "paymentMethodId": 1,
                "paymentTypeId": 1,
                "extra": "payment.extra.periods.principalonly",
                "active": 1,
                "afterAmountPastDue": "0.00",
                "afterDaysPastDue": 0,
                "afterNextDueAmount": "172.22",
                "afterNextDueDate": "/Date(1642896000)/",
                "afterPayoff": "11721.41",
                "afterPrincipalBalance": "11800.92",
                "beforeAmountPastDue": "0.00",
                "beforeDaysPastDue": 0,
                "beforeNextDueAmount": "173.22",
                "beforeNextDueDate": "/Date(1642896000)/",
                "beforePayoff": "11722.41",
                "beforePrincipalBalance": "11800.92",
                "early": 0,
                "echeckAuthType": "payment.echeckauth.WEB",
                "sortDate": 197001191,
                "chargeOffRecovery": 0,
                "autopayId": "N/A",
                "CustomFieldValues": {
                    "results": []
                },
                "order": 4,
                "_notEditable": false,
                "_$originalDate": "/Date(1640995200)/",
                "payoffPayment": false,
                "quickPay": "",
                "comments": "TEST",
                "selectedProcessor": "",
                "__logOnly": true,
                "__id": 1616,
                "__update": true
            }
        ]
    }
}