List a batch's PINs

GET

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

The PINs in a batch, with each one’s status and, once loaded, the phone number and order. Up to 1000 per page.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Path Params

Query Params

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//pins?search=&status=' \
--header 'x-api-key: <api-key>'

Response Example

200 - Success

{
    "success": true,
    "message": "Request successful",
    "statusCode": 200,
    "path": "/v1/…",
    "timestamp": "2026-09-26T12:00:00.000Z",
    "hash": "a1b2c3d4-…",
    "data": [
        {
            "uuid": "0b8f6a2e-1c3d-4e5f-8a9b-0c1d2e3f4a5b",
            "serial": "DP7KQ4M2XH9A",
            "pin": "4471-9920-1183",
            "status": "USED",
            "usedBy": "08012345678",
            "usedAt": "2026-10-06T12:01:00.000Z",
            "order": {
                "reference": "DB-DPL-20261006-MFX2K9QZ-5B1E0A47",
                "status": "SUCCESS"
            }
        }
    ]
}

Modified at 2026-10-07 13:23:21

Disable a PIN batch

Look up a PIN