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

Path parameters

1 campo
enrollmentId●
pathstring

Enrollment id from Create enrollment.

Headers

2 campos
x-client-ip●
headerstring

End-user client IP.

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/enr_abc123' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --header 'x-client-ip: 198.21.104.1' \
  --header 'subTenantId: subtenant_abc123'

Response

200Enrollment retrieved.
Response body
object
  • dataobjectrequired

    EnrollmentDataDto.

    • enrollmentIdstringrequired

      Enrollment id.

    • creationDateTimestringrequired

      Creation timestamp.

    • statusstringrequired

      AWAITING_RISK_SIGNALS | AWAITING_ACCOUNT_HOLDER_VALIDATION | AWAITING_ENROLLMENT | AUTHORISED | REJECTED | REVOKED

    • statusUpdateDateTimestringrequired

      Last status update.

    • permissionsarray of itemsrequired

      PAYMENTS_INITIATE | RECURRING_PAYMENTS_INITIATE

    • expirationDateTimestring· nullable

      Expiry.

    • loggedUserobjectrequired
    • businessEntityobject· nullable

      Same shape as `loggedUser` — populated for CNPJ enrollments.

    • debtorAccountobject· nullable
    • dataUserIdstring· nullable

      Data User ID.

    • dataConsentIdstring· nullable

      Data Consent ID.

    • enrollmentNamestring· nullable

      Display name.

  • linksobjectrequired
    • selfstringrequired

      Link to the current resource.

    • nextstringrequired

      Link to the next page, when applicable.

    • laststringrequired

      Link to the last page, when applicable.

  • metaobjectrequired
    • totalRecordsnumberrequired
    • totalPagesnumberrequired
200 · Enrollment retrieved.
{
  "data": {
    "enrollmentId": "urn:raidiambank:0301b1d9-e23f-449d-8943-8e39f7115072",
    "creationDateTime": "2024-11-15T13:34:11.219Z",
    "status": "AUTHORISED",
    "statusUpdateDateTime": "2024-11-15T13:41:40.626Z",
    "permissions": [
      "PAYMENTS_INITIATE"
    ],
    "expirationDateTime": "2025-11-15T13:34:11.219Z",
    "loggedUser": {
      "document": {
        "identification": "76109277673",
        "rel": "CPF"
      }
    },
    "businessEntity": null,
    "debtorAccount": {
      "ispb": "12345678",
      "issuer": "0001",
      "number": "1234567890",
      "accountType": "CACC"
    },
    "dataUserId": "12345678901",
    "dataConsentId": "urn:raidiambank:consent:12345678901",
    "enrollmentName": null
  },
  "links": {
    "self": "https://matls-api.mockbank.poc.raidiam.io/open-banking/enrollments/v2/enrollments/urn:raidiambank:0301b1d9-e23f-449d-8943-8e39f7115072",
    "next": "",
    "last": ""
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

Next steps