API Reference

List Payments

Why would I use this?

This endpoint lists payments that have been made to Hover. You might use this to update your ledger of payments to Hover.

URL Parameters

When filtered by state "failed", it returns all payments in one of the states: ["failed_calculating_tax", "failed_charging_card", "failed_discounting_base_price"]. Alternatively you may also filter by one of those failure states individually.

Successful Response

Results are ordered by updated_at in descending order. See an example 200 response here, a JSON blob of the payments, then follow below to learn more about the request, and what makes up the responses.

{
    "pagination": {
        "current_page": 1,
        "total_pages": 1,
        "total": 2
    },
    "results": [
        {
            "id": 111111,
            "org_id": 222222,
            "good_id": 333333,
            "good_data": "Yearly subscription, 1 user",
            "base_price": 1000000,
            "base_price_subsidy": 0,
            "discount": 1000000,
            "discount_subsidy": 0,
            "pre_tax_balance_debit": 0,
            "pre_tax_subtotal": 0,
            "balance_debit": 0,
            "total": 0,
            "subtotal": 0,
            "tax": 0,
            "state": "complete",
            "error": null,
            "created_at": "2023-09-12T13:24:18.890Z",
            "updated_at": "2023-09-12T13:24:19.647Z",
            "good_type": "Org",
            "payment_discounts": [
                {
                    "id": 555555,
                    "name": "Example Discount Name",
                    "amount": 1000000,
                    "kind": "discount"
                }
            ],
            "payment_deposits": []
        },
        {
            "id": 111112,
            "org_id": 222222,
            "good_id": 333334,
            "good_data": null,
            "base_price": 35000,
            "base_price_subsidy": 0,
            "discount": 35000,
            "discount_subsidy": 0,
            "pre_tax_balance_debit": 0,
            "pre_tax_subtotal": 0,
            "balance_debit": 0,
            "total": 0,
            "subtotal": 0,
            "tax": 0,
            "state": "complete",
            "error": null,
            "created_at": "2023-09-07T18:03:24.492Z",
            "updated_at": "2023-09-07T18:03:26.031Z",
            "good_type": "HiDefRenderingVersion",
            "payment_discounts": [],
            "payment_deposits": []
        }
    ]
}

Language
Credentials
Bearer
URL
Click Try It! to start a request and see the response here!