Trying our API using Postman

Postman is a tool for easily calling REST API endpoints. PaySimple has created a collection containing executable API sample calls.

1. Get Postman

Download the Postman app for Mac, Windows and Linux and install:

https://www.getpostman.com/apps

2. Get the API4 Collection

Import the API4 Collection into your workspace in Postman:

API4

3. Set Collection Level Variables

Under "Current Value"

1. For key "auth_header", enter your "reseller" followed by a space followed by your Sandbox reseller key
2. For key "merchant_id", enter your test sandbox merchant id

4. Explore and try different endpoints

Some collection requests and folders have tests that set variables after calls are made. You can also set the variables manually to values using environment or collection level variables.

5. Execute common scenarios

In the PaySimple API v4 Collection contains several folders with requests for common scenarios:

1. Make payment with new customer
   Creates a customer, creates a credit card account, makes a payment, retrieves the payment, voids the payment, makes another payment that is declined

2. Make payment and refund
   Makes a payment with customer created in step 1, settles it (simulated for test) and issues a refund

3. Schedules
   Executes Recurring Payment calls

4. Customer
   Executes Customer calls

As the input of most api calls depend on the output of a previous call, they must be executed sequentially.

You can also run all of the scenarios using Postman collection runner (click 'Run Collection' from the' View More Actions' ellipsis or the Runner button at the bottom).