zarinpal-java-client

Zarinpal Java Client is a simple library used for zarinpal restful gateway. This is not written by zarinpal developer and not for the company itself, therefore you should note that this is not an official client

It is called a simple library because it does not handle the status codes for you, and it only covers payment request and verification.

Add to project

To add this library to your project, you fist have to add jitpack repository:

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

Then for add the dependency:

<dependency>
    <groupId>com.github.youtopin</groupId>
    <artifactId>zarinpal-java-client</artifactId>
    <version>1.2.1-release</version>
</dependency>

If you are using gradle, sbt, or leiningen, see Jitpack

Usage

This library does not force you to enter the MerchantCode directly into services. Instead you should implement com.youtopin.zarinpal.service.MerchantProvider and return the MerchantCode in any ways that suits you. Then you can easily use ZarinpalService by passing your implementation of MerchantProvider as constructor parameter. You are done.

UPDATE: You can now pass String as merchantId to ZarinpalService.

Now, ZarinpalService has methods for payment request and verification.

Example

ZarinpalService zarinpalService = new ZarinpalService(new MerchantProvider() {
        public String getMerchantId() {
            return "000";
        }
    }, Address.Environment.SANDBOX.getAddress());

zarinpalService.paymentRequest(...);
zarinpalService.paymentVerification(...);

Make sure you use Address.Environment.PRODUCTION.getAddress() after your tests are finished.

---

• Inspired by: PHP Rest example
• Documentation: Gateway Documentation

---

FAQ

• Q: Why is this documentation not written in persian?

  • Learn english!

• Q: Why shall we use MerchantProvider when we can simply pass it as String to the service?

  • Makes it more dynamic and easier to be changed at runtime, but anyways that was how I needed it to be in our own project. Update: String constructor has been added.

• Q: How to switch to sandbox version for test?

  • Basically the Example is using the sandbox. You can switch to production environment after your testing stage is over.

• Q: How to fill paymentVerification()?

  • If you read zarinpal documentation, you would notice that gateway will call your callback url with enough data to help you through this. This library does not care for that part because you might be using any sort of java frameworks.