Getting started
      Back to home
      1. Yaspa help centre
      2. Getting started

      Setting up Postman to make a test payment

      This is an overview of how to set up Postman and make a test payment using Yaspa

      NB: We’ve recently rebranded from Citizen to Yaspa, some of the code will still mention Citizen.


      Yaspa exposes an REST API to interact with our services. This is the primary mechanism used by merchant users to start payments. We are going to use a free tool called Postman to visually interact with the Yaspa API and start a payment. Download Postman from the following location, you will need to register for a free account: 

      Get the Yaspa Postman Collection


      Complete the following tasks:

      1. Download the Yaspa Postman Collection from the following location: 
        1. Yaspa Postman Collection
      2. You then need to export the collection. 
      3. Click on the three dots “” (view more actions), and select Export.  
      4. Select Collection v2.1.
      5. Open Postman and navigate to My Workspace
      6. Please click on the Import button and import the Yaspa collection. The import button can be found on the right of the navigation bar:

      1. Once done you will see a tree structure with the Yaspa API calls:

      Configuring Postman

      1. To make a payment with Postman, you need to provide Postman with your test merchant credentials. 
      2. Within the collection tree, make sure you have Citizen V2 selected and then click the Variables tab on the right.

      3. We only need the API Key for now. This can be found in the Customer Settings section of the Admin dashboard. Click the Show button to reveal your API key.

      4. Copy this key into the api_key current value cell in the Variables section of Postman:

      5. By default, the Postman collection is pointing at the base_url of the test environment (https://testapi.paywithcitizen.com). Later, if you want to make payments against a live merchant, you will need to change this to the production environment (https://api. paywithcitizen.com).

      Related articles