Skip to main content

Payment with Juzdan

To get payment with Juzdan the first step is to start payment using Craftgate service. The service returns a QR url, the Merchant can open it on the browser. Then customer scans the QR code using Juzdan mobile application, selects one of the registered cards and completes the payment. Upon completion of the payment customer is redirected to the callback URL with referenceId parameter, then Merchant calls payment inquiry service and checks the status of the payment.

Start Payment With Juzdan

URL

Parameters are given below to create a QR url using Juzdan.

POST/payment/v1/juzdan-payments/init

Payment Starting Request Parameters

callbackUrl
string
required

URL which is going to be used to transfer referenceId to the merchant

clientType
string

If payment takes place on website "W", if payment takes place on mobile "M" should be sent.

loanCampaignId
string

Campaign ID

conversationId
string

"boomerang" value that can be sent with the request and received with the response. It can be used to associate different requests with each other. Usually, the order number is used that is stored in merchant own system.
Special characters that may cause security problems should not be used in the data. Data cannot start with the + or - character, but it can be used in it.

externalId
string

It is generally used as a payment order number or basket number on the merchant side. You can search with this value later by using reporting services.
Special characters that may cause security problems should not be used in the data. Data cannot start with the + or - character, but it can be used in it.

price
decimal
required

Total basket price. The sum of the item prices in the basket must be equal to total basket price.

paidPrice
decimal
required

The final amount to be paid from the card by calculating differences such as commissions and discounts. The amount to be collected from the wallet is also included in this amount. If there is an interest in the transaction, the amount with the interest added should be entered in this parameter.

buyerMemberId
number

ID of the buyer that is returned from member creation.

currency
Currency
required
Values:
TRY
USD
EUR
GBP
CNY
ARS
BRL
AED
IQD
AZN
KZT
paymentGroup
PaymentGroup
Values:
PRODUCT
LISTING_OR_SUBSCRIPTION
paymentPhase
PaymentPhase
Values:
AUTH
PRE_AUTH
POST_AUTH
paymentChannel
string

It is generally used to keep information specific to the payment channel on the merchant side. You can search with this value later by using reporting services.

bankOrderId
string

Order id parameter to be transmitted to the bank when receiving the payment. Since it is optional, it is recommended not to send it and the orderId value is generated by Craftgate.

items
PaymentItem[]
required

Payment items related to payment. You must send at least one payment item and the sum of prices must be equal to the price field.

Response Parameters

Response parameters of Juzdan start payment obeys the rules of Response Formats. If there is no System error sub parameters of data object will be returned like the below.

referenceId
string

Unique ID of the payment

juzdanQrUrl
string

QR URL which is created by Juzdan

Parameters that are sent to Callback URL

After payment is completed parameters below will be transferred as form variables using HTTP POST method to callbackUrl URl of the Merchant.

referenceId
string

Unique ID of the payment

Payment Inquiry

After the payment referenceId is sent to Merchant's callbarkurl, Merchant can call the inquiry service of the Craftgate to view the status and other information about payment.

URL

You can use referenceId to inquire Juzdan payment.

GET/payment/v1/juzdan-payments/{referenceId}

Response Parameters Of Juzdan Inquiry

id
number

ID of the payment.

createdDate
date

The date that payment is created

price
decimal

Basket price of the payment

paidPrice
decimal

Paid price of the payment

walletPrice
decimal

Wallet price of the payment

currency
Currency
Values:
TRY
USD
EUR
GBP
CNY
ARS
BRL
AED
IQD
AZN
KZT
buyerMemberId
number

Buyer member ID of the payment

installment
number

Installment number

conversationId
string

Value of theconversationId parameter sent in the payment request

externalId
string

externalId value that sent in payment request by merchant

paymentType
PaymentType
Values:
CARD_PAYMENT
DEPOSIT_PAYMENT
WALLET_PAYMENT
CARD_AND_WALLET_PAYMENT
BANK_TRANSFER
APM
paymentGroup
PaymentGroup
Values:
PRODUCT
LISTING_OR_SUBSCRIPTION
paymentSource
PaymentSource
Values:
API
CHECKOUT_FORM
PAY_BY_LINK
paymentStatus
PaymentStatus
Values:
FAILURE
SUCCESS
INIT_THREEDS
CALLBACK_THREEDS
WAITING
paymentPhase
PaymentPhase
Values:
AUTH
PRE_AUTH
POST_AUTH
paymentChannel
string

paymentChannel value sent by the merchant in the payment request

isThreeDS
boolean

Indicates whether the payment is 3D Secure payment

merchantCommissionRate
decimal

Interest rate to calculate paid price that buyer will pay

merchantCommissionRateAmount
decimal

Interest amount. Equal to the difference between paidPrice and price values

bankCommissionRate
decimal

Bank commission rate

bankCommissionRateAmount
decimal

Bank commission rate amount

cardUserKey
string

Card user key that represents the card holder.

cardToken
string

Card token that represents the card.

paidWithStoredCard
boolean

Indicates whether the payment was made with a stored card

binNumber
string

Exist for the payments fully or partially collected from the card. First 8 digits of the card

lastFourDigits
string

Exist for the payments fully or partially collected from the card. Last 4 digits of the card

cardHolderName
string

Card holder name surname

bankCardHolderName
string

Card holder name surname retrieved from bank. The return value might be null for PF poses

authCode
string

authCode value retrieved from bank related to the payment. The return value might be null for PF poses

hostReference
string

hostReference value retrieved from bank related to the payment

transId
string

transId value retrieved from bank related to the payment. The return value might be null for PF poses

orderId
string

orderId value retrieved from bank related to the payment

cardType
CardType

(See: Card Types)

Values:
CREDIT_CARD
DEBIT_CARD
PREPAID_CARD
cardAssociation
CardAssociation

Card Association

Values:
VISA
MASTER_CARD
AMEX
TROY
JCB
UNION_PAY
MAESTRO
DISCOVER
DINERS_CLUB
cardBrand
string

Brand of card. Exist for the payments fully or partially collected from the card

requestedPosAlias
string

Value of theposAlias parameter sent in the payment request

pos
MerchantPos

POS info that payment is received

loyalty
Loyalty

Loyalty info that used in payment (See: Reward Usage)

fraudId
number

Fraud Check Id if fraud rule matches (See: Fraud Checks)

fraudAction
FraudAction

Fraud Check Action if fraud rule matches (See: Fraud Actions)

Values:
BLOCK
REVIEW
paymentTransactions
PaymentTransaction[]

It includes the transaction information sent when making the payment request, and the pricing and money transfer information of the payment based on these transactions

additionalData
map<string, map>

Additional data related to the payment

Sample Codes

You can review the sample codes in the open source Craftgate API clients.