> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gr4vy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Postman Collection

Postman is a popular app for API development and testing. To help developers get started with the API,
Gr4vy provides a Postman collection that can be used to make requests to the API.

This guide walks through how to install Postman, load the custom collection and environment, and start making API calls.

## Prerequisites

Before using the Postman collection, download, and install Postman. The latest version of
Postman is available from the [Postman website](https://www.postman.com/downloads/).

## Installation

Once Postman is installed, the collection and environment can be loaded with one click using the button below.

[![Postman Collection](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/11991320-46b91ff9-d361-420d-b5b6-a2f139cb4e4e?action=collection%2Ffork\&source=rip_markdown\&collection-url=entityId%3D11991320-46b91ff9-d361-420d-b5b6-a2f139cb4e4e%26entityType%3Dcollection%26workspaceId%3De6fdb014-7757-4909-98ae-c50d97ddb383#?env%5BGr4vy%20-%20Environment%5D=W3sia2V5IjoiYmFzZVVybCIsInZhbHVlIjoiaHR0cHM6Ly9hcGkuc2FuZGJveC5leGFtcGxlLmdyNHZ5LmFwcCIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9hcGkuc2FuZGJveC5leGFtcGxlLmdyNHZ5LmFwcCIsImNvbXBsZXRlU2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9hcGkuc2FuZGJveC5leGFtcGxlLmdyNHZ5LmFwcCIsInNlc3Npb25JbmRleCI6MH0seyJrZXkiOiJwcml2YXRlS2V5IiwidmFsdWUiOiItLS0tLUJFR0lOIFBSSVZBVEUgS0VZLS0tLS1cbi4uLlxuLS0tLS1FTkQgUFJJVkFURSBLRVktLS0tLSIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoiLS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tXG4uLi5cbi0tLS0tRU5EIFBSSVZBVEUgS0VZLS0tLS0iLCJjb21wbGV0ZVNlc3Npb25WYWx1ZSI6Ii0tLS0tQkVHSU4gUFJJVkFURSBLRVktLS0tLVxuLi4uXG4tLS0tLUVORCBQUklWQVRFIEtFWS0tLS0tIiwic2Vzc2lvbkluZGV4IjoxfSx7ImtleSI6InRodW1icHJpbnQiLCJ2YWx1ZSI6IlRvS2k5VEc1X21QV2VqUVh2ZE9rLi4uIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJzZXNzaW9uVmFsdWUiOiJUb0tpOVRHNV9tUFdlalFYdmRPay4uLiIsImNvbXBsZXRlU2Vzc2lvblZhbHVlIjoiVG9LaTlURzVfbVBXZWpRWHZkT2suLi4iLCJzZXNzaW9uSW5kZXgiOjJ9LHsia2V5Ijoic2NvcGVzIiwidmFsdWUiOiJbXCIqLnJlYWRcIiwgXCIqLndyaXRlXCJdIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJzZXNzaW9uVmFsdWUiOiJbXCIqLnJlYWRcIiwgXCIqLndyaXRlXCJdIiwiY29tcGxldGVTZXNzaW9uVmFsdWUiOiJbXCIqLnJlYWRcIiwgXCIqLndyaXRlXCJdIiwic2Vzc2lvbkluZGV4IjozfSx7ImtleSI6ImVtYmVkIiwidmFsdWUiOiJ7fSIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoie30iLCJjb21wbGV0ZVNlc3Npb25WYWx1ZSI6Int9Iiwic2Vzc2lvbkluZGV4Ijo0fSx7ImtleSI6Im1lcmNoYW50QWNjb3VudElkIiwidmFsdWUiOiJkZWZhdWx0IiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJzZXNzaW9uVmFsdWUiOiJkZWZhdWx0IiwiY29tcGxldGVTZXNzaW9uVmFsdWUiOiJkZWZhdWx0Iiwic2Vzc2lvbkluZGV4Ijo1fV0=)

### Manual installation

Although the most convenient way, this collection is only updated occasionally. An auto-updated collection can be manually installed but
requires manually updating to the latest version.

<Expandable title="Load the collection">
  To load the collection:

  1. Go to the [Postman GitHub repository](https://github.com/gr4vy/gr4vy-postman).
  2. Download the `Gr4vy.postman_collection.json` file.
  3. Open Postman.
  4. In the **Import** dialog, select **File** and upload the downloaded file.
  5. Drag the file into the import modal.

  The Postman collection is now available in the **Collections** tab on the left side of the Postman window.
</Expandable>

<Expandable title="Load the environment">
  The Postman environment is a set of variables that are used in the Postman collection. These variables allow for quickly switching
  between different instances, API keys, and merchant accounts.

  To load the environment:

  1. Go to the [Postman GitHub repository](https://github.com/gr4vy/gr4vy-postman).
  2. Download the `Gr4vy.postman_environment.json` file.
  3. In Postman, click the **Import** button.
  4. In the **Import** dialog, select **File** and upload the downloaded file.
  5. Click **Import**.

  The Postman environment is now available in the **Environments** tab in the top right corner of the Postman window.
</Expandable>

## Environment setup

Before making API calls, configure the Postman environment with an API key and additional information.

1. In the top right corner of the Postman window, select the **Gr4vy** environment from the dropdown menu.
2. Click the **Environment quick look** icon (the eye icon) to the right of the environment dropdown.
3. In the **Environment** tab, a list of variables is displayed. Set the following variables:
   * `baseUrl` - Set this to the production or sandbox URL.
   * `privateKey` - Set this to the RSA private key to use
   * `thumbprint` - The thumbprint, or key ID, for the private key. This is visible in the dashboard.
   * `scopes` - A list of API scopes to use for each request.
   * `embed` - Any additional embed parameters to add.
   * `merchantAccountId` - The merchant account ID on the instance.

## Using the collection

Once the environment is configured, API calls can be made.

1. In the top right corner of the Postman window, select the **Gr4vy** environment from the dropdown menu.
2. In the **Collections** tab on the left side of the Postman window, expand the **Gr4vy API** collection.
3. A list of API endpoints, organized into folders, is displayed.
4. Select an API endpoint to call.
5. The request details are displayed in the main Postman window.
6. Click the **Send** button to make the API call.

The API response is displayed in the **Response** section at the bottom of the Postman window.

## Further Information

For more information on the Gr4vy API, refer to the [API Reference](/reference).

For questions or help with the Postman collection, contact the support team.