Zarinpal payement and gateway API
Read more about Zarinpal API at https://www.zarinpal.com/docs/md/howToUse/
How to download
npm i zarinpal-nodejsHow to use
const Zarinpal = require("zarinpal-nodejs")
async function createTransaction(){
const merchantID = "XXXX-XX-XXXX-XXXXX-XXXX"
const zarinpal = new Zarinpal(merchantID)
try{
// currency by default is Toman
const paymentResponse = await zarinpal.paymentRequest({
amount: 1000,
callback_url: "http://localhost:3000/api/payment",
description: "a simple test",
})
// if creating payement transaction was not successfull the redirect url
// will be an empty string
const redirectURL = zarinpal.getRedirectURL(paymentResponse)
return redirectURL
}catch(e){
console.log("Error happend while trying to create a new transaction", e)
return ""
}
}Translate response error to Farsi
Note: if the error code couldnt not be found in the list of predefined errors it will return an empty string
For a list of predefined errors please check https://www.zarinpal.com/docs/md/paymentGateway/errorList.html
const farsiError = zarinpal.translateError(paymentResponse)Check to see if the payment was successfull
if(zarinpal.wasSuccessfull(paymentResponse)){
// here payment was successfull
}An example:
if (zarinpal.wasSuccessfull(paymentResponse)) {
const redirectURL = zarinpal.getRedirectURL(paymentResponse)
} else {
const farsiError = zarinpal.translateError(paymentResponse)
}You can get the authority if the payment was successfull
and save it in db for later use and checks
Note: if creating payement transaction was not successfull it will return undefined
const authority = zarinpal.getAuthority(paymentResponse)Now Zarinpal gateway redirects the user to this callbakc_url
- After user payed then zarinpal will redirect the user to the callback_url
- In there you can find out the if the payment was successfull
// here is in your callback_url api
const query = req.query // for example in the express like apis where you have res,req objects
if(zarinpal.didUserPaySuccessfully(query)){
// successfull payment
}Get the authority
Note: this will return
undefinedif user didnt pay successfull
const authority = zarinpal.getAuthorityAfterSuccessfullPayment(query)Make sure to verify
if the payment was successfull in your callbakc_url api otherwise after sometime the zarinpal will reject the amount back to the owner
const verificationResponse = await zarinpal.verifyPayment({
amount: 1000,
authority
})Utils for checking verification response
- To check if verify was successfull
const ok = zarinpal.wasVerifySuccessfull(verificationResponse)
if(ok){
// everyting is fine and verified
}- For getting masked card number
const maskedCardNumber = zarinpal.getMaskedCardPan(verificationResponse)- For getting the ref id
the code that user can use to track the transaction
const refID = zarinpal.getRefID(verificationResponse)- For getting the fee that this amount should pay to zarinpal
Note: As of now zarinpal takes 1% to the amount of 3000 toman from each successfull transaction
const fee = zarinpal.getFee(verificationResponse)Get all the unverified paymenets
const unverifiedRequests = await getAllUnverifiedRequests()Refund the amount to the owner
NOTE: for using refund you should first request an access token from zarinpal website
const refundResponse = await refund({
authority
})
if(zarinpal.wasSuccessfull(refundResponse)){
// refund was successfull
}