Pular para o conteúdo

List payments by sub-tenant

Returns a paginated, filterable list of automatic payment legs for a single sub-tenant. Pair with List payments by tenant when you need a tenant-wide view.

GET/api/v1/automatic-payments/payments/sub-tenants/{subTenantId}

Get payments by sub-tenant

Lists automatic payments for one sub-tenant with optional filters.

Auth: Bearer Token

Parâmetros de path

1 campo
subTenantId●
pathstring

Sub-tenant identifier.

Parâmetros de query

11 campos
startDate
querystring

Interval start (ISO 8601).

endDate
querystring

Interval end (ISO 8601).

minLastUpdateDate
querystring

Minimum last update timestamp.

maxLastUpdateDate
querystring

Maximum last update timestamp.

status
querystring

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

consentStatus
queryarray<string>

Consent status filter (OpenAPI: array; comma-separated or repeated per gateway rules).

aggregatePayments
querystring

When `true`, include `retriedPayments` for linked attempts. Defaults to `true` if omitted.

debtorDocument
querystring

Debtor CPF/CNPJ filter.

creditorDocument
querystring

Creditor CPF/CNPJ filter.

rejectionReason
querystring

Rejection reason filter.

term
querystring

Generic search term.

curl --request GET \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/automatic-payments/payments/sub-tenants/subtenant_abc123?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=EM_PROCESSAMENTO&consentStatus=%5B%22AUTHORISED%22%5D&aggregatePayments=true&debtorDocument=76109277673&creditorDocument=12345678000195&rejectionReason=INSUFFICIENT_FUNDS&term=invoice' \
  --header 'Authorization: Bearer <SEU_TOKEN>'

Response

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

    AutomaticPayment entries.

    • itemobject
  • messagestring

    Response message.

  • typestring

    Envelope type.

  • metaobjectrequired

    Pagination metadata.

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

Next steps