List all Packages
GET /packages
Environment and operation
Use this endpoint contract with the account and environment assigned to your integration. Values in angle brackets are placeholders. This reference does not execute requests. Documented server https://sandbox.signup.nmi.com/api/v1 https://secure.nmi.com/api/v5/signup Schema reference: field definitions do not include every behavioral rule. Follow the workflow guidance and account prerequisites for this operation before submitting requests.
Request route
This operation returns a list of available application packages. **Required scope:** `packages:read` GET /packages Security scheme Type Credential location Scopes oauth oauth2 packages:read
Request language templates
Original transport templates derived from this endpoint’s documented method, server, authentication and media type. Replace path/query/credential placeholders with authorized sandbox values. These examples print the raw status and response; they do not infer business success or retry a request. Node requires a runtime with fetch; PHP requires cURL. Generated source-based examples have not been executed against provider accounts. curl --request GET \ --url 'https://sandbox.signup.nmi.com/api/v1/packages' \ --header 'Authorization: Bearer <access-token>' const response = await fetch("https://sandbox.signup.nmi.com/api/v1/packages", { method: 'GET', headers: { "Authorization": "Bearer <access-token>" } }); console.log(response.status, await response.text()); from urllib.request import Request, urlopen from urllib.error import HTTPError request = Request('https://sandbox.signup.nmi.com/api/v1/packages', method='GET', headers={'Authorization': 'Bearer <access-token>'}) try: with urlopen(request, timeout=30) as response: print(response.status, response.read().decode()) except HTTPError as error: print(error.code, error.read().decode()) require 'net/http' require 'uri' uri = URI("https://sandbox.signup.nmi.com/api/v1/packages") request = Net::HTTP::Get.new(uri) request["Authorization"] = "Bearer <access-token>" response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https', read_timeout: 30) { |http| http.request(request) } puts response.code puts response.body <?php $curl = curl_init('https://sandbox.signup.nmi.com/api/v1/packages'); curl_setopt_array($curl, [ CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 30, CURLOPT_HTTPHEADER => ['Authorization: Bearer <access-token>'] ]); $response = curl_exec($curl); if ($response === false) { throw new RuntimeException(curl_error($curl)); } echo curl_getinfo($curl, CURLINFO_HTTP_CODE), PHP_EOL, $response; curl_close($curl);
Path and query parameters
Required flags apply to the parameter itself. Additional limits and enum values appear in the contract below. Parameter Location Required Type Description page query false integer Page number per_page query false integer Number of packages per page [ { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "per_page", "in": "query", "description": "Number of packages per page", "required": false, "schema": { "type": "integer", "enum": [ 10, 20, 50, 100 ], "default": 10 } } ] true
Responses
Match the HTTP status to its response schema below. For financial operations, also inspect the payment outcome before updating your order or retrying. HTTP status Media type Meaning 200 application/json Successful response 422 application/json Bad request (validation error) response for invalid page size { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/packages-list" }, { "$ref": "#/components/schemas/pagination" } ] }, "examples": { "success": { "summary": "Success", "description": "The response contains the standard package.", "value": { "packages": [ { "id": "pkg_merrick_tsys", "name": "Merrick TSYS Application Package", "description": "Merrick TSYS Application Package" } ], "current_page": 1, "per_page": 10, "last_page": 1, "total": 1 } } } } } }, "422": { "description": "Bad request (validation error) response for invalid page size", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code", "maxLength": 1000 }, "message": { "type": "string", "description": "Error message", "maxLength": 1000 }, "errors": { "type": "array", "maxItems": 1000, "items": { "type": "string", "description": "The error message", "maxLength": 1000 } } } }, "examples": { "standard": { "summary": "Invalid Page Size", "description": "This response is returned when the page size is invalid", "value": { "code": "VALIDATION_ERROR", "message": "The selected per page is invalid.", "errors": [ "The selected per page is invalid." ] } } } } } } } true
Response fields · 200 · application/json
Field Type Required Description Constraints [allOf 1].packages array yes [allOf 1].packages[].id string yes The unique identifier of the package. minLength: 7; maxLength: 20; pattern: "^pkg_[a-z0-9_]{3,16}$" [allOf 1].packages[].name string yes The name of the package minLength: 1; maxLength: 1000 [allOf 1].packages[].description string yes The description of the package minLength: 1; maxLength: 1000 [allOf 2].current_page integer yes The current page number [allOf 2].last_page integer yes The last page number [allOf 2].per_page integer yes The number of items per page (allowed values: 10, 20, 50, 100) enum: [10, 20, 50, 100] [allOf 2].total integer yes The total number of items
Response fields · 422 · application/json
Field Type Required Description Constraints code string no Error code maxLength: 1000 message string no Error message maxLength: 1000 errors array no
Referenced schema definitions
References beginning with #/components resolve to these definitions. These are field contracts, not example payment values. Use the applicable variant, required fields and constraints. { "securitySchemes": { "oauth": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "/oauth/token", "scopes": { "*": "Full access", "packages:read": "Read packages information", "applications:read": "Read access to applications", "applications:write": "Write access to applications", "subscriptions:read": "Read access to subscriptions", "subscriptions:write": "Write access to subscriptions (subscribe/updated/delete)" } } } } }, "schemas": { "package-id": { "type": "string", "description": "The unique identifier of the package.", "pattern": "^pkg_[a-z0-9_]{3,16}$", "minLength": 7, "maxLength": 20, "example": "pkg_merrick_tsys" }, "package-name": { "type": "string", "description": "The name of the package", "minLength": 1, "maxLength": 1000, "example": "Merrick TSYS Application Package" }, "package-description": { "type": "string", "description": "The description of the package", "minLength": 1, "maxLength": 1000, "example": "This is a standard package" }, "package": { "type": "object", "title": "Package", "description": "Package information", "required": [ "id", "name", "description" ], "properties": { "id": { "$ref": "#/components/schemas/package-id" }, "name": { "$ref": "#/components/schemas/package-name" }, "description": { "$ref": "#/components/schemas/package-description" } } }, "packages-list": { "type": "object", "description": "List of application packages", "required": [ "packages" ], "properties": { "packages": { "type": "array", "maxItems": 100, "items": { "$ref": "#/components/schemas/package" } } } }, "pagination": { "type": "object", "summary": "Pagination information", "required": [ "current_page", "last_page", "per_page", "total" ], "properties": { "current_page": { "type": "integer", "description": "The current page number" }, "last_page": { "type": "integer", "description": "The last page number" }, "per_page": { "type": "integer", "enum": [ 10, 20, 50, 100 ], "description": "The number of items per page (allowed values: 10, 20, 50, 100)" }, "total": { "type": "integer", "description": "The total number of items" } } }, "event-types": { "type": "string", "enum": [ "application.updated.data.requested", "application.approved", "application.declined", "application.cancelled", "application.merchant.closed", "application.merchant.boarded", "merchant.chargeback.added", "merchant.deposit.new", "merchant.first-batch", "merchant.processing.start", "merchant.processing.stop", "merchant.residuals.published", "merchant.retrieval.added", "merchant.statement.new" ], "example": "application.merchant.boarded" } }, "responses": { "validation-error-page-size": { "description": "Bad request (validation error) response for invalid page size", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code", "maxLength": 1000 }, "message": { "type": "string", "description": "Error message", "maxLength": 1000 }, "errors": { "type": "array", "maxItems": 1000, "items": { "type": "string", "description": "The error message", "maxLength": 1000 } } } }, "examples": { "standard": { "summary": "Invalid Page Size", "description": "This response is returned when the page size is invalid", "value": { "code": "VALIDATION_ERROR", "message": "The selected per page is invalid.", "errors": [ "The selected per page is invalid." ] } } } } } } } } true
Integration checks
Validate the request against its selected schema before submission. Keep secrets outside browser code. Test permitted and denied account access, validation failures and interrupted responses in the sandbox. Account-management or messaging operations require the corresponding partner access and intended recipient context.