List Payments

Overview

This endpoint provides comprehensive payment data for all jobs processed through the Hover platform. It allows your integration to retrieve a detailed list of payment records, offering insights into the status and context of each transaction. This endpoint is crucial for tracking financial operations related to the Hover jobs in your authenticated organization.

Filtering Payment Data

This endpoint supports various query parameters to help you narrow down the results and retrieve specific payment information.

Filtering by Payment State

Filtering by state allows the endpoint to return payment data based on the various available states that it could be in. The available states are:

• Complete -- The payment has been successfully processed and completed.
• Refunded -- The payment was refunded to the card on file
• Cancelled -- The payment was cancelled
• Paying -- Hover is attempting to process the payment
• Waiting -- Hover is waiting for further information about the payment
• Failed -- Hover attempted to process the payment, but was unable to complete it.
  • The failed filter will return all possible reasons for the payment failure, includingincludingfailed_calculating_tax, failed_charging_card, and failed_discounting_base_price. These specific failure reasons can be passed in the filter as well.

Filtering by Good Type and Good ID

This endpoint allows you to filter payment data by good_type and its corresponding good_id, enabling you to retrieve payments related to a specific job or an entire organization.

• good_type: Specifies the type of entity associated with the payment.

  • Job: When good_type is Job, the good_id must be a valid Hover Job ID. This will return all payment information available for that specific job.

  • Org: When good_type is Org, the good_id must be a valid Hover Organization ID. This will return payment information for all jobs associated with the authenticated Hover organization.

Please Note: The values for good_type (Job and Org) are case-sensitive and must be capitalized as shown.

Sample Response Body

Results are ordered by updated_at timestamp in descending order. Pagination is supported for this endpoint by using the page parameter in your request.

{  
    "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": \[]  
        }  
    ]  
}