Cancel an enrollment

Cancel an Enrollment

delete

This endpoint allows you to cancel an existing enrollment.

This uses the same API credentials as the deposit endpoint.

Path parameters

enrollment_idintegerRequired

OKP enrollment_id. It is obtained when creating a new enrollment.

Header parameters

X-LoginstringRequired

Merchant X-Login API Key.

X-DatestringRequired

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

AuthorizationstringRequired

Authorization control hash.

X-Idempotency-KeystringRequired

Unique idempotency key.

Content-TypestringRequired

Content type of the request.

Default: application/json

Responses

200

Enrollment cancelled successfully.

application/json

enrollment_idintegerOptional

The ID of the cancelled enrollment.

Example: 36

statusstringOptional

The new status of the enrollment.

Example: CANCELLED

delete/v3/enrollments/{enrollment_id}/

HTTPcURLJavaScriptPython

DELETE /v3/enrollments/{enrollment_id}/ HTTP/1.1
Host: api-stg.onekeypayments.com
X-Login: text
X-Date: text
Authorization: text
X-Idempotency-Key: text
Content-Type: application/json
Accept: */*

200

Enrollment cancelled successfully.

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