---
updatedAt: 2025-11-11T00:10:22.000Z
agentTools:
  projectIndex: https://docs.interswitchgroup.com/v1.1/llms.txt
---

# Bulk Paycode Batch Status

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "ipg",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "https://sandbox.interswitchng.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/api/v1/pwm/bulk/tokens/comprehensive/status?referenceId={referenceId}&frontEndPartner={frontEndPartner}": {
      "get": {
        "summary": "Bulk Paycode Batch Status",
        "description": "",
        "operationId": "bulk-paycode-batch-status",
        "parameters": [
          {
            "name": "Content-Type",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "referenceId",
            "in": "query",
            "description": "Original Transaction Ref used in token generation call. E.g. 324555",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "frontEndPartner",
            "in": "query",
            "description": "Front End Partner ID sent in token generation call",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Authorization",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "\n{\n“summary”: {\n“batchReference”: “123456”,\n“numberOfSuccessful”: “10”,\n“numberOfFailed”: “0”,\n“amountOfFailed”: “0”,\n“amountOfSuccessful”: “4300000”\n},\n“successful”: [{\n  “surcharge”: “”,\n  “amount”: “400000”,\n  “beneficiaryNumber”: “08021111111”,\n  “oneTimePin”: “4321”\n  },\n  {\n  “surcharge”: “”,\n  “amount”: “300000”,\n  “beneficiaryNumber”: “08021111112”,\n  “oneTimePin”: “1234”\n  },\n  {\n  “surcharge”: “”,\n  “amount”: “500000”,\n  “beneficiaryNumber”: “08021111113”,\n  “oneTimePin”: “1234”\n  },\n  {\n  “surcharge”: “”,\n  “amount”: “400000”,\n  “beneficiaryNumber”: “08021111114”,\n  “oneTimePin”: “1234”\n  },\n  {\n  “surcharge”: “”,\n  “amount”: “300000”,\n  “beneficiaryNumber”: “08021111115”,\n  “oneTimePin”: “1234”\n  },\n  {\n  “surcharge”: “”,\n  “amount”: “500000”,\n  “beneficiaryNumber”: “08021111116”,\n  “oneTimePin”: “1234”\n  },\n  {\n  “surcharge”: “”,\n  “amount”: “500000”,\n  “beneficiaryNumber”: “08021111117”,\n  “oneTimePin”: “1234”\n  },\n  {\n  “surcharge”: “”,\n  “amount”: “400000”,\n  “beneficiaryNumber”: “08021111118”,\n  “oneTimePin”: “1234”\n  }]\n}"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```