Skip to main content
GET
/
v1.1
/
pix-automatic
/
authorizations
List authorizations
curl --request GET \
  --url https://api.paymee.com.br/v1.1/pix-automatic/authorizations \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>'
{
  "status": 0,
  "message": "success",
  "totalElements": 1,
  "totalPages": 1,
  "resultSize": 1,
  "results": [
    {
      "id": 27,
      "idRec": "RR286838922025061604202710881",
      "status": "APPROVED",
      "periodicity": "MONTHLY",
      "minimumAmount": 11,
      "initialDate": "2025-06-19",
      "finalDate": "2025-12-15",
      "nextRecurrenceDate": "2025-07-19 03:00:00",
      "creation": "2025-06-16 07:21:04",
      "payer": {
        "document": "00000000000",
        "name": "JOHN DOE",
        "ispb": "99999919"
      },
      "contract": {
        "id": "6851c0842bf40769ead1fde5",
        "description": "contract-456"
      }
    }
  ]
}

Headers

​
x-api-key
string
required
Example:

"your-x-api-key"

​
x-api-token
string
required
Example:

"your-x-api-token"

Query Parameters

​
situation
enum<string>

Filter by authorization status.

Available options:
CREATED,
APPROVING,
APPROVED,
REJECTED,
EXPIRED,
CANCELLING,
CANCELLED,
ACTIVE,
CONCLUDED
Example:

"ACTIVE"

​
payerName
string

Filter by the payer's name.

​
initialDate
string<date>

Filter by start date (format YYYY-MM-DD).

​
finalDate
string<date>

Filter by end date (format YYYY-MM-DD).

​
page
integer
default:0

Page number for the query.

​
maxPageResults
integer
default:20

Maximum number of results per page.

​
sortBy
enum<string>
default:updatedAt

Field to sort the results by.

Available options:
updatedAt,
creation,
payerName
​
order
enum<string>
default:DESC

Sort order.

Available options:
ASC,
DESC

Response

List of authorizations returned successfully.

​
status
integer
​
message
string
​
totalElements
integer
​
totalPages
integer
​
resultSize
integer
​
results
object[]