# Sipay API Documentation

## Docs
- Overview [Getting Started](https://apidocs.sipay.com.tr/getting-started-1699520m0.md): 
- Overview [Status Codes](https://apidocs.sipay.com.tr/status-codes-2006876m0.md): 
- Overview [PreAuthorization / Authorization ](https://apidocs.sipay.com.tr/preauthorization-authorization-2010136m0.md): 
- Overview [Webhook](https://apidocs.sipay.com.tr/webhook-2009891m0.md): 
- [Installments](https://apidocs.sipay.com.tr/installments-6248393f0.md): 
- Non Secure Payment [Non-Secure Payment Flow](https://apidocs.sipay.com.tr/non-secure-payment-flow-2009892m0.md): 
- [3D Secure Payment](https://apidocs.sipay.com.tr/3d-secure-payment-7245902f0.md): 
- 3D Secure Payment [3D Secure Payment Flow](https://apidocs.sipay.com.tr/3d-secure-payment-flow-2042941m0.md): 
- HASH [Hash Information](https://apidocs.sipay.com.tr/hash-information-1923306m0.md): 

## API Docs
- Authentication [Generating Token](https://apidocs.sipay.com.tr/generating-token-23283730e0.md): The API generates a token to be used in other APIs to verify the merchant. It also returns the payment integration option set for the merchant. The response key is “is_3d”. Possible values ​​for is_3d are: 0, 1, 2, and 4.
- Installments [Getting Installment Information](https://apidocs.sipay.com.tr/getting-installment-information-23284389e0.md): The API should be called when the first 6 digits of the user card number are entered (For agricultural cards, the entire card number must be entered) . getPos API extracts the installment list according to the card number given on the payment page and determines the maturity range and payment frequency for agricultural cards.
- Installments [Installments](https://apidocs.sipay.com.tr/installments-26909434e0.md): It allows member merchants to list their active installments.
- Commissions [Commission ](https://apidocs.sipay.com.tr/commission-26908946e0.md): The merchant commission API returns the merchant commission and end-user commission according to the card program. Authorization is required and the method must be Bearer.
- Non Secure Payment [Non-Secure Credit Card Payment](https://apidocs.sipay.com.tr/non-secure-credit-card-payment-23308516e0.md): The Payment API is used to send order and credit card details to the Sipay payment integration system. The merchant’s website should verify the payment status after the transaction using the /api/checkstatus endpoint. Based on the API’s success status, the shopping cart and order status should be updated accordingly. In this Payment API, unlike other payment APIs, there is no need to call the getpos API.
- Non Secure Payment [Non-Secure Recurring Payment](https://apidocs.sipay.com.tr/non-secure-recurring-payment-31329114e0.md): #### order_type
- Non Secure Payment [Non-Secure Insurance Payment](https://apidocs.sipay.com.tr/non-secure-insurance-payment-31340612e0.md): ##### `vpos_type`
- Non Secure Payment [Non-Secure PreAuthorization Payment](https://apidocs.sipay.com.tr/non-secure-preauthorization-payment-31343298e0.md): For detailed information, please visit the following page  [:](https://app.apidog.com/link/project/1106714/apis/doc-2010136)
- 3D Secure Payment [3D Secure Credit Card Payment](https://apidocs.sipay.com.tr/3d-secure-credit-card-payment-25721952e0.md): paySmart3D is a secure payment gateway that processes online transactions using encrypted connections. After selecting paySmart3D at checkout, users are redirected to a secure payment page to complete the transaction. Upon successful authorization, the system returns a real-time payment confirmation.
- 3D Secure Payment [3D Secure Recurring Payment](https://apidocs.sipay.com.tr/3d-secure-recurring-payment-31339735e0.md): #### order_type
- 3D Secure Payment [3D Secure PreAuthorization Payment ](https://apidocs.sipay.com.tr/3d-secure-preauthorization-payment-31344786e0.md): For detailed information, please visit the following page  [:](https://app.apidog.com/link/project/1106714/apis/doc-2010136)
- 3D Secure Payment [3D Secure PreAuthorization Payment Merchant](https://apidocs.sipay.com.tr/3d-secure-preauthorization-payment-merchant-32019644e0.md): When the payment_completed_by = "merchant" send, Pre-authorized transactions must be completed by calling the Confirm Payment API within 20 business days. Otherwise, the authorization will expire.
- Payment [CheckStatus](https://apidocs.sipay.com.tr/checkstatus-25727396e0.md): Checking transaction status. 
- Payment [ConfirmPayment](https://apidocs.sipay.com.tr/confirmpayment-26547483e0.md): 
- Payment [CompletePayment](https://apidocs.sipay.com.tr/completepayment-26547484e0.md): Complete Payment Endpoint
- Payment [Non-Secure and 3D Payment with Sipay](https://apidocs.sipay.com.tr/non-secure-and-3d-payment-with-sipay-26902318e0.md): The Sipay administrator will decide whether the payment made from the merchant website should be Non-Secure or 3D Secure. The following request should be sent from the merchant website to the Sipay payment integration system. The CURL POST request should be received in Sipay with the following parameters:
- Payment [Refund](https://apidocs.sipay.com.tr/refund-26908125e0.md): It is used to request a refund for a transaction that has already been paid for.
- Cards [Card Registration](https://apidocs.sipay.com.tr/card-registration-26908219e0.md): The Card Registration service is used to store card information in the Sipay System and to send back a token as the response to be used in the payByCardToken API.
- Cards [Pay by Card Token](https://apidocs.sipay.com.tr/pay-by-card-token-26908142e0.md): The stored card payment service is used to place orders. After filling out and submitting the payment form on the merchant's website, the user will be redirected directly to the bank's page. The payment will be verified at the bank gateway with an SMS code. Once the payment is successful, the user will be redirected to the merchant's successful URL; otherwise, they will be redirected to the URL specified by the merchant to cancel the transaction. Unlike other payment APIs, this getPos API does not require calling the getPos API.
- Cards [Retrieving Saved Card](https://apidocs.sipay.com.tr/retrieving-saved-card-26908225e0.md): This is a service that allows us to retrieve saved cards.
- Cards [Edit Saved Card](https://apidocs.sipay.com.tr/edit-saved-card-26908250e0.md): This service is used to make changes to a customer's card.
- Cards [Delete Saved Card](https://apidocs.sipay.com.tr/delete-saved-card-26908277e0.md): This service allows you to delete a previously saved card belonging to a customer.
- Cards [NonSecure Payment with Hidden Card](https://apidocs.sipay.com.tr/nonsecure-payment-with-hidden-card-26908291e0.md): The payByCardToken (non-secure) API is used to send orders to the Sipay payment integration system. Merchant websites should receive the payment status immediately before loading the payment page. The cart and order status should be adjusted accordingly based on the API success rate. This payment API does not require a getpos API call, unlike other payment API calls.
- Recurring [Recurring Query Search](https://apidocs.sipay.com.tr/recurring-query-search-26965533e0.md): 
- Recurring [Recurring Plan Process](https://apidocs.sipay.com.tr/recurring-plan-process-23283314e0.md): 
- Recurring [Recurring Plan Update](https://apidocs.sipay.com.tr/recurring-plan-update-26965560e0.md): Recurring payment can be updated using this API.
- Cashout [Cashout to bank](https://apidocs.sipay.com.tr/cashout-to-bank-27078845e0.md): 
- Report [Settlement API](https://apidocs.sipay.com.tr/settlement-api-32018949e0.md):