Enrollment Status Endpoint

Enrollment Status

GET https://api-stg.onekeypayments.com/v1/enrollments/{id}

This endpoint allows you to obtain the information of a certain enrollment, together with all the deposits tied to it.

Path Parameters

Name	Type	Description
id*	integer	Enrollment ID. It is obtained when creating the enrollment.

Headers

Name	Type	Description
X-Date*	string	ISO8601 Datetime with Timezone: yyyy-MM-dd'T'HH:mm:ssZ
X-Login*	string	Merchant X-Login API Key
Authorization*	string	Authentication signature hash

Example response

{
    "enrollment_id": 30,
    "amount": 1.00,
    "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
    ]
}

This response gives you all the information about the enrollment created, and also the "deposits" object, which includes all the deposits tied to this enrollment ID. You can use the regular deposit status API to get details of each deposit ID.