Get enrollment status

Get Enrollment Status

get

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

Path parameters

idintegerRequired

Enrollment ID. It is obtained when creating the enrollment.

Example: 30

Header parameters

X-Datestring · date-timeRequired

ISO8601 Datetime with Timezone: yyyy-MM-dd'T'HH:mm:ssZ

Example: 2025-10-22T10:30:00-03:00

X-LoginstringRequired

Merchant X-Login API Key

AuthorizationstringRequired

Authentication signature hash

Responses

200

Successful retrieval of enrollment information.

application/json

get

/enrollments/{id}

HTTPcURLJavaScriptPython

GET /v1/enrollments/{id} HTTP/1.1
Host: api-stg.onekeypayments.com
X-Date: 2025-10-22T10:30:00-03:00
X-Login: text
Authorization: text
Accept: */*

200

Successful retrieval of enrollment information.

{
  "enrollment_id": 30,
  "amount": 1,
  "country": "BR",
  "currency": "BRL",
  "invoice_id": "invoiceid10000",
  "amount_type": "FIXED",
  "status": "ACTIVE",
  "frequency": "MONTHLY",
  "start_date": "2025-10-22",
  "payer": {
    "id": "404606303",
    "email": "[email protected]",
    "first_name": "Ricardo",
    "last_name": "Carlos",
    "phone": "[phone]",
    "full_name": "Ricardo Carlos"
  },
  "deposits": [
    1398852515
  ]
}