---
title: "Get Package"
method: GET
path: "/packages/{package}"
tags: ["Packages"]
---

# Get Package

`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`

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`

## Path parameters

- `package` string, required: The unique identifier of the package.

## Response `200`

Successful response with the package information

- object
  - `id` string, required: The unique identifier of the package.
  - `name` string, required: The name of the package
  - `description` string, required: The description of the package
  - `package_rules` string[], required: The Package Rules
  - `fields` union[], required: Array of package fields
    - union
      - IntegerField: This field allows the user to enter an integer value.
        - `id` string, required: The unique identifier of the field.
        - `name` string, required: Name of the field.
        - `required` boolean, required: Whether the field is required.
        - `type` 'integer', required: The type of the field.
        - `default` integer, nullable, required: The default value for the field if no value is provided.
        - `min` integer, required: The minimum value that can be entered.
        - `max` integer, required: The maximum value that can be entered.
      - StringField: This field allows the user to set a string.
        - `id` string, required: The unique identifier of the field.
        - `name` string, required: Name of the field.
        - `required` boolean, required: Whether the field is required.
        - `type` 'string', required: The type of the field.
        - `default` string, nullable, required: The default value for the field.
        - `min` integer, required: The minimum length of the field.
        - `max` integer, required: The maximum length of the field.
        - `regex` string, nullable, required: The regular expression that the field must match.
      - ChoiceField: This field allows the user to select a single value from a list of options.
        - `id` string, required: The unique identifier of the field.
        - `name` string, required: Name of the field.
        - `required` boolean, required: Whether the field is required.
        - `type` 'choice', required: Type of the field.
        - `default` string, nullable, required: Default value for the field.
        - `choices` string[], required: List of choices.
      - MultiselectField: This field allows the user to select several values from a list of options.
        - `id` string, required: The unique identifier of the field.
        - `name` string, required: Name of the field.
        - `required` boolean, required: Whether the field is required.
        - `type` 'multiselect', required: Type of the field.
        - `default` string, nullable, required: Default value for the field.
        - `min` integer: Minimum number of choices.
        - `max` integer: Maximum number of choices.
        - `choices` string[], required: List of choices.
      - BooleanField: This field allows the user to provide a boolean value.
        - `id` string, required: The unique identifier of the field.
        - `name` string, required: Name of the field.
        - `required` boolean, required: Whether the field is required.
        - `type` 'boolean', required: Type of the field.
        - `default` boolean, nullable, required: Default value for the field.
      - DecimalField: This field allows the user to enter a decimal value.
        - `id` string, required: The unique identifier of the field.
        - `name` string, required: Name of the field.
        - `required` boolean, required: Whether the field is required.
        - `type` 'decimal', required: The type of the field.
        - `default` number, double, nullable, required: The default value for the field if no value is provided.
        - `min` number, double, nullable, required: The minimum value allowed for the field.
        - `max` number, double, nullable, required: The maximum value allowed for the field.
      - DateField: This field allows the user to set a date. Expected format: YYYY-MM-DD
        - `id` string, required: The unique identifier of the field.
        - `name` string, required: Name of the field.
        - `required` boolean, required: Whether the field is required.
        - `type` 'date', required: The type of the field.
        - `default` string, nullable, required: The default value for the field.
        - `min` string, date, nullable: The minimum date that can be submitted.
        - `max` string, date, nullable: The maximum date that can be submitted.
      - PercentField: This field allows the user to set a percent amount
        - `id` string, required: The unique identifier of the field.
        - `name` string, required: Name of the field.
        - `required` boolean, required: Whether the field is required.
        - `type` 'percent', required: The type of the field.
        - `default` string, nullable, required: The default value for the field.
        - `min` integer, required: The minimum length of the field.
        - `max` integer, required: The maximum length of the field.
      - WebsiteField: This field allows the user to set a website URL.
        - `id` string, required: The unique identifier of the field.
        - `name` string, required: Name of the field.
        - `required` boolean, required: Whether the field is required.
        - `type` 'website', required: The type of the field.
        - `default` string, nullable, required: The default value for the field.
        - `min` integer: The minimum length of the field.
        - `max` integer: The maximum length of the field.
        - `regex` string, nullable: The regular expression that the field must match.
      - AccountNumberField: This field allows the user to set bank account number.
        - `id` string, required: The unique identifier of the field.
        - `name` string, required: Name of the field.
        - `required` boolean, required: Whether the field is required.
        - `type` 'account_number', required: The type of the field.
        - `default` string, nullable, required: The default value for the field.
        - `min` integer: The minimum length of the field.
        - `max` integer: The maximum length of the field.
      - EmailField: This field allows the user to set an email.
        - `id` string, required: The unique identifier of the field.
        - `name` string, required: Name of the field.
        - `required` boolean, required: Whether the field is required.
        - `type` 'email', required: The type of the field.
        - `default` string, nullable, required: The default value for the field.
        - `min` integer: The minimum length of the field.
        - `max` integer: The maximum length of the field.
        - `regex` string, nullable: The regular expression that the field must match.
      - PhoneField: This field allows the user to set an phone.
        - `id` string, required: The unique identifier of the field.
        - `name` string, required: Name of the field.
        - `required` boolean, required: Whether the field is required.
        - `type` 'phone', required: The type of the field.
        - `default` string, nullable, required: The default value for the field.
      - RoutingNumberField: This field allows the user to enter USA bank routing number.
        - `id` string, required: The unique identifier of the field.
        - `name` string, required: Name of the field.
        - `required` boolean, required: Whether the field is required.
        - `type` 'routing_number', required: The type of the field.
        - `default` string, nullable, required: The default value for the field.
        - `min` integer: The minimum length of the field.
        - `max` integer: The maximum length of the field.
      - TaxIdField: This field allows the user to set a Tax ID.
        - `id` string, required: The unique identifier of the field.
        - `name` string, required: Name of the field.
        - `required` boolean, required: Whether the field is required.
        - `type` 'ssn' | 'federal_tax_id', required: The type of the field.
        - `default` string, nullable, required: The default value for the field.
        - `min` integer: The minimum length of the field.
        - `max` integer: The maximum length of the field.
      - PostalCodeField: This field allows the user to set a postal code field.
        - `id` string, required: The unique identifier of the field.
        - `name` string, required: Name of the field.
        - `required` boolean, required: Whether the field is required.
        - `type` 'postal_code', required: The type of the field.
        - `default` string, nullable, required: The default value for the field.
  - `collections` PackageCollection[], required
    - `id` string, required: The unique identifier of the collection.
    - `name` string, required: The name of the package collection.
    - `description` string, required: The description of the package collection.
    - `min` integer, required: The minimum number of records that can be added to the collection.
    - `max` integer, required: The maximum number of records that can be added to the collection.
    - `fields` union[], required: Array of package fields
      - union
        - IntegerField: This field allows the user to enter an integer value.
          - `id` string, required: The unique identifier of the field.
          - `name` string, required: Name of the field.
          - `required` boolean, required: Whether the field is required.
          - `type` 'integer', required: The type of the field.
          - `default` integer, nullable, required: The default value for the field if no value is provided.
          - `min` integer, required: The minimum value that can be entered.
          - `max` integer, required: The maximum value that can be entered.
        - StringField: This field allows the user to set a string.
          - `id` string, required: The unique identifier of the field.
          - `name` string, required: Name of the field.
          - `required` boolean, required: Whether the field is required.
          - `type` 'string', required: The type of the field.
          - `default` string, nullable, required: The default value for the field.
          - `min` integer, required: The minimum length of the field.
          - `max` integer, required: The maximum length of the field.
          - `regex` string, nullable, required: The regular expression that the field must match.
        - ChoiceField: This field allows the user to select a single value from a list of options.
          - `id` string, required: The unique identifier of the field.
          - `name` string, required: Name of the field.
          - `required` boolean, required: Whether the field is required.
          - `type` 'choice', required: Type of the field.
          - `default` string, nullable, required: Default value for the field.
          - `choices` string[], required: List of choices.
        - MultiselectField: This field allows the user to select several values from a list of options.
          - `id` string, required: The unique identifier of the field.
          - `name` string, required: Name of the field.
          - `required` boolean, required: Whether the field is required.
          - `type` 'multiselect', required: Type of the field.
          - `default` string, nullable, required: Default value for the field.
          - `min` integer: Minimum number of choices.
          - `max` integer: Maximum number of choices.
          - `choices` string[], required: List of choices.
        - BooleanField: This field allows the user to provide a boolean value.
          - `id` string, required: The unique identifier of the field.
          - `name` string, required: Name of the field.
          - `required` boolean, required: Whether the field is required.
          - `type` 'boolean', required: Type of the field.
          - `default` boolean, nullable, required: Default value for the field.
        - DecimalField: This field allows the user to enter a decimal value.
          - `id` string, required: The unique identifier of the field.
          - `name` string, required: Name of the field.
          - `required` boolean, required: Whether the field is required.
          - `type` 'decimal', required: The type of the field.
          - `default` number, double, nullable, required: The default value for the field if no value is provided.
          - `min` number, double, nullable, required: The minimum value allowed for the field.
          - `max` number, double, nullable, required: The maximum value allowed for the field.
        - DateField: This field allows the user to set a date. Expected format: YYYY-MM-DD
          - `id` string, required: The unique identifier of the field.
          - `name` string, required: Name of the field.
          - `required` boolean, required: Whether the field is required.
          - `type` 'date', required: The type of the field.
          - `default` string, nullable, required: The default value for the field.
          - `min` string, date, nullable: The minimum date that can be submitted.
          - `max` string, date, nullable: The maximum date that can be submitted.
        - PercentField: This field allows the user to set a percent amount
          - `id` string, required: The unique identifier of the field.
          - `name` string, required: Name of the field.
          - `required` boolean, required: Whether the field is required.
          - `type` 'percent', required: The type of the field.
          - `default` string, nullable, required: The default value for the field.
          - `min` integer, required: The minimum length of the field.
          - `max` integer, required: The maximum length of the field.
        - WebsiteField: This field allows the user to set a website URL.
          - `id` string, required: The unique identifier of the field.
          - `name` string, required: Name of the field.
          - `required` boolean, required: Whether the field is required.
          - `type` 'website', required: The type of the field.
          - `default` string, nullable, required: The default value for the field.
          - `min` integer: The minimum length of the field.
          - `max` integer: The maximum length of the field.
          - `regex` string, nullable: The regular expression that the field must match.
        - AccountNumberField: This field allows the user to set bank account number.
          - `id` string, required: The unique identifier of the field.
          - `name` string, required: Name of the field.
          - `required` boolean, required: Whether the field is required.
          - `type` 'account_number', required: The type of the field.
          - `default` string, nullable, required: The default value for the field.
          - `min` integer: The minimum length of the field.
          - `max` integer: The maximum length of the field.
        - EmailField: This field allows the user to set an email.
          - `id` string, required: The unique identifier of the field.
          - `name` string, required: Name of the field.
          - `required` boolean, required: Whether the field is required.
          - `type` 'email', required: The type of the field.
          - `default` string, nullable, required: The default value for the field.
          - `min` integer: The minimum length of the field.
          - `max` integer: The maximum length of the field.
          - `regex` string, nullable: The regular expression that the field must match.
        - PhoneField: This field allows the user to set an phone.
          - `id` string, required: The unique identifier of the field.
          - `name` string, required: Name of the field.
          - `required` boolean, required: Whether the field is required.
          - `type` 'phone', required: The type of the field.
          - `default` string, nullable, required: The default value for the field.
        - RoutingNumberField: This field allows the user to enter USA bank routing number.
          - `id` string, required: The unique identifier of the field.
          - `name` string, required: Name of the field.
          - `required` boolean, required: Whether the field is required.
          - `type` 'routing_number', required: The type of the field.
          - `default` string, nullable, required: The default value for the field.
          - `min` integer: The minimum length of the field.
          - `max` integer: The maximum length of the field.
        - TaxIdField: This field allows the user to set a Tax ID.
          - `id` string, required: The unique identifier of the field.
          - `name` string, required: Name of the field.
          - `required` boolean, required: Whether the field is required.
          - `type` 'ssn' | 'federal_tax_id', required: The type of the field.
          - `default` string, nullable, required: The default value for the field.
          - `min` integer: The minimum length of the field.
          - `max` integer: The maximum length of the field.
        - PostalCodeField: This field allows the user to set a postal code field.
          - `id` string, required: The unique identifier of the field.
          - `name` string, required: Name of the field.
          - `required` boolean, required: Whether the field is required.
          - `type` 'postal_code', required: The type of the field.
          - `default` string, nullable, required: The default value for the field.

## Other responses

- `404`: Error response for resource not found

---

[API](https://skmtc.dev/nmi/apis/payments-sign-up-api.md) - [All operations](https://skmtc.dev/nmi/apis/payments-sign-up-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nmi/apis/payments-sign-up-api/revisions/fb067f88923d?raw)