NMnmi
Packages

Get Package

The Packages endpoint provides package rules, a structured set of field details necessary for creating an application. It defines the required and optional fields, their formats, and any conditional rules that must be followed.

Required scope: packages:read

get/packages/{package}

Request

  • Base URL
    https://sandbox.signup.nmi.com/api/v1
  • URL
    https://sandbox.signup.nmi.com/api/v1/packages/{package}
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth/token scopes: packages:read

Path parameters

packagestring required

The unique identifier of the package.

Example:pkg_merrick_tsys

Package ID

Response

Successful response with the package information

idstring required

The unique identifier of the package.

namestring required

The name of the package

descriptionstring required

The description of the package

package_rulesstring[] required

The Package Rules

Example response

{
  "id": "pkg_merrick_tsys",
  "name": "Merrick TSYS Application Package",
  "description": "This is a standard package"
}

Changes

No recorded changes to this operation across all 1 revision of this API.