List payments

GET

GET https://platform-api.lia.com.br/external_api/v1/payments

Query params

Name	Description	Required	Type
bill_id	Filter by bill_id	false	String
status	Filter by payment status	false	String
paid_at_start	Filter by payments paid_at greater than or equal to (YYYY-MM-DD)	false	String
paid_at_end	Filter by payments paid_at lower than or equal to (YYYY-MM-DD)	false	String
payment_method	Filter by payment_method	false	String
page	Number of the page you want	false	Integer
per_page	Total items per page, max 1000 itens per page	false	Integer

Example request

curl --location 'https://platform-api-sandbox.lia.com.br/external_api/v1/payments?payment_method=credit_card&status=paid&
paid_at_start=2023-08-21&paid_at_end=2023-12-21&page=1&per_page=2
--header 'Authorization: Bearer sandbox_BtnsSPrTQcK2M1jyEJeckqtsNP3XtR7BXN6UTDfs'

Example response

{
    "results": [
        {
            "amount_cents": 8379,
            "barcode": null,
            "barcode_image_url": null,
            "bill_id": "82f78674-4415-40ce-810d-92b12662738j",
            "created_at": "2023-09-19T11:46:01.080-03:00",
            "expires_at": "2023-09-21T23:59:59.999-03:00",
            "id": "0b41cfa6-c748-4892-b9a2-e59445b8hnfg9",
            "installments": 1,
            "paid_amount_cents": 8379,
            "paid_at": "2023-09-19T11:46:01.088-03:00",
            "payment_method": "credit_card",
            "refunded_amount_cents": 0,
            "refunded_at": null,
            "refused_reason": null,
            "refused_reason_description": null,
            "status": "paid",
            "url": "https://pague-sandbox.lia.com.br/parcela/pagamento?bill_id=82f78674-4415-40ce-810d-92b12662738j",
            "splits": [
                {
                    "created_at": "2025-05-15T10:57:32.486-03:00",
                    "id": "5c5cd320-c63e-481f-bbf2-72aabfcca44b",
                    "owner_id": "0b41cfa6-c748-4892-b9a2-e59445b8hnfg9",
                    "owner_type": "Payment",
                    "payment_method_configuration_id": "ddc40bd5-bfd9-4ae3-92c7-959425f86d59",
                    "receiver": {
                        "company_id": "092f910f-e6f3-48f5-a4ff-c4f0e1baed4a",
                        "id": "3386e1d6-f266-4786-ad44-edaa6fe54asl"
                    },
                    "receiver_id": "3386e1d6-f266-4786-ad44-edaa6fe54asl",
                    "take_rate": 777.0,
                    "take_rate_type": "absolute",
                    "updated_at": "2025-05-15T10:57:32.486-03:00"
                },
                {
                    "created_at": "2025-05-15T10:57:32.495-03:00",
                    "id": "072a5762-fa87-4088-b107-1f3f68e21psa",
                    "owner_id": "0b41cfa6-c748-4892-b9a2-e59445b8hnfg9",
                    "owner_type": "Payment",
                    "payment_method_configuration_id": "ddc40bd5-bfd9-4ae3-92c7-959425f86d59",
                    "receiver": {
                        "company_id": "3766b0fd-6cd5-4da1-ba6a-aa7d1c630odc",
                        "id": "f2a34e72-6977-47e1-b5f7-0d2e294eaas6"
                    },
                    "receiver_id": "f2a34e72-6977-47e1-b5f7-0d2e294eaas6",
                    "take_rate": 9223.0,
                    "take_rate_type": "absolute",
                    "updated_at": "2025-05-15T10:57:32.495-03:00"
                }
            ]
        },
        {
            "amount_cents": 207000,
            "barcode": null,
            "barcode_image_url": null,
            "bill_id": "0ae2b7c6-9223-496d-9f55-d8450c05c09j0",
            "created_at": "2023-11-01T12:54:22.240-03:00",
            "expires_at": "2023-11-03T23:59:59.999-03:00",
            "id": "c8f45470-4b92-495e-a4de-febe8589490d",
            "installments": 1,
            "paid_amount_cents": 207000,
            "paid_at": "2023-11-01T12:54:22.273-03:00",
            "payment_method": "credit_card",
            "refunded_amount_cents": 0,
            "refunded_at": null,
            "refused_reason": null,
            "refused_reason_description": null,
            "status": "paid",
            "url": "https://pague-sandbox.lia.com.br/parcela/pagamento?bill_id=0ae2b7c6-9223-496d-9f55-d8450c05c09j0",
            "splits": [
                {
                    "created_at": "2025-05-15T10:57:32.486-03:00",
                    "id": "5c5cd320-c63e-481f-bbf2-72aabfcca44b",
                    "owner_id": "0b41cfa6-c748-4892-b9a2-e59445b8hnfg9",
                    "owner_type": "Payment",
                    "payment_method_configuration_id": "ddc40bd5-bfd9-4ae3-92c7-959425f86d59",
                    "receiver": {
                        "company_id": "092f910f-e6f3-48f5-a4ff-c4f0e1baed4a",
                        "id": "3386e1d6-f266-4786-ad44-edaa6fe54asl"
                    },
                    "receiver_id": "3386e1d6-f266-4786-ad44-edaa6fe54asl",
                    "take_rate": 777.0,
                    "take_rate_type": "absolute",
                    "updated_at": "2025-05-15T10:57:32.486-03:00"
                },
                {
                    "created_at": "2025-05-15T10:57:32.495-03:00",
                    "id": "072a5762-fa87-4088-b107-1f3f68e21psa",
                    "owner_id": "0b41cfa6-c748-4892-b9a2-e59445b8hnfg9",
                    "owner_type": "Payment",
                    "payment_method_configuration_id": "ddc40bd5-bfd9-4ae3-92c7-959425f86d59",
                    "receiver": {
                        "company_id": "3766b0fd-6cd5-4da1-ba6a-aa7d1c630odc",
                        "id": "f2a34e72-6977-47e1-b5f7-0d2e294eaas6"
                    },
                    "receiver_id": "f2a34e72-6977-47e1-b5f7-0d2e294eaas6",
                    "take_rate": 9223.0,
                    "take_rate_type": "absolute",
                    "updated_at": "2025-05-15T10:57:32.495-03:00"
                }
            ]
        }
    ],
    "total_items": 2,
    "total_pages": 1
}