Disable a PIN batch

POST

/v1/datapin/b2b/batches/{uuid}/disable

Stops the batch's unused PINs from loading — for lost or stolen cards. PINs already loaded are not affected. Note: Once disabled, only an administrator can re-enable the batch.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Success

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location 'http://localhost:5050/v1/datapin/b2b/batches//disable' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "reason": "Printed with the wrong plan"
}'

Response Example

200 - Success

{
    "success": true,
    "message": "Batch disabled. Its unused PINs will not load until it is enabled again.",
    "statusCode": 200,
    "path": "/v1/…",
    "timestamp": "2026-09-26T12:00:00.000Z",
    "hash": "a1b2c3d4-…",
    "data": {
        "batch": {
            "uuid": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f",
            "label": "Ikeja shop — March",
            "status": "DISABLED",
            "network": "MTN",
            "plan": {
                "planId": "MTN-1GB-30D",
                "name": "1GB · 30 days"
            },
            "quantity": 2,
            "pins": {
                "active": 2,
                "used": 0,
                "disabled": 0,
                "refunded": 0
            },
            "approvedVia": null,
            "approvedAt": null,
            "createdAt": "2026-10-06T09:15:00.000Z"
        }
    }
}

Modified at 2026-10-07 16:20:08

Reject a PIN batch

List a batch's PINs