Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Automatic Pix data

List recurrence authorizations

List Pix Automatic recurrence authorizations. By default, recurrences authorizations from the last 30 days with 20 records per page are returned, but you can use the beginDate and endDate query parameters to specify a different date range.

get/inst-pull-pay/v1/pix/automatic/authorizations

Query parameters

status'CREATED' | 'PENDING' | 'EXPIRED' | 'ACCEPTED' | 'REJECTED' | 'IN_PROGRESS' | 'FINISHED' | 'CANCELLED' | 'RECEIVED' | 'CONFIRMED' | 'WAITING_CUSTOMER'

Execution status filter

roleType'PAYEE' | 'PAYER' required

Role type filter.

perPageinteger
Example:15

Items per page

afterIdstring

Last returned item ID from response. Use this field to return more results.

beginDatestring

RFC 3339 begin date filter. For example: 2023-04-12T23:20:50.52Z.

Maximum days allowed between beginDate and endDate is 30. The default is 30 days prior to the current date.

endDatestring

RFC 3339 end date filter. For example: 2023-04-12T23:20:50.52Z.

Maximum days allowed between beginDate and endDate is 30. The default is the current date and time.

Headers

Authorizationstring required
Example:Bearer eyJhbGci...IUzUx

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

Response

OK

page_sizenumber

Maximum elements returned per query.

number_elementsnumber

Total items returned in query

next_pageboolean

Are tbere more results?

last_idinteger

Last returned item ID. Use this ID to get more results.

Example response

{
  "items": [
    {
      "id": 1099901,
      "role_type": "SECONDARY_INSTALLMENT",
      "created_at": "2024-09-12T16:46:16.43663522",
      "updated_at": "2024-09-12T16:46:16.43663522",
      "account_id": 6912345,
      "recurrence_id": "RN000000012025050500012345678",
      "expiration_date": "2803",
      "provider_created_at": "2024-09-12T16:46:16.43663522",
      "provider_updated_at": "2024-09-12T16:46:16.43663522",
      "max_payment_amount": 86753.09,
      "reason_code": "AC01",
      "payer": {
        "document_number": "7777888hh",
        "document_type": "NATURAL_PERSON",
        "name": "Paul Bearer",
        "bank": "237",
        "branch": "011",
        "account_number": "98765432",
        "account_type": "TRAN",
        "city_code": "3550308"
      },
      "rec_payload": {
        "recurrence_id": "RN000000012025050500012345678",
        "contract_id": "5509-uroo-78944-9987",
        "description": "Gym membership",
        "amount": 215,
        "min_payment_amount": 10.09,
        "frequency_type": "MONTH",
        "first_payment_date": "2025-04-25",
        "payee": {
          "name": "Paul Bearer",
          "document_number": "7777888hh",
          "document_type": "NATURAL_PERSON",
          "bank": "237",
          "branch": "011",
          "account_number": "98765432",
          "account_type": "TRAN"
        },
        "debtor": {
          "document_number": "7777888hh",
          "document_type": "NATURAL_PERSON",
          "name": "Paul Bearer"
        }
      }
    }
  ],
  "last_id": 1602619,
  "filters": [
    {
      "label": "status",
      "value": "CREATED"
    }
  ]
}