> For the complete documentation index, see [llms.txt](https://apidocs.onekeypayments.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.onekeypayments.com/api-reference/deposits-api/automatic-pix/get-enrollment-status.md).

# Get enrollment status

## Get Enrollment Status

> Obtain the information of a certain enrollment, together with all the deposits tied to it.

```json
{"openapi":"3.0.3","info":{"title":"OneKey Payments API","version":"v1"},"servers":[{"url":"https://api-stg.onekeypayments.com/v1","description":"Staging Server"}],"paths":{"/enrollments/{id}":{"get":{"tags":["Enrollments"],"summary":"Get Enrollment Status","description":"Obtain the information of a certain enrollment, together with all the deposits tied to it.","operationId":"getEnrollmentById","parameters":[{"name":"id","in":"path","description":"Enrollment ID. It is obtained when creating the enrollment.","required":true,"schema":{"type":"integer"}},{"name":"X-Date","in":"header","description":"ISO8601 Datetime with Timezone: yyyy-MM-dd'T'HH:mm:ssZ","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"X-Login","in":"header","description":"Merchant X-Login API Key","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Authentication signature hash","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful retrieval of enrollment information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Enrollment"}}}}}}}},"components":{"schemas":{"Enrollment":{"type":"object","properties":{"enrollment_id":{"type":"integer","description":"The unique identifier for the enrollment."},"amount":{"type":"number","format":"double","description":"The amount to be charged."},"country":{"type":"string","description":"Country code (ISO 3166-1 alpha-2)."},"currency":{"type":"string","description":"Currency code (ISO 4217)."},"invoice_id":{"type":"string","description":"Your internal invoice identifier."},"amount_type":{"type":"string","description":"Type of amount."},"status":{"type":"string","description":"The current status of the enrollment."},"frequency":{"type":"string","description":"How often the charge occurs."},"start_date":{"type":"string","format":"date","description":"The date the enrollment begins."},"payer":{"$ref":"#/components/schemas/Payer"},"deposits":{"type":"array","items":{"type":"integer","description":"A unique deposit ID."}}}},"Payer":{"type":"object","description":"Object containing information about the payer.","properties":{"id":{"type":"string","description":"The payer's unique identifier."},"email":{"type":"string","format":"email","description":"The payer's email address."},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string","description":"The payer's phone number in E.164 format."},"full_name":{"type":"string"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://apidocs.onekeypayments.com/api-reference/deposits-api/automatic-pix/get-enrollment-status.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.