Pular para o conteúdo

List automatic payment requests by user CPF

Returns a paginated list of automatic payment requests for a payer identified by CPF (path userCpf). This route requires the subTenantId header so the backend can resolve which initiator context to query.

GET/api/v1/automatic-payments/{userCpf}

Get automatic payment requests by user CPF

Lists automatic payment requests for a user CPF with optional filters and pagination.

Auth: Bearer Token

Parâmetros de path

1 campo
userCpf●
pathstring

Payer CPF (digits only, 11 characters).

Parâmetros de query

8 campos
pageSize
querynumber

Page size.

pageIndex
querynumber

Zero-based page index.

skip
querynumber

Rows to skip.

limitPerPage
querynumber

Rows per page (default 10).

consentStatus
querystring

AUTHORISED | AWAITING_AUTHORISATION | REJECTED | REVOKED.

status
querystring

PENDENTE | CONSUMIDO | REJEITADO (payment request status filter).

type
querystring

SWEEPING | AUTOMATIC — product filter.

withConsent
querystring

When `true`, restrict to requests that already carry a consent id.

Cabeçalhos

1 campo
subTenantId●
headerstring

Sub-tenant identifier for the initiator context.

curl --request GET \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/automatic-payments/12345678901?pageSize=10&pageIndex=0&skip=0&limitPerPage=10&consentStatus=AUTHORISED&status=CONSUMIDO&type=AUTOMATIC&withConsent=true' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --header 'subTenantId: subtenant_abc123'

Response

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

    AutomaticPaymentRequest entries.

    • itemobject
  • messagestring
  • typestring
  • subTenantsByIdentityarray of string

    Auxiliary list returned by the API.

    • itemstring
  • metaobjectrequired

    Pagination metadata.

200 · List returned successfully.
{
  "data": [],
  "message": "",
  "type": "success",
  "subTenantsByIdentity": [],
  "meta": {
    "pageIndex": 0,
    "pageSize": 10,
    "total": 0
  }
}

Next steps