Reversing suspense payments

Suspense payments can be reversed through Cloud API. This typically occurs for the same reasons that a non-suspense payment is reversed, such as the payment information was entered incorrectly or the payment was not honored by the financial institution. However, unlike other payment reversals, suspense payment reversals do not require a reversal reason. The request body can be empty when reversing a suspense payment through Cloud API.

To reverse a suspense payment, use the following endpoint:

  • POST /billing/v1/suspense-payments/{suspensePaymentId}/reverse

Suspense payments that have already been reversed or applied cannot be reversed.

The below is an example of reversing a suspense payment. The POST request is executed without a body.

Command
POST /billing/v1/suspense-payments/bc:SJRnme9xw1OvwitxWfnqH/reverse
Response
{
    "data": {
        "attributes": {
            "amount": {
                "amount": "20.00",
                "currency": "usd"
            },
            "description": "Note on suspense payment",
            "id": "bc:SJRnme9xw1OvwitxWfnqH",
            "invoiceNumber": "1000000000",
            "paymentDate": "2024-10-05T00:00:00.000Z",
            "paymentInstrument": {
                "displayName": "Cash",
                "id": "bc:S1rxFPQrXj0GPNsH0PRKB",
                "type": "UniversalPaymentInstrument",
                "uri": "/billing/v1/universal-payment-instruments/bc:S1rxFPQrXj0GPNsH0PRKB"
            },
            "refNumber": "1234",
            "reversedByUser": {
                "displayName": "Aaron Applegate",
                "id": "bc:SmMqZTSa6i_HxsuhEYBgb",
                "type": "User",
                "uri": "/admin/v1/users/bc:SmMqZTSa6i_HxsuhEYBgb"
            },
            "status": {
                "code": "reversed",
                "name": "Reversed"
            }
        }
    }
}