Querying for suspense payments

Use the following endpoints to query for suspense payments:

GET /billing/v1/suspense-payments
GET /billing/v1/suspense-payments/{suspensePaymentId}

These endpoints retrieve suspense payments regardless of the status of the payment. If you wish to filter suspense payments by status (for example, to only retrieve open suspense payments), add the ?filter=status query parameter.

Below is a sample GET request for suspense payment bc:SoNHQp2KKeT0fP5yZzvHj.

Command

GET /billing/v1/suspense-payments/bc:SoNHQp2KKeT0fP5yZzvHj

Response

{
    "data": {
        "attributes": {
            "amount": {
                "amount": "10.00",
                "currency": "usd"
            },
            "id": "bc:SoNHQp2KKeT0fP5yZzvHj",
            "paymentDate": "2024-01-10T00:00:00.000Z",
            "paymentInstrument": {
                "displayName": "Cash",
                "id": "bc:S6_cD6OL_JHsrHOZ3BURd",
                "type": "UniversalPaymentInstrument",
                "uri": "/billing/v1/universal-payment-instruments/bc:S6_cD6OL_JHsrHOZ3BURd"
            },
            "status": {
                "code": "open",
                "name": "Open"
            }
        },
  	...
    }
}