Real Environment
It will also be forwarded.
Test Environment
https://test-dmz.param.com.tr/out.ws/service_ks.asmx?op=KS_Kart_Ekle
Test Parameter | Value |
---|---|
CLIENT_CODE | 10738 |
CLIENT_USERNAME | Test |
CLIENT_PASSWORD | Test |
GUID | 0c13d406-873b-403b-9c09-a5766840d98c |
Used for credit card storage
Parameter | Required | Type | Length | Description |
---|---|---|---|---|
G | Yes | Object | - | ST_WS_Guvenlik Object |
GUID | Yes | String | - | GUID Value |
KK_Sahibi | Yes | String | 150 | Name and Surname of Credit Card Holder |
KK_No | Yes | String | 16 | Credit Card Number |
KK_SK_Ay | Yes | String | 2 | Credit Card Expiry Month |
KK_SK_Yil | Yes | String | 4 | Credit Card Expiry Year |
KK_Kart_Adi | No | String | 150 | Name of the Credit Card to be Stored, Optional |
KK_Islem_ID | No | String | 200 | Unique ID value to be sent to you for the stored credit card |
Parameter | Type | Length | Description |
---|---|---|---|
Sonuc | Integer | 1 | Result Value |
Sonuc_Str | String | 150 | Result Description, If Result Parameter > 0 then Operation Successful, otherwise unsuccessful |
KS_GUID | String | 36 | GUID value for card storage |
It is used to collect from a stored credit card.
Parameter | Required | Type | Length | Description |
---|---|---|---|---|
G | Yes | Object | - | ST_WS_Security Object |
GUID | Yes | String | 36 | ParamPOS GUID value |
KS_GUID | Yes | String | 36 | GUID value returned from KS_Kart_Add method |
CVV | No | String | 3 | Must be entered for 3D transactions. Can be left blank for Nonsecure transactions. |
KK_Sahibi_GSM | Yes | String | 10 | Credit Card Holder's GSM Number, without leading 0 (5xxxxxxxxx) |
Hata_URL | Yes | String | 250 | Page address to redirect if payment fails |
Basarili_URL | Yes | String | 250 | Page address to redirect if payment is successful |
Siparis_ID | Yes | String | - | Unique ID specific to the order. If you have sent this value before, the system assigns a new Siparis_ID. This Siparis_ID is returned after the transaction. |
Siparis_Aciklama | No | String | 250 | Description of the order |
Taksit | Yes | Integer | 2 | Number of installments selected. Send 1 for single payment. |
Islem_Tutar | Yes | String | - | Transaction amount |
Toplam_Tutar | Yes | String | - | Total order amount including commission, (only in comma-separated cents format 1000.50) |
Islem_Guvenlik_Tip | Yes | String | 2 | Send NS (NonSecure) or 3D |
Islem_ID | No | String | - | Unique ID sent to you in addition to the Order ID, optional |
IPAdr | Yes | String | 256 | IP Address |
Ref_URL | No | String | 256 | URL of the page where the payment is made |
Data1 | No | String | 250 | Extra Field 1 |
Data2 | No | String | 250 | Extra Field 2 |
Data3 | No | String | 250 | Extra Field 3 |
Data4 | No | String | 250 | Extra Field 4 |
KK_Islem_ID | No | String | 200 | Unique ID value transmitted to the stored Credit Card |
Parameter | Type | Length | Description |
---|---|---|---|
Sonuc | Integer | 1 | Result Value |
Sonuc_Str | String | 150 | Result Description, If Result Parameter > 0, the operation is successful; otherwise, it fails. |
UCD_URL | String | 150 | URL information, For Nonsecure transactions, this field returns "NONSECURE". |
Islem_ID | Long | - | 3D URL Transaction ID information. For Nonsecure transactions, it returns the value "Dekont_ID". |
Islem_Guvenlik_Tip = "NS" indicates that the operation was successful according to the following rule.
Sonuc > 0 and UCD_URL=”Nonsecure” and Islem_ID > 0 the operation is successful.
POST Parameters:
Parameter | Description |
---|---|
TURKPOS_RETVAL_Sonuc | Result value |
TURKPOS_RETVAL_Sonuc_Str | Result description |
TURKPOS_RETVAL_GUID | Merchant's key |
TURKPOS_RETVAL_Islem_Tarih | Transaction date |
TURKPOS_RETVAL_Dekont_ID | Receipt number |
TURKPOS_RETVAL_Tahsilat_Tutari | Amount collected from the customer |
TURKPOS_RETVAL_Odeme_Tutari | Net amount. It is the amount collected minus the commission. |
TURKPOS_RETVAL_Siparis_ID | Unique Siparis_ID of the transaction sent to the service |
TURKPOS_RETVAL_Islem_ID | Islem_ID sent to the service |
TURKPOS_RETVAL_Ext_Data | Concatenated form of Data1, Data2, Data3, Data4, Data5 parameters separated by "|". Ext_Data = Data1 & "|" & Data2 & "|" & Data3 & "|" & Data4 & "|" & Data5 |
If TURKPOS_RETVAL_Sonuc < 0, TURKPOS_RETVAL_Dekont_ID returns "0". TURKPOS_RETVAL_Dekont_ID value greater than "0" indicates a successful debit transaction from the credit card.
If Sonuc > 0, UCD_URL is checked for equality to 'NONSECURE'. If they are equal, the transaction ends.
Islem_ID value is the Dekont No. For a successful NonSecure transaction, Sonuc > 0, Islem_ID > 0,
and UCD_URL='NONSECURE' must hold true. Otherwise, the transaction fails. In case of an error in the
NONSECURE transaction, Sonuc_Str returns the error message from the bank.
If UCD_URL <>
'NONSECURE', it is treated like a 3D transaction.
Services must be accessed over HTTPS protocol in a real environment.
To perform transactions, the institution's internet exit IP address or IP blocks, website
address should be provided, and necessary definitions must be made by us.
This method is used to list stored cards.
Parameter | Required | Type | Length | Description |
---|---|---|---|---|
G | * | Object | - | ST_WS_Guvenlik Object |
GUID | * | String | 36 | Merchant Key |
KK_Kart_Adi | * | String | - | Name of the stored card |
KK_Islem_ID | String | - | Unique ID of the stored card (Optional) |
Parameter | Type | Length | Description |
---|---|---|---|
Sonuc | Integer | 1 | Result Value |
Sonuc_Str | String | 150 | Result Description, If Result Parameter > 0, the transaction is successful; otherwise, it fails. |
DT_Bilgi | Object | - | Returns the list of stored cards |
DT_Bilgi Object
Parameter | Type | Length | Description |
---|---|---|---|
ID | String | - | Stored Card ID |
KK_GUID | String | 36 | Stored Card GUID value |
Tarih | String | 10 | Storage Date |
KK_No | String | 16 | Credit Card BIN Code |
KK_Tip | String | - | Card Type |
KK_Banka | String | - | Card Bank |
KK_Marka | String | - | Card Brand |
Kart_Adi | String | - | Card Name |
KK_Hash | String | - | Credit Card Hash Value |
KK_KD | String | - | Card Category |
KK_SK | String | 6 | Credit Card Expiry Date |
TP_Islem_Odeme_OnProv_WKS Hash Formula
Dim Transaction_Security_Str$ = CLIENT_CODE & GUID & Islem_Tutar & Toplam_Tutar & Siparis_ID & Hata_URL & Basarili_URL
Dim Transaction_Hash$ = SHA2B64(Transaction_Security_Str)
It is used to make pre-authorization transaction with stored card.
Parameter | Required | Type | Length | Description |
---|---|---|---|---|
G | Yes | Object | - | ST_WS_Security Object |
GUID | Yes | String | 36 | Merchant's Key |
KK_GUID | Yes | String | 36 | Stored Card GUID information |
KS_Kart_No | Yes | String | 36 | Enter GUID information |
KK_Sahibi_GSM | Yes | String | 10 | Credit Card Holder GSM No, without leading 0 (5xxxxxxxxx) |
Hata_URL | Yes | String | 256 | Page address to redirect if payment fails |
Basarili_URL | Yes | String | 256 | Page address to redirect if payment succeeds |
Siparis_ID | Yes | String | 50 | Unique ID specific to the order. If you have sent this value before, the system assigns a new Order_ID. The system returns this Order_ID after the transaction process. |
Siparis_Aciklama | Yes | String | 250 | Description of the order |
Islem_Tutar | Yes | String | - | Order Amount, (only in decimal format like 1000.50) |
Toplam_Tutar | Yes | String | - | Order Amount including Commission, (only in decimal format like 1000.50) |
Islem_Hash | Yes | String | - | Transaction Hash Value |
Islem_Guvenlik_Tip | Yes | String | - | NS (NonSecure) or 3D is sent |
Islem_ID | No | String | - | Unique ID except for Order ID, optional |
IPAdr | Yes | String | 50 | IP Address |
Ref_URL | No | String | 256 | URL of the page where the payment is made |
Data1 | No | String | 250 | Extra Field 1 |
Data2 | No | String | 250 | Extra Field 2 |
Data3 | No | String | 250 | Extra Field 3 |
Data4 | No | String | 250 | Extra Field 4 |
Data5 | No | String | 250 | Extra Field 5 |
Parameter | Type | Length | Description |
---|---|---|---|
Sonuc | Integer | - | Operation result |
Sonuc_Str | String | - | Operation result description |
Islem_ID | Long | - | SID Value |
Islem_GUID | String | - | Transaction GUID Value |
UCD_URL | String | - | Bank 3D HTML content |
UCD_MD | String | - | Bank 3D Pre-Verification MD value |
Banka_Sonuc_Kod | String | - | Bank Transaction ID value |
Siparis_ID | String | - | Order ID value |
Banka_Sonuc_Kod | Integer | - | Code returned by the bank |
Sonuç Parametreleri Örnek: NS li işlemler için
This method is used to delete stored cards.
Parameter | Required | Type | Length | Description |
---|---|---|---|---|
G | * | Object | - | ST_WS_Guvenlik Object |
KS_GUID | * | String | 36 | GUID value of the stored card |
KK_Islem_ID | * | String | 200 | Unique ID value to be provided by you for the stored credit card |
G Object:
Parameter | Required | Type | Length | Description |
---|---|---|---|---|
CLIENT_CODE | * | Integer | 5 | Terminal ID, provided by us. |
CLIENT_USERNAME | * | String | max 16 | Username, provided by us. |
CLIENT_PASSWORD | * | String | max 11 | Password, provided by us. |
Parameter | Type | Length | Description |
---|---|---|---|
Sonuc | Integer | 1 | Result Value |
Sonuc_Str | String | 150 | Result Description, If Result Parameter > 0, Operation Successful; otherwise, failed. |
Used to provide card authentication.
Parameter | Required | Type | Length | Description |
---|---|---|---|---|
G | Yes | Object | - | ST_WS_Guvenlik Object |
KK_No | Yes | String | 16 | Credit Card Number |
KK_SK_Ay | Yes | String | 2 | 2-digit Expiry Month |
KK_SK_Yil | Yes | String | 4 | 4-digit Expiry Year |
KK_CVC | Yes | String | 3 | CVC Code |
Return_URL | No | String | 256 | URL where result post parameters are returned. |
Data1 | No | String | 250 | Extra Data 1 |
Data2 | No | String | 250 | Extra Data 2 |
Data3 | No | String | 250 | Extra Data 3 |
Data4 | No | String | 250 | Extra Data 4 |
Data5 | No | String | 250 | Extra Data 5 |
Parameter | Type | Length | Description |
---|---|---|---|
Islem_ID | Long | - | SID Value |
UCD_URL | String | - | 3D URL |
Sonuc | Integer | - | Transaction result |
Sonuc_Str | String | - | Transaction result description |
Banka_Sonuc_Kod | Integer | - | Bank's returned code |
If the Result parameter of the TP_KK_Verify method is greater than "0", redirect to the CD_URL parameter to start the 3D Secure Verification process. If the credit card verification process is successful or unsuccessful, POST is provided to Return_URL values.
Post Parameters
Parameter | Type | Length | Description |
---|---|---|---|
KK_VERIFY_Result | String | - | Transaction result |
KK_VERIFY_Result_Str | String | - | Transaction result description |
KK_VERIFY_Data1 | String | 250 | Extra Data 1 |
KK_VERIFY_Data2 | String | 250 | Extra Data 2 |
KK_VERIFY_Data3 | String | 250 | Extra Data 3 |
KK_VERIFY_Data4 | String | 250 | Extra Data 4 |
KK_VERIFY_Data5 | String | 250 | Extra Data 5 |