Pular para o conteúdo

List payment requests by tenant

Returns a paginated, filterable list of automatic payment requests for all sub-tenants that belong to a given tenant. Use it for back-office consoles, reconciliation, or monitoring — not for the hot path after a single payer redirect (prefer Get payment request when you already know the automatic payment request id).

GET/api/v1/automatic-payments/tenants/{tenantId}

Get payment requests by tenant

Lists automatic payment requests for every sub-tenant under the tenant, with pagination and optional filters.

Auth: Bearer Token

Parâmetros de path

1 campo
tenantId●
pathstring

Parent tenant identifier.

Parâmetros de query

20 campos
pageSize
querynumber

Page size.

pageIndex
querynumber

Zero-based page index.

skip
querynumber

Rows to skip (pagination alternative).

limitPerPage
querynumber

Rows per page (default 10 in backend).

startDate
querystring

Filter — interval start (ISO 8601).

endDate
querystring

Filter — interval end (ISO 8601).

minLastUpdateDate
querystring

Minimum `lastChangedDateTime`.

maxLastUpdateDate
querystring

Maximum `lastChangedDateTime`.

fixedAmount
querystring

Filter by fixed amount configuration.

variableAmount
querystring

Filter by variable amount configuration.

minAmount
querystring

Minimum payment amount.

maxAmount
querystring

Maximum payment amount.

debtorDocument
querystring

Debtor CPF/CNPJ filter.

creditorDocument
querystring

Creditor CPF/CNPJ filter.

debitorName
querystring

Debtor name filter.

creditorName
querystring

Creditor name filter.

consentStatus
querystring

`AUTHORISED`, `AWAITING_AUTHORISATION`, `REJECTED`, or `REVOKED`.

status
querystring

`PENDENTE`, `CONSUMIDO`, or `REJEITADO` request filter.

term
querystring

Generic search term.

paymentRequestId
querystring

Partial match on payment request id.

curl --request GET \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/automatic-payments/tenants/tenant_enterprise_001?pageSize=10&pageIndex=0&skip=0&limitPerPage=10&startDate=2026-01-01T00%3A00%3A00Z&endDate=2026-12-31T23%3A59%3A59Z&minLastUpdateDate=2026-05-01T00%3A00%3A00Z&maxLastUpdateDate=2026-05-31T23%3A59%3A59Z&fixedAmount=100.00&variableAmount=500.00&minAmount=10.00&maxAmount=1000.00&debtorDocument=76109277673&creditorDocument=12345678000195&debitorName=Maria%20Example&creditorName=Merchant%20SA&consentStatus=AUTHORISED&status=PENDENTE&term=subscription&paymentRequestId=f3b4e8c2' \
  --header 'Authorization: Bearer <SEU_TOKEN>'

Response

200List returned successfully.
Response body
object
  • dataarray of objectsrequired

    AutomaticPaymentRequest entries.

    • itemobject
  • messagestring

    Response message.

  • typestring

    Envelope type.

  • metaobjectrequired

    Pagination metadata — structure defined by the backend.

200 · List returned successfully.
{
  "data": [
    {
      "id": "f3b4e8c2-2c1d-4f6a-9c1e-5a92f3a7d8a1",
      "consentStatus": "AUTHORISED",
      "status": "CONSUMIDO",
      "createDateTime": "2026-05-01T12:00:00Z"
    }
  ],
  "message": "",
  "type": "success",
  "meta": {
    "pageIndex": 0,
    "pageSize": 10,
    "total": 1
  }
}