Pular para o conteúdo

Get most used participants

Returns the same participant shape as Get registered participants, but scoped to a sub-tenant and prioritized by usage — put these institutions first in your picker, then fall back to the full registered list.

GET/api/v1/sub-tenants/{subTenantId}/participants/most-used

Get most used participants by sub-tenant

Returns the institutions most frequently used for payments under this sub-tenant.

Auth: Bearer Token

Path parameters

1 campo
subTenantId●
pathstring

Sub-tenant id.

curl --request GET \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/sub-tenants/subtenant_abc123/participants/most-used' \
  --header 'Authorization: Bearer <SEU_TOKEN>'

Response

200Most used participants retrieved successfully.
Response body
object
  • dataarray of objectsrequired

    List of participants, same shape as Get registered participants — ResponseParticipants.

    • itemobject

      See ResponseParticipants in Get registered participants.

  • messagestring

    Response message.

  • typestring

    Response type. One of `error`, `warning`, `info`, `success`.

  • statusCodeinteger· nullable

    HTTP status code carried inside the envelope.

200 · Most used participants retrieved successfully.
{
  "data": [
    {
      "OrganisationName": "Open Banking Brasil",
      "OrganisationId": "74e929d9-33b6-4d85-8ba7-c146c867a817",
      "LegalEntityName": "Raidiam Services Ltd",
      "RegistrationNumber": "43142666000197",
      "ParentOrganisationReference": "43142666000197",
      "AuthorisationServers": [
        {
          "AuthorisationServerId": "c8f0bf49-4744-4933-8960-7add6e590841",
          "CustomerFriendlyName": "Mock Bank"
        }
      ]
    }
  ],
  "message": "",
  "type": "success",
  "statusCode": null
}

Next steps