-
Multi Bank Virtual POS
Multi Bank Virtual POS
Refund Transaction General Description
The refund transaction allows you to refund all or part of a payment you made via Tami. For the refund transaction, you need to send the order number (orderId) of the payment and the amount to be refunded (amount), encrypted in the required manner. If the amount (amount) is not sent, the full amount of the original order is refunded.
Tami Test/Prod Portal Information
Before going live with your integration, you can use the Tami Test Portal to test without creating any real money movement.
Test Portal address: https://sandbox-portal.tami.com.tr
If you would like to log in to the test portal to view your transactions and perform cancellations/refunds when needed, a dedicated test portal user must be defined for you. You can reach our support team for this at TeknikDestek@tami.com.tr.
Prod Portal address: https://portal.tami.com.tr
For your production environment credentials, you can register via this address or contact our e-commerce support team.
Tami Test / Prod API Users
Two different environments are used when integrating with Tami’s APIs: Sandbox (Test) and Prod (Production).
- Test (Sandbox) Environment
This lets you test your integration without creating any real money movement. Your requests are sent to the test endpoints and can be tracked via the Tami Test Portal above.
Below are the credentials you can use to send a test request via the API in the sandbox environment:
| Field | Value |
|---|---|
| Merchant Number | 77006950 |
| Terminal Number | 84006953 |
| Secret Key | 0edad05a-7ea7-40f1-a80c-d600121ca51b |
- Prod (Production) Environment
This is the environment where live transactions take place and real payments are collected.
For your production environment credentials, you can register via https://portal.tami.com.tr or contact our e-commerce support team.
Generating the PG Auth Token
For requests sent to Virtual POS services, the PG-Auth-Token field must be included in the header.
The PG-Auth-Token is generated in the following format:
MerchantNumber:TerminalNumber:Hash
The Hash value is generated by concatenating your Merchant Number, Terminal Number, and Secret Key (in that order), hashing the result with the SHA-256 algorithm, and converting the result to Base64 format.
Below is a sample Java code block demonstrating this calculation:
public class SHA256Example {
public static String sha256(Long merchantNumber, Long terminalNumber, String secretKey) {
String text = merchantNumber.toString() + terminalNumber.toString() + secretKey;
try {
MessageDigest digest = MessageDigest.getInstance("SHA-256");
byte[] hash = digest.digest(text.getBytes(StandardCharsets.UTF_8));
String sha256Hex = DatatypeConverter.printBase64Binary(hash);
return sha256Hex;
} catch (NoSuchAlgorithmException e) {
e.printStackTrace();
return null;
}
}
}
You can generate the PG-Auth-Token header value by combining the Hash value you generated with your Merchant Number and Terminal Number in the format above.
Refund Transaction API Information
The endpoint information to be used for the refund transaction is below:
| Environment | Endpoint |
|---|---|
| Test (Sandbox) | https://sandbox-paymentapi.tami.com.tr/api/v0/payment/refund |
| Production (Prod) | https://paymentapi.tami.com.tr/api/v0/payment/refund |
You must send your requests using the POST method to the endpoint appropriate for the environment you are working in (test/production).
How the Refund Request Is Sent
For refund transactions, the values in the body of the request sent are not expected to be transmitted in plain form; instead, a single signed and encrypted value is expected. This value is sent in the signedRequest field.
The response returned by Tami is likewise signed and encrypted, and is delivered in the signedResponse field. Detailed information on how to decode the signedResponse value is provided in the headings below.
In addition, the following information must also be sent in the header:
- PG-Auth-Token: How this is calculated is explained above under “Generating the PG Auth Token.”
- CorrelationId: A variable value that must be unique for each request.
- PG-Api-Version: Must be sent as v4.
Parameters to Be Signed and Encrypted, with Descriptions
For the refund transaction, the values in the request body are not sent in plain form; the encrypted value is sent in the signedRequest field.
The signedRequest value is obtained by encrypting a request constructed from the fields listed in the table below. If the field marked as mandatory (M) is missing or sent incorrectly, the transaction will result in an error.
The fields to be included in signedRequest, along with their rules, are specified in the table below. Abbreviations: (O) Optional, (M) Mandatory.
| Field | Format | Length | O/M | Description |
|---|---|---|---|---|
| orderId | String | (2-36) | M | The order number information of the sales transaction to be refunded. |
| amount | Decimal | O | Used for partial refund requests. Must be sent when not the full transaction amount but only a certain portion is to be refunded. If left blank, the amount of the original transaction is used. The decimal separator must be a period (.). | |
| reason | String | 150 | O | The refund reason information. |
Generating the Request Token (signedRequest)
For security purposes, information in requests sent by merchants is not sent in plain form. Instead, the request body is expected to contain the signedRequest value, which is generated by signing and encrypting a request built according to the fields requested by Tami.
For a detailed explanation of the signedRequest generation steps and code samples, please see the Generating the Request Token (signedRequest) page.
API Request Example
{
"signedRequest": "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU4R0NNIiwiYWxnIjoiZGlyIn0..5LnRGpOvLXkyNbtawbuf.2cgejy-QdeSOZK_J6oCuqjWwaUEqAw7UPJmEiVtGb-q7LNpL-EeZz2LejyIVhdjyaTDvzFkEWotkaRn_FvCc6vmxcceSfjAGNEs4OL8ZnBEejUYArTpfOl5icCUtrbp3rh..."
}
The signedRequest value above has been shortened for example/test purposes. A real request contains a much longer JWE (encrypted token) value.
API Response Example
Response for a successful transaction:
{
"signedResponse": "eyJraWQiOiIzNzAzZTQ3MOU0ODlgWspWwWlDoWjIjp7InM1Y3Y4VfYjZ3YWcIiOiI5InZwIiwiYWxnIjoiZGly..."
}
Response Parameters and Descriptions
When the transaction is successful, the response delivered by Tami contains only the signedResponse field. All other fields listed in the table below (success, systemTime, correlationId, amount, currency, etc.) are not present in plain form in this case; all of them are carried in encrypted form inside the signedResponse field. You can only access these fields once the signedResponse value has been decoded. The decoding steps are described in the next heading.
When the transaction is unsuccessful, signedResponse is not returned at all; in this case success, systemTime, correlationId, errorCode, errorMessage, and errorGroup fields are returned directly in plain form.
| Parameter Name | Format | Where It Appears | Description |
|---|---|---|---|
| success | String | Inside signedResponse (plain if transaction unsuccessful) | Reports the outcome of the transaction. If true, the transaction was successful; if false, the transaction was unsuccessful. |
| systemTime | dateTime | Inside signedResponse (plain if transaction unsuccessful) | Indicates the date and time the response was generated by Tami. |
| correlationId | String | Inside signedResponse (plain if transaction unsuccessful) | The transaction number value sent by the merchant in the refund request. |
| transactionDate | dateTime | Inside signedResponse | Indicates the date and time the successfully refunded transaction took place. |
| amount | Number | Inside signedResponse | The amount information of the successfully refunded transaction. |
| currency | String | Inside signedResponse | The currency code information of the successfully refunded transaction. |
| errorCode | String | Plain (only when success:false) | Returned if the transaction is unsuccessful. Contains the error code information. |
| errorMessage | String | Plain (only when success:false) | Returned if the transaction is unsuccessful. Contains the error message information. |
| bankAuthCode | String | Inside signedResponse | Bank authorization code. |
| bankReferenceNumber | String | Inside signedResponse | Retrieval reference number (RetRef) for the transaction. |
| errorGroup | String | Plain (only when success:false) | Indicates the group of the relevant error. Merchants can manage their own rules by making use of the error code and error groups. |
Decoding the Response Token (signedResponse)
The steps required to decode the value delivered in the signedResponse field in order to access the parameters above will be provided in this section.
For a detailed explanation of the decoding steps and code samples, please see the Decoding the Response Token (signedResponse) page.
Code Examples
Below are links to code samples written in various programming languages. Through the link for your preferred programming language, you can examine in detail code written with pre-defined example values.
These samples contain code covering the relevant transaction type, and since they are written in different languages, it is also possible to observe various approaches and practices. This gives you the opportunity to work with clearer and more authentic examples suited to your preferred programming language.
- For C# Code Samples, click here.
- For VB.Net Code Samples, click here.
- For Java Code Samples, click here.
- For PHP Code Samples, click here.
- For NodeJS Code Samples, click here.
Please note that these samples are written with pre-defined values, and the necessary adaptation and security measures may need to be taken for their use in real projects.
Error Codes
You can access the list of error codes on this page.
Test Cards
You can access the list of test cards on this page.
