Pular para o conteúdo

List payments by tenant

Returns a paginated, filterable list of automatic payment legs (not payment requests) for all sub-tenants under a tenant. Use aggregatePayments to group retry attempts under the same originalRecurringPaymentId.

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

Get payments by tenant

Lists automatic payments across every sub-tenant that belongs to the tenant.

Auth: Bearer Token

Parâmetros de path

1 campo
tenantId●
pathstring

Parent tenant identifier.

Parâmetros de query

13 campos
startDate
querystring

Interval start (ISO 8601).

endDate
querystring

Interval end (ISO 8601).

minLastUpdateDate
querystring

Minimum last update timestamp on the payment.

maxLastUpdateDate
querystring

Maximum last update timestamp on the payment.

status
querystring

`PENDENTE`, `EM_PROCESSAMENTO`, `PAGO`, `REJEITADO`, or `CANCELADO`.

consentStatus
queryarray<string>

Filter by consent status of the parent request (OpenAPI: array; repeat the query parameter per value).

minDueDateTime
querystring

Minimum due date/time filter.

paymentType
querystring

`AUTOMATIC` or `SWEEPING` — keep `AUTOMATIC` for this product.

aggregatePayments
querystring

When `true`, payments with `originalRecurringPaymentId` include `retriedPayments`. Defaults to `true` if omitted.

debtorDocument
querystring

Debtor CPF/CNPJ filter.

creditorDocument
querystring

Creditor CPF/CNPJ filter.

rejectionReason
querystring

Rejection reason code filter.

term
querystring

Generic search term.

curl --request GET \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/automatic-payments/payments/tenants/tenant_enterprise_001?startDate=2026-01-01T00%3A00%3A00Z&endDate=2026-12-31T23%3A59%3A59Z&minLastUpdateDate=2026-05-01T00%3A00%3A00Z&maxLastUpdateDate=2026-05-31T23%3A59%3A59Z&status=PAGO&consentStatus=%5B%22AUTHORISED%22%5D&minDueDateTime=2026-05-01T00%3A00%3A00Z&paymentType=AUTOMATIC&aggregatePayments=true&debtorDocument=76109277673&creditorDocument=12345678000195&rejectionReason=INSUFFICIENT_FUNDS&term=subscription' \
  --header 'Authorization: Bearer <SEU_TOKEN>'

Response

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

    AutomaticPayment entries — see OpenAPI for full AutomaticPayment schema.

    • itemobject
  • messagestring

    Response message.

  • typestring

    Envelope type.

  • metaobjectrequired

    Pagination metadata from the backend.

200 · List returned successfully.
{
  "data": [
    {
      "id": "pay_001",
      "status": "PAGO",
      "originalRecurringPaymentId": ""
    }
  ],
  "message": "",
  "type": "success",
  "meta": {
    "pageIndex": 0,
    "pageSize": 10,
    "total": 1
  }
}

Next steps