Payment History Inquiry

Check your payment transactions with Zotlo

This API service provides information about payment transactions or one-time payments of your subscribers in Zotlo. Payment History Inquiry service works using GET method. SubscriberId parameter is mandatory to get payment transactions.

Method	GET
URL	https://api.zotlo.com/v1/transaction?subscriberId=&paymentType=&startDate=&endDate=&packageId=
Request Parameters	subscriberId: The email or phone number used by the user when starting the subscription. paymentType: It is the payment type value. It can have either subscription or consumable values.Consumable refers to one-time payments.This parameter is not mandatory to send. startDate : If a payment is required after a specific date, the date should be sent in this parameter in the format 2024-01-15.This parameter is not mandatory to send. endDate:If a payment is required before a specific date, the date should be sent in this parameter in the format 2024-01-30.This parameter is not mandatory to send.

Example Request

When sending a request to the payment history inquiry service, you can obtain the necessary Access Key and Access Secret information from the Developer Tools/API Keys page in the Zotlo Panel.

GET https://api.zotlo.com/v1/transaction?subscriberId=&paymentType=&startDate=&endDate=&packageId= HTTP/1.1
AccessKey: ••••••
AccessSecret: ••••••
Content-Type: application/json
ApplicationId: •
Language: ••

Successful Response Examples

{
    "meta": {
        "requestId": "246a8e676214-REQ-659565f64ef8e",
        "httpStatus": 200
    },
    "result": {
        "transactions": [
            {
                "id": 57097,
                "payment_type": "subscription",
                "original_transaction_id": "48e39b30-2820-4d77-9699-221c896fca55",
                "transaction_id": "02c88e3a-f358-4adc-9c21-b979fb698e85",
                "provider_transaction_id": "b9b84a68-980e-404b-a705-45e5d327fdba",
                "package_id": "premium",
                "status": "renewal",
                "purchase_date": "2024-01-02 08:24:14",
                "expire_date": "2024-01-30 07:50:34",
                "original_purchase_date": "2023-11-30 07:50:34",
                "price": "49.00",
                "currency": "TRY",
                "country": "TR",
                "provider_name": "Zotlopos",
                "subscriptionId": 8260,
                "refund": null,
                "exchange": {
                    "status": false,
                    "detail": []
                }
            },
            {
                "id": 55001,
                "payment_type": "subscription",
                "original_transaction_id": "48e39b30-2820-4d77-9699-221c896fca55",
                "transaction_id": "48e39b30-2820-4d77-9699-221c896fca55",
                "provider_transaction_id": "b793670e-57d1-49df-8dcf-8d14426bd039",
                "package_id": "premium",
                "status": "start_paid",
                "purchase_date": "2023-11-30 07:50:34",
                "expire_date": "2023-12-30 07:50:34",
                "original_purchase_date": "2023-11-30 07:50:34",
                "price": "49.00",
                "currency": "TRY",
                "country": "TR",
                "provider_name": "Zotlopos",
                "subscriptionId": 8260,
                "refund": null,
                "exchange": {
                    "status": false,
                    "detail": []
                }
            }
        ]
    }
}

Failed Response Example

Our services return HTTP status code 200 for successful responses. For unsuccessful cases, HTTP status codes 400 or 500 are returned. An example error response is as follows:

{
  "meta": {
    "requestId": "246a8e676214-REQ-6595662ae067d",
    "httpStatus": 200
  },
  "result": {
    "transactions": []
  }
}

Failed Response Parameters

Below are the parameters included in failed responses.

Field	Description
requestId	A unique request parameter generated and stored by Zotlo.
httpStatus	The HTTP status code associated with the response. Standard codes include 400 or 500.
errorMessage	Details of the error received. Error messages are sent according to the language parameter you send. 404001: Invalid endpoint 401002: AccessKey, AccessSecret parameters are incorrect. 400008: SubscriberId parameter is incorrect. 400009: Subscriber profile not found. 500000: Server error.
errorCode	The error code specific to Zotlo. Zotlo has unique error codes for each type of error. 404001: Invalid endpoint 401002: AccessKey, AccessSecret parameters are incorrect. 400008: SubscriberId parameter is incorrect. 400009: Subscriber profile not found. 500000: Server error.
result	This field can dynamically change. In case of an error, the response from the service may be returned filled with details or as an empty object.