Pular para o conteúdo

Get enrollment

Returns the current enrollment record (status, permissions, debtor account snapshot, etc.). Use it to poll after asynchronous steps or to display enrollment state in your UI.

GET/api/v1/jsr/enrollments/{enrollmentId}

Get enrollment

Returns enrollment details by enrollment id.

Auth: Bearer Token

Parâmetros de path

1 campo
enrollmentId●
pathstring

Enrollment id from Create enrollment.

Cabeçalhos

1 campo
x-client-ip●
headerstring

End-user client IP.

curl --request GET \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/jsr/enrollments/enr_abc123' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --header 'x-client-ip: 198.21.104.1'

Response

200Enrollment retrieved.
Response body
object
  • dataobjectrequired

    EnrollmentResponse — full schema in OpenAPI includes loggedUser, businessEntity, debtorAccount.

    • enrollmentIdstring

      Enrollment id.

    • creationDateTimestring

      Creation timestamp.

    • statusstringrequired

      AWAITING_RISK_SIGNALS | AWAITING_ACCOUNT_HOLDER_VALIDATION | AWAITING_ENROLLMENT | AUTHORISED | REJECTED | REVOKED

    • statusUpdateDateTimestring

      Last status update.

    • permissionsstring
    • expirationDateTimestring

      Expiry.

    • enrollmentNamestring

      Display name.

  • messagestring

    Response message.

  • typestring

    Envelope type.

  • statusCodeinteger· nullable

    HTTP status in envelope.

200 · Enrollment retrieved.
{
  "data": {
    "enrollmentId": "enr_abc123",
    "creationDateTime": "2024-06-01T12:00:00Z",
    "status": "AUTHORISED",
    "permissions": "PAYMENTS_INITIATE",
    "enrollmentName": "User device"
  },
  "message": "OK",
  "type": "success",
  "statusCode": 200
}

Next steps