Postman

Overview

You can configure and tests the HTTP requests and receive responses for the following APIs:

• Reporting
• Payment
• Boarding
• Paylink

You can read more overall about the Checkout APIs from here.

Getting started

In order to get started with Postman, you will need to:

1. Fork the collection
2. Find your integration key(s) so you can make the correct authorization via the API key
3. Start to send your first request to see responses

You can get started testing with Checkout Postman by for example sending a request to retrieve a list of payouts, a request to create a new payment or a request to cancel a pending refund.

Forking the collection

You can fork the collection which means that you will create a new instance of the collection locally in your own workspace. In this way, you can test and make changes with your own keys that does not affect the base collection.

1. Sign into your Postman account.
2. Go to the Checkout API collection from here.
3. Select the Run in Postman button.
4. Select the Fork collection button.
5. Name your work and select a workspace.

Authorization

Find your key

You can find your integration keys inside of your Portal account by following this guide here.

Checkout & Recurring

For the authorization for the Checkout and Recurring folders, the API key must be authorized following these steps:

In the authorization type, you can choose API Key from the drop-down menu.

You will need to input your secret API key from the TEST environment inside value field that gets added to the header.

• The key is named Authorization
• The value field must be the secret key

Onboarding

For the authorization for the Boarding folders, the API key must be authorized following these steps:

In the authorization type, you can choose API Key from the drop-down menu.

You will need to input your secret API key from the LIVE environment inside value field that gets added to the header.

• The key is named Authorization
• The value field must be the secret key

Reporting

For the authorization for the Reporting folder, the API key must be authorized following these steps:

In the authorization type, you can choose API Key from the drop-down menu.

You will need to input your secret API key from the TEST environment inside value field that gets added to the header.

• The key is named Authorization
• The value field must be the secret key

When the authorization has been completed, you can call any API in the collection to start with the requests.

Testing

As an example, the following steps of this request will outline how to create a new payment.

It will use the Payment API to create an order containing a pair of sneakers which will then be captured using your integration keys.

Send a request - Creating the order

1. From the right-hand side bar, open up the Payment folder.
2. Click into the Checkout folder.
3. Next, choose Create payment.
4. By default, the method is set to POST.
5. Click on the Send button for the request.
6. Finally, you will be able to see the response of the request.
7. This newly created payment will also be visible inside your Portal under the Payments section.

From this, you will be able to see the following response of the request below: