This service is used to retrieve the current status and commission details of transactions processed via Tami. Queries can be performed for a specific transaction or for all transactions within a designated date range.
This service displays the current status of a transaction and details regarding all operations associated with that order. To view the current status of each individual transaction, the transaction detail display parameter should be set to "false".
You can access the Sandbox Test Portal at https://sandbox-portal.tami.com.tr. When you log in to the test portal using a test user account, you can view the transactions performed by the merchant associated with that user. These transactions can also be cancelled or refunded.To obtain the test user credentials, please contact TeknikDestek@tami.com.tr.
The request sent for many transaction types should include the PG-Auth-Token in the header information. The PG-Auth-Token consists of the values "MerchantNumber:TerminalNumber:Hash".
When calculating the hash here, the merchantNumber, terminalNumber, and secretKey information belonging to the merchant are hashed with sha256 and converted to a string.
You can access the Tami test portal at https://sandbox-portal.tami.com.tr. From this address, you can view the portal screen with the users specified above.
For your production environment information you can become a member at https://portal.tami.com.tr or You can apply to the e-commerce support unit.
The URL "https://sandbox-paymentapi.tami.com.tr/payment/orderQuery" will be used for operations in the test environment.
The URL "https://paymentapi.tami.com.tr/api/v0/payment/orderQuery" will be used for operations in the production environment.
| Alan | Format | (O)psiyonel/(Z)orunlu / (Ş)artlı | Açıklama |
|---|---|---|---|
| orderId | String | Ş | Sorgulanmak istenen satış işlemine ait sipariş numarası bilgisidir. StartDate, endDate girilmezse bu alanın iletilmesi zorunludur. |
| isTransactionDetail | Boolean | O | Eğer true gönderilirse siparişin başından geçen tüm işlemler paylaşılacaktır. Eğer false , boş ya da hiç gönderilmezse siparişin sadece son statüsüne ait bilgiler iletilir. |
| startDate | String | Ş | Eğer sipariş numarasına göre değil tarih aralığına göre sorgulama yapılmak istenirse bu alan zorunludur. Örnek format: "DD-MM-YYYY HH:MM:SS"Başlangıç bitiş tarihi arasına maximum 30 günlük bir aralık verilebilir. |
| endDate | String | Ş | Eğer sipariş numarasına göre değil tarih aralığına göre sorgulama yapılmak istenirse bu alan zorunludur. Örnek format: "DD-MM-YYYY HH:MM:SS" |
| page | Integer | O | Sorgulanmak istenen tarih aralığındaki işlemler sayfa sayfa çekilmek istenirse iletilir. İlk sayfanın datası çekilirken “0” gönderilmelidir. |
| size | Integer | O | Sayfalandırma yapıldığında bir sayfada kaç işlem gösterilmesi isteniyorsa bu değerle iletilir. |
| sortField | String | O | Sorgulama sonucunun belirli bir değere göre sıralı gelmesi için kullanılır. Örn: “orderDate” |
| sortDirection | Enum | O | Dönen cevaptaki sıralamanın artan, azalan olarak sıralanmasını belirleyen alandır. Alabileceği değerler; ASC, DESC |
| securityHash | String | Z | Dokumanda belirtilen şekilde hesaplanıp iletilmesi beklenen değerdir. Eksik veya hatalı iletilirse sorgulama yapılamaz. |
| Field | Format | Description |
|---|---|---|
| success | String | The transaction outcome is directly linked to the query. Should it prove to be accurate, additional details pertaining to the transaction will likewise be provided. |
| errorCode | String | If the "Success" field is set to "False," it represents the error code that was encountered. |
| errorMessage | String | This parameter is passed if the operation fails. Error message information. |
| systemTime | DateTime | It is now time to consider the actions that have been taken. |
| correlationId | String | The provided information pertains to the transaction number associated with the inquiry transaction submitted by the member merchant. |
| amount | Number | The provided information represents the net amount of the transaction. For instance, in a transaction valued at 100 Turkish Lira with a refund transaction of 20 Turkish Lira, the amount will be displayed as 80 Turkish Lira. |
| orderDate | dateTime | The transaction creation date. |
| currency | String | The foreign currency code of the transaction. |
| installmentCount | Number | The number of installments of the transaction |
| orderStatus | String | Shows the last transaction status of the order. It can take the values AUTH/REVERSE/REFUND/PARTIAL_REFUND/PRE_AUTH/POST_AUTH/CHARGEBACK. |
| PaymentStatus | String | Indicates the final status of the operation. It can take the values NOT_COMPLETED, SUCCESS, FAIL, or TIME_OUT. |
| commissionRate | Big Decimal | This is the commission rate information for the transaction. |
| commissionAmount | Big Decimal | It represents the calculated commission amount for the transaction. |
| transactionFee | Big Decimal | This is the transaction fee information. |
| holdPeriod | Integer | It indicates the number of days the transaction is blocked. |
| card | Object | The following document provides information regarding the transaction card. |
| card/binNumber | String | The first eight digits of the card being processed. |
| card/cardBrand | String | Card reward group information includes BONUS, WORLD, AXESS, and other relevant reward categories. |
| card/cardOrganization | String | Card organization information comprises well-known entities such as American Express (AMEX), Troy, Mastercard, Visa, and others. |
| card/cardType | String | It is a card type, either CREDIT or DEBIT. |
| transactions | List | If the parameter `isTransactionDetail='true'` is included in the request, the system will return all transaction data starting from the initiation of the respective order. |
| transactions/amount | Number | The amount of the relevant record |
| transactions/transactionType | String | The transaction type of the relevant record. |
| transactions/transactionStatus | String | the success status of the relevant record |
| transactions/transactionDate | dateTime | Date of the relevant record |
| transactions/reason | String | Date of the relevant record |
| transactions/bankAuthCode | String | Bank Approval Code |
| transactions/bankReferenceNumber | String | Reference number for the transaction |
| transactions/fraudStatus | String | This is the status following fraud checks. |
| securityHash | String | This is the value to be checked to verify that the result of the operation was sent by Tami. Its calculation is specified in the Security Hash Calculation document. |
| pageInfo | Object | Contains information regarding the pagination of the operations in the returned response. |
| pageInfo/page | Integer | It represents the number of pages returned for the queried data. |
| pageInfo/size | Integer | It indicates the number of sales transactions on the page of the response returned for the queried data. |
| pageInfo/totalElements | Integer | If the request specifies a paginated response, this figure represents the total number of transactions within the requested date range. Note: Each distinct order number counts as one transaction. Actions related to the transaction, such as cancellations or returns, are not included in this count. |
| pageInfo/totalPages | Integer | If a page-by-page response was requested, it indicates the total number of pages within the specified date range, based on the requested size. |
| pageInfo/isFirst | Boolean | The page indicated in the query response is marked as `true` if it is the first page. Possible values are `true`/`false`. |
| pageInfo/isLast | Boolean | If the page shown in the query response is the last page, it is indicated as true. Possible values: true/false. |
| pageInfo/hashNext | Boolean | Set to `true` if there are additional pages to display in the query response. Possible values: `true`/`false`. |
| pageInfo/hashPrevious | Boolean | Returns `true` if there is a different page preceding the page shown in the query response. Possible values: `true`/`false`. |
You can use the documentation here to calculate the securityHash field in service requests and incoming service responses.
You can access the list of error codees on this page.
You can access the list of test cards on this page.