Payment API | Implementation Template

(0 reviews)


As a Retail API Led Connectivity Web Portal user I want a service to pay previously created order and to check a payment status.

License Agreement

Note that using this template is subject to the conditions of this License Agreement.
Please review the terms of the license before downloading and using this template. In short, you are allowed to use the template for free with Mule ESB Enterprise Edition, CloudHub, or as a trial in Anypoint Studio.

This endpoint will trigger subflow processPaymentSubFlow which create payment order.

This endpoint will trigger subflow checkPaymentSubFlow which check payment status of created order defined by paymentOrderId.

This template should serve as a foundation for implementing an API for payment service. API is defined using RAML and this implementation uses APIkit.
The Payment Process API is part of the Retail Templates Solution.


To make this Anypoint Template run, there are certain preconditions that must be considered. Failing to do so could lead to unexpected behavior of the template.

APIs security considerations

This Process API is meant to be deployed within a CloudHub and managed using the API Platform Manager.

Exposing external endpoints with HTTPS

  • It is triggered using HTTPS

Exposing internal endpoints with RAML and HTTPS

  • It is interconnected internally with Customer System API using HTTP as well

Exposing internal endpoints with RAML and HTTP

  • It is also interconnected with Notification System API using HTTP as well

Run it!

Simple steps to get Payment Process API running.
See below.

Running on premise

In this section we detail the way you should run your Anypoint Template on your computer.

Where to Download Mule Studio and Mule ESB

First thing to know if you are a newcomer to Mule is where to get the tools.

  • You can download Mule Studio from this Location
  • You can download Mule ESB from this Location

Importing an Anypoint Template into Studio

Mule Studio offers several ways to import a project into the workspace, for instance:

  • Anypoint Studio Project from File System
  • Packaged mule application (.jar)

You can find a detailed description on how to do so in this Documentation Page.

Running on Studio

Once you have imported you Anypoint Template into Anypoint Studio you need to follow these steps to run it:

  • Generate keystore (You can find a detailed description on how to do so in this Documentation Page)
  • Locate the properties file, in src/main/resources
  • Complete all the properties required as per the examples in the section Properties to be configured
  • Once that is done, right click on you Anypoint Template project folder
  • Hover you mouse over "Run as"
  • Click on "Mule Application"

Running on Mule ESB stand alone

Complete all properties in one of the property files, for example in and run your app with the corresponding environment variable to use it. To follow the example, this will be mule.env=prod.

Running on CloudHub

While creating your application on CloudHub (Or you can do it later as a next step), you need to go to "Manage Application" > "Properties" to set all environment variables detailed in Properties to be configured.
Follow other steps defined here and once your app is all set and started, there is no need to do anything else.

Deploying your Anypoint Template on CloudHub

Mule Studio provides you with really easy way to deploy your Template directly to CloudHub, for the specific steps to do so please check this link

Properties to be configured (With examples)

In order to use this Mule Anypoint Template you need to configure properties (APIs, configurations, etc.) either in properties file or in CloudHub as Environment Variables. The Payment Process API is using secured connection. Detail list with examples:

Application properties

  • https.port 8082

HTTPS Configuration

  • keystore.location keystore.jks
  • keystore.password pass123!
  • key.password pass123!
  • key.alias 1

API calls configuration

  • ''
  • paypal-orders-api.port '443'
  • paypal-orders-api.orderPath '/orderPath'
  • paypal-orders-api.protocol 'HTTPS'
  • paypal-orders-api.clientId 'yourPaypalClientId'
  • paypal-orders-api.clientSecret 'yourPaypalClientSecret'
  • paypal-orders-api.accesstokenPath '/tokenPath'

Path to retail portal

  • catalyst.url


Published by
MuleSoft Organization
Published onOct 29, 2019
Asset overview

Asset versions for 2.1.x

Asset versions


Industry Vertical
RetailNo values left to add