Pular para o conteúdo

Get enrollment by user

Looks up a payer's enrollments by document — use this as the gate before any redirectless payment: check whether the payer already has an AUTHORISED enrollment for the current device, and skip the enrollment flow if so.

GET/api/v1/jsr/enrollments/users/{userDocument}

Get enrollment user

Looks up enrollments for a payer document, optionally filtered by device or permission.

Auth: Bearer Token

Path parameters

1 campo
userDocument●
pathstring

Enrollment user document (CPF or CNPJ digits).

Query parameters

3 campos
deviceId●
querystring

Filter enrollments by device ID.

permission
querystring

Filter enrollments by permission.

cnpj
querystring

When present, filters enrollments authorised with a business (CNPJ) document instead of a personal (CPF) document.

Headers

1 campo
subTenantId
headerstring

Sub-tenant ID when required by the authenticated user context.

curl --request GET \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/jsr/enrollments/users/76109277673?deviceId=00aa11bb22cc33dd&permission=PAYMENTS_INITIATE&cnpj=12345678000195' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --header 'subTenantId: subtenant_abc123'

Response

200User found successfully.
Response body
object
  • dataobjectrequired

    ReturnUserDto.

    • idstringrequired

      ID of the user.

    • usernamestringrequired

      Username of the user, can be CPF or Email.

    • subTenantstringrequired

      Sub-tenant of the user.

    • enrollmentsarray of objectsrequired

      Enrollments matching the filters.

  • messagestring

    Response message.

  • typestring

    Envelope type.

  • statusCodeinteger· nullable

    HTTP status in envelope.

200 · User found successfully.
{
  "data": {
    "id": "e7a52ca6-266d-4738-a9ed-f5173dfb2b56",
    "username": "76109277673",
    "subTenant": "subtenant_abc123",
    "enrollments": [
      {
        "externalId": "ext123",
        "createDateTime": "2024-11-15T13:34:11.219Z",
        "lastChangedDateTime": "2024-11-15T13:41:40.626Z",
        "organisationId": "74e929d9-33b6-4d85-8ba7-c146c867a817",
        "authorisationServerId": "c8f0bf49-4744-4933-8960-7add6e590841",
        "enrollmentId": "enr_abc123",
        "status": "AUTHORISED",
        "document": "76109277673",
        "dataUserId": "12345678901",
        "dataConsentId": "urn:raidiambank:consent:12345678901",
        "debtor": {
          "accountNumber": "1234567890",
          "accountIssuer": "0001",
          "accountIspb": "12345678",
          "accountType": "CACC"
        }
      }
    ]
  },
  "message": "",
  "type": "success",
  "statusCode": null
}

Next steps