Pular para o conteúdo

List automatic payments by tenant

Returns a paginated list of automatic payment legs (not payment requests) for all sub-tenants under a tenant. Use date and document filters to narrow reconciliation exports.

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

9 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 | CANCELADO.

debtorDocument
querystring

Debtor CPF/CNPJ filter.

creditorDocument
querystring

Creditor CPF/CNPJ filter.

rejectionReason
querystring

Rejection reason code.

term
querystring

Generic search term.

curl --request GET \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/automatic-payments/payments/tenants/tenant-123?startDate=2024-01-01T00%3A00%3A00Z&endDate=2024-12-31T23%3A59%3A59Z&minLastUpdateDate=2024-01-01T00%3A00%3A00Z&maxLastUpdateDate=2024-12-31T23%3A59%3A59Z&status=PAGO&debtorDocument=12345678901&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 schema.

    • itemobject
  • messagestring
  • typestring
  • metaobjectrequired

    Pagination metadata.

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

Next steps