Cancel Enrollment Endpoint

Cancelling an Enrollment

This endpoint allows you to cancel an existing enrollment. This uses the same API credentials as the deposit endpoint. DELETE https://api-stg.onekeypayments.com/v3/enrollments/{enrollment_id}/

Path Parameters

Name	Type	Description
enrollmentId	integer	OKP enrollment_id. It is obtained when creating a new enrollment.

Headers

Name	Type	Description
Content-Type	string	application/json
X-Date	string	ISO8601 Datetime with Timezone: yyyy-MM-dd'T'HH:mm:ssZ
X-Login	string	Merchant X-Login API Key
Authorization	string	Authorization control hash
X-Idempotency-Key	string	Unique idempotency key

Example Response

{
    "enrollment_id": 36,
    "status": "CANCELLED"
}