Usage
Checkout (iFrame)
Section titled “Checkout (iFrame)”- The customer chooses the PayTR payment method and places the order. The order is created with status Incomplete.
- The customer lands on the Payment page of your store, which embeds PayTR’s payment form. PayTR shows the installment options of the customer’s card.
- After the payment, PayTR calls your notification URL and the order moves to Successful payment (default Paid) or Failed payment (default Failed). The customer is redirected to the order confirmation page.
Details:
- Return before the notification. PayTR notifies asynchronously. If the customer is back first, the add-on waits a few seconds, then asks PayTR’s status inquiry API. A confirmed payment marks the order paid at once; otherwise the order gets the Awaiting confirmation status (default Open) and moves on when the notification arrives.
- Repeated notifications (PayTR retries until it gets
OK) are answeredOKand ignored. - Customer cancels or the payment fails: the customer is sent back to checkout with the message from PayTR and can try again or choose another payment method. Each new attempt gets a new PayTR reference.
- Late success. If a payment succeeds after the order was marked failed, the notification still marks it paid. If the order was cancelled meanwhile, the status is not changed and a note is added to the payment details.
- Repay: customers can pay a failed order again from the order page (when the order status allows repayment).
- The payment details of the order show the PayTR reference (transaction ID), the paid amount, installments, installment fee, test payment flag and refunds.
Checkout (Direct API)
Section titled “Checkout (Direct API)”The customer fills in the card form on your store’s payment page. After the first 8 digits of the card number, the form shows the installment plans of the card program (Axess, Bonus, World, Maximum, CardFinans, Paraf, Advantage, Combo, Sağlam Kart). Business and debit cards get single payment only. Submitting the form sends the card data straight to PayTR, followed by 3D Secure. The rest of the flow is the same as for the iFrame.
Refunds
Section titled “Refunds”On the order page (Orders → View orders → order), the PayTR panel under Payment information shows the attempts and the refunded amount.
- Click Refund.
- Enter the amount (the full refundable amount is pre-filled) and an optional comment.
- Confirm. The refund is sent to PayTR immediately and listed under the panel.
- Partial refunds can be repeated until the paid amount has been refunded.
- The refundable amount is the order amount sent to PayTR. An installment fee charged on top (Direct API, customer pays) can be refunded from the PayTR merchant panel.
- With After a full refund set in the payment method, the order gets that status when everything has been refunded.
- In Multi-Vendor, a vendor order can refund up to its own total from the parent order’s payment.
- Refunds of test payments are test refunds.
- If PayTR rejects a refund, its error message is shown and the attempt is listed as failed.
Payment links (pay-by-link)
Section titled “Payment links (pay-by-link)”For phone orders and orders you create in the admin panel:
- Create the order with any payment method (for example “Phone order”). Orders placed in the admin panel with a PayTR payment method get the Awaiting confirmation status.
- On the order page, click Create payment link in the PayTR panel.
- Choose the PayTR payment method whose account is used, the amount (default: order total), how many days the link is valid, and whether PayTR should send it by e-mail and/or SMS.
- The link appears in the panel; copy it or send it again by e-mail or SMS, or delete it.
When the customer pays, PayTR notifies the store and the order gets the Successful payment status. Link payments can be refunded like checkout payments.
Installment table
Section titled “Installment table”With Show the installment table on product pages on, product pages show a collapsible “Installment options” section: per card program, the installment count, monthly amount and total, based on the product price and PayTR’s current rates. Rates are cached for 24 hours (refresh them in the add-on settings).
The table uses the rates of the first active PayTR payment method of the storefront and respects its Maximum installments and Single payment only settings. If your PayTR account offers installments at the cash price (“peşin fiyatına taksit”), the table still shows PayTR’s rates; the final amount is always shown on PayTR’s payment page.
PayTR transactions log
Section titled “PayTR transactions log”Orders → PayTR transactions lists every payment attempt with its order, PayTR reference, integration, amount, refunds and status. In Multi-Vendor, the Vendor transfers tab lists the transfers.
The page shows the license status at the top: a small License: Valid chip, or a banner with the status and the actions when the add-on is switched off (see License).
Multi-Vendor: vendor payouts
Section titled “Multi-Vendor: vendor payouts”Without a PayTR marketplace agreement (default)
Section titled “Without a PayTR marketplace agreement (default)”Customers pay the whole (parent) order to your PayTR account, exactly as in a single-seller store. Vendor shares are handled by CS-Cart’s accounting (Vendors → Accounting) and paid out by you as usual. Refunds and payment links work per order.
With the Direct Customer-to-Vendor Payments add-on, each vendor can create their own PayTR payment method with their own credentials; notifications are verified with the credentials of the method that was used.
With PayTR Marketplace (Pazaryeri)
Section titled “With PayTR Marketplace (Pazaryeri)”PayTR’s marketplace solution lets you instruct PayTR to pay each vendor’s share to the vendor’s bank account.
- Ask PayTR to activate the marketplace solution and enter the Platform transfer result notification URL in the merchant panel.
- Turn on Pay vendors with PayTR platform transfers in the add-on settings and set up the cron command.
- Each vendor enters the account holder (name or company title) and a Turkish IBAN on Vendors → vendor → Add-ons (or the administrator does). IBANs are validated (TR + 24 digits, checksum) and shown masked.
- When a vendor order paid with PayTR reaches the configured status (default Complete), a transfer is queued with:
total_amount: the vendor order total;submerchant_amount: the vendor order total minus your commission from the vendor accounting (Vendor plans commission). You can change the amount when you queue a transfer manually.
- PayTR accepts instructions from the day after the payment and pays those received before 10:00 the same day. The cron command (automatic mode) or the administrator (Send now on the order page, or Send due transfers on the transfers log) sends them.
- When PayTR reports the transfer as completed, it is marked Completed and, if enabled, recorded as a completed withdrawal in the vendor balance.
Vendors see the transfer status on their order page; they cannot refund or send transfers.
If a transfer fails (for example an invalid IBAN), its status is Failed with PayTR’s message. Fix the account and queue it again from the order page. Payments PayTR could not deliver to the vendor’s account are listed in the PayTR merchant panel and can be re-sent from there.
Admin-panel orders
Section titled “Admin-panel orders”When an administrator places an order in the admin panel with a PayTR payment method, no card payment can happen in the admin panel: the order gets the Awaiting confirmation status and the payment details say “send the customer a PayTR payment link”. Use Create payment link on the order page.