List Payments

List Payments

GET {{Environment_URL}}/v1/payments/simple-pay

This route accepts various query params for pagination and filtering, note that some params must be used in conjunction with other params.

The full list can be seen under PARAMS

Headers

Name	Value
Authorization	Bearer <token>

Query Params

Name	Description	Value
limit	Documents per page ∙ Min 15 | Max 100 | Default 15	15
page	Page number	0
externalId	Specific payment identifier	myid_001
amount	Value in Brazilian cents	10000
status	Operation status ∙ CREATED | AWAITING | PAID | REFUNDED | CANCELED	CREATED
ownerDocument	CPF (123.456.789-10) or CNPJ (12.345.678/9999-10)	12345678910
rangeStart	Initial interval for operation value ∙ Must be used with rangeEnd	10000
rangeEnd	Final interval for operation value ∙ Must be used with rangeStart	15000
createdAtStart	Initial cretedAt date interval ∙ Must be used with createdAtEnd	YYYY-MM-DD
createdAtEnd	Initial cretedAt date interval ∙ Must be used with createdAtStart	YYYY-MM-DD
updatedAtStart	Initial updateAt date interval ∙ Must be used with updatedAtEnd	YYYY-MM-DD
updatedAtEnd	Final updatedAt date interval ∙ Must be used with updatedAtStart	YYYY-MM-DD

Response

200 - OK

{
    "page": 1,
    "totalPages": 1,
    "docsShown": 15,
    "totalDocs": 30,
    "docs": [
        {
            "id": 121,
            "ownerDocument": "12345678910",
            "agentId": 761,
            "resource": "PAYIN",
            "status": "EXPIRED",
            "amount": 780,
            "externalId": "cmpny_IO67ymGaHe1xEZP",
            "resourceId": null,
            "instruments": [
                {
                    "method": "DYNAMIC_PIX",
                    "info": {
                        "createdAt": "2024-07-03T00:00:00.000Z",
                        "expiresAt": "2024-07-04T00:00:00.000Z",
                        "qrCodeUrl": "PIX_URL_PLACEHOLDER",
                        "transactionId": "04a6ec12-3769-4424-9cd3-54bf28838c96",
                        "dynamicPixCode": "PIX_CODE_PLACEHOLDER"
                    },
                    "paymentOrigin": null,
                    "transactionEndToEndId": null
                }
            ],
            "createdAt": "2024-07-03T00:00:00.000Z",
            "updatedAt": "2024-07-04T00:00:00.000Z"
        }
    ]
}