Payment Transaction Inquiry

Get detailed information about a payment transaction.

This service provides detailed information about a payment transaction made through Zotlo. It can be used to verify payment transactions after purchases. With this service, you can check payment details or transaction logs.

Method	GET
URL	https://api.zotlo.com/v1/transaction/detail?transactionId=TRANSACTION_ID
Request Parameters	transactionId: The transactionId is for the transaction you want to refund.

Sample Request

You can find the required Access Key and Access Secret for sending a request to the transaction inquiry service on the Developer Tools > API Keys page in the Zotlo Panel.

Sending the Application ID is not required.

GET https://api.zotlo.com/v1/transaction/detail?transactionId=TRANSACTION_ID HTTP/1.1
AccessKey: ••••••
AccessSecret: ••••••
Content-Type: application/json
ApplicationId: •
Language: ••

Sample Successful Response

{
    "meta": {
        "requestId": "246a8e676214-REQ-65955eec8936c",
        "httpStatus": 200
    },
    "result": {
        "transaction": {
            "id": 57333,
            "payment_type": "subscription",
            "original_transaction_id": "d8ff7792-1c63-4370-be93-447dacaa09ea",
            "subscriber_id": "905456757656",
            "transaction_id": "0741a0ac-21d8-4750-941f-064f340700c3",
            "provider_transaction_id": "e963981a-4ee1-494b-b1e8-73db2a694c58",
            "package_id": "premium",
            "status": "renewal",
            "purchase_date": "2024-01-03 12:47:20",
            "expire_date": "2025-01-03 12:47:16",
            "original_purchase_date": "2023-01-03 12:47:16",
            "price": "12.00",
            "currency": "TRY",
            "country": "TR",
            "provider_name": "Zotlopos",
            "subscriptionId": 5370,
            "custom_parameters": {
                "source": "NotSet",
                "validationHash": "780a40828c778b93cf5cdd4b6f7cd4ef6af5148b",
                "paymentMethod": "creditcard",
                "cardBrand": "mastercard",
                "threeds": "0",
                "installment": "1"
            },
            "credit_card": "41111111****1111",
            "checkout_type": "creditCard",
            "refund": {
                "refund_price": "5.00",
                "refund_date": "2024-01-03 12:49:46",
                "refund_reason": "{\"reason\":\"Test .\",\"user\":\"API: \"}"
            },
            "detail": [],
            "exchange": {
                "status": false,
                "detail": []
            }
        },
        "transactionLog": [
            {
                "providerId": 8,
                "createDate": "2024-01-03 12:47:20",
                "requestType": "renewal",
                "requestData":"{\"requestType\":\"SALE\",\"transactionId\":\"0741a0ac-21d8-4750-941f-064f340700c3\",\"CARDTOKEN\":\"dffdc4d7-7d7c-452c-bde8-d2dad0c51fad\",\"cardCvv\":\"***\",\"price\":12,\"currency\":\"TRY\",\"customerName\":\"bet\ül sahan\",\"installment\":1}",
                "responseData": "{\"isMockPayment\":true,\"success\":true}",
                "subscriberId": "905456757656",
                "transactionId": "0741a0ac-21d8-4750-941f-064f340700c3",
                "paymentType": "",
                "code": "S0000001",
                "message": "Transaction completed successfully."
            },
            {
                "providerId": 8,
                "createDate": "2024-01-03 12:49:46",
                "requestType": "refund",
                "requestData": "{\"requestType\":\"VOID\",\"transactionId\":\"e963981a-4ee1-494b-b1e8-73db2a694c58\"}",
                "responseData": "{\"isMockPayment\":true,\"success\":true}",
                "subscriberId": "905456757656",
                "transactionId": "0741a0ac-21d8-4750-941f-064f340700c3",
                "paymentType": "non3d",
                "code": "S0000001",
                "message": "Ödeme işlemi başarıyla tamamlandı."
            }
        ]
    }
}

Successful Response Parameters

Parameter	Description
payment_type	Type of payment transaction. Can be subscription or consumable ( one-time)
subscriber_id	ID of the user making the purchase, which could be a phone number or email.
transaction_id	Unique ID of the purchase transaction used in refund transactions.
status	Contains the transaction types, possible values : trial : A trial started trial_to_paid : Trial converted to paid subscription start_paid : A paid subscription started (no trial package) renewal : Subscription renewed reactive : User reactivated a passive subscription with a payment consumable :Purchased a one-time package
purchase_date	Transaction execution date.
expire_date	Expiry date of the subscription purchase if applicable.
custom_parameters.paymentMethod	Specifies the payment method.
custom_parameters.cardBrand	Indicates the card brand.
transactionLog.code	It is the status code of the payment. You can view the payment codes on this page.

Failed Example Response

{
  "meta": {
    "requestId": "MacBook-Pro.local-REQ-5eb025e96f806",
    "httpStatus": 200
  },
  "result": {
    "transaction": null,
    "transactionLog": [
      {
        "id": 98,
        "team_id": 3,
        "provider_id": 3,
        "app_id": 2,
        "create_date": "2020-04-06 06:10:11",
        "request_type": "transaction",
        "status": "fail",
        "request_data": "\nCCProxySale20386ECCB3531A727428EBF394531********2283Test Test22115921a8b3951b512d54e1a880b57b30a1b321TRY159.146.13.1721ZotloTestZotloTest1zotlo-test-10\n",
        "response_data": "{\"StatusCode\":\"1\",\"ResultCode\":\"59\",\"ResultMessage\":\"Message.\",\"OrderObjectId\":\"3fb29aed-f64a-4101-bd47-a35d670ee251\",\"LastTransactionDate\":\"4\\/6\\/2020 9:10:11 AM\",\"MaskedCreditCardNumber\":\"4531 44** **** 2283\",\"MPAY\":\"a8b3951b512d54e1a880b57b30a1b321\",\"CCTokenId\":\"00000000-0000-0000-0000-000000000000\",\"SubscriberId\":\"00000000-0000-0000-0000-000000000000\",\"SubscriberStarterDate\":\"1\\/1\\/0001 12:00:00 AM\",\"SubscriptionRequestId\":\"00000000-0000-0000-0000-000000000000\"}",
        "subscriber_id": "zotlo-test-1",
        "transaction_id": "3fb29aed-f64a-4101-bd47-a35d670ee251",
        "payment_type": "non3d"
      }
    ]
  }
}

Failed Example Response Parameters

Parameter	Description
requestId	It is the unique request parameter generated and stored by Zotlo for your transaction.
httpStatus	It is the HTTP status code related to the response. The standard codes 400 or 500 are returned.
errorMessage	It is the detail of the received error. The error message is provided in the language specific to the parameter you sent.
errorCode	It is the error code from Zotlo.
result	The values this field can take are variable.If there’s an error, it will include data; otherwise, it will return as an empty object.