Skip to content

Using Postman

  Less than to read

To see the Sage Payments Out Service Provider API in action you can use Postman. Postman is a multi-platform REST client with intuitive GUI for:

  • configuring HTTP requests
  • designing JSON payloads
  • viewing HTTP responses

Get Postman

Visit the Postman website to download and install Postman.

If you need help with Postman, they provide help and learning resources in the Postman Learning Center.

Fork the Postman collection

Postman supports collections which are a pre-packaged bundle of API requests. To assist in the development and testing of your integration, we have provided a Postman collection to cover the Payments Out Service flows. For more information about the collections, including use cases and flows, go to the provider flows section.

  1. Open the Payments Out Service Flows Postman collection
  2. Choose to Fork Collection
  3. Create a fork label
  4. Select a workspace, then select Fork Collection
  5. This will then also be available within your desktop postman application

Or import the Postman collection

  1. Select Run in Postman
  2. Choose to import a copy of the collection
  3. Allow the Postman app to open your desktop version
  4. Select the workspace you would like to import the collections into

Import the environment JSON received during registration

The environment JSON was provided by Sage during registration. It contains the details of the sandbox test environment including your client ID and secret. The environment JSON must also be imported into Postman so the collections can function.

  1. Unzip the JSON format file from the downloaded ZIP archive
  2. Open Postman
  3. Select the manage environments option at the top right of the Postman UI
  4. From the manage environments view, select Import
  5. Select the choose files option and locate the environment JSON file
  6. Ensure the new environment is selected once imported

Pull updates

If we update the Postman collection, these changes will not automatically update within your fork. You will need to pull these changes. To do this:

  1. Choose the Postman collection
  2. Select view more
  3. Then choose to pull changes
  4. Any available changes will be displayed
  5. Select pull changes, any changes will be pulled

For more information regarding version control, visit Postman learning.

Submit updates

If you make any updates to the Postman collection that’ll benefit the developer community, we’d love you to share. Creating a pull request to our public collections allows us to review these changes and approve them.

  1. Ensure you are using a public workspace
  2. Choose the Postman collection
  3. Select view more
  4. Then choose to Create pull request
  5. Give a title which provides a brief overview of your update
  6. Within the description box, share detail regarding these changes
  7. Add a member of our team as a reviewer;
    • jordanSage
  8. Select Create pull request
  9. When you’ve completed this, our team will review your updates and merge

For further information regarding version control, visit Postman learning.

Code snippets

Postman can convert an API request into a code snippet, and you can choose the programming language or framework. You can use this generated code snippet in your front-end applications.

For further information regarding code snippets, visit Postman Code Snippets Guide.

Use cases and diagrams

To visualise the Postman collection and aid the testing of your integration, go to the Integrate section containing use cases and flow diagrams.