List payments

GET

GET https://external-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://external-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 YOUR_API_TOKEN'

Example response

{
    "results": [
        {
            "amount_cents": 8379,
            "barcode": null,
            "barcode_image_url": null,
            "bill_id": "228c976b-dcc9-5528-8bc0-96d68042b144",
            "created_at": "2023-09-19T11:46:01.080-03:00",
            "expires_at": "2023-09-21T23:59:59.999-03:00",
            "id": "015b38f4-b2bf-5f54-b34a-44e0aa203bde",
            "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=228c976b-dcc9-5528-8bc0-96d68042b144"
        },
        {
            "amount_cents": 207000,
            "barcode": null,
            "barcode_image_url": null,
            "bill_id": "867c4b73-84b2-5707-aaab-4937066abcca",
            "created_at": "2023-11-01T12:54:22.240-03:00",
            "expires_at": "2023-11-03T23:59:59.999-03:00",
            "id": "80af14e6-5624-528a-a407-8eccedfd96bc",
            "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=867c4b73-84b2-5707-aaab-4937066abcca"
        }
    ],
    "total_items": 2,
    "total_pages": 1
}