Refund Payment

This endpoint processes refunds for purchases through Zotlo. It allows you to issue refunds for any payment processed by Zotlo, including one-time purchases, subscriptions.

Use the POST method to create a refund. You must provide the transactionId of the original payment.

Method	POST
URL	https://api.zotlo.com/v1/payment/refund

Request Parameters

Field	Type	Description
transactionId	Required	The ID of the transaction to refund.
refundReason	Required	Explanation or reason for the refund.
refundUser	Optional	Who initiated the refund. Can be any descriptive string (e.g., “API”, “Support Agent”, “System Rule”).

Sample Request

POST https://api.zotlo.com/v1/payment/refund HTTP/1.1
AccessKey: ••••••
AccessSecret: ••••••
Content-Type: application/json
ApplicationId: •
Language: ••
{
    "transactionId": "0741a0ac-21d8-4750-941f-064f340700c3",
    "refundReason": "User request!"
}

You can find your AccessKey and AccessSecret in the Zotlo Panel under Developer Tools → API Keys

Sending ApplicationId is optional.

Successful Response

{
  "meta": {
    "requestId": "246a8e676214-REQ-659557ea5289c",
    "httpStatus": 200
  },
  "result": {
    "providerResponse": [],
    "transaction": {
      "id": 57333,
      "payment_type": "subscription",
      "original_transaction_id": "d8ff7792-1c63-4370-be93-447dacaa09ea",
      "transaction_id": "0741a0ac-21d8-4750-941f-064f340700c3",
      "package_id": "premium",
      "team_id": 5,
      "app_id": 5,
      "status": "renewal",
      "create_date": "2024-01-03 12:47:20",
      "purchase_date": "2024-01-03 12:47:20",
      "original_purchase_date": "2023-01-03 12:47:16",
      "price": "12.00",
      "currency": "TRY",
      "country": "TR",
      "expire_date": "2025-01-03 12:47:16",
      "subscriber_id": "905456757656",
      "credit_card": "11111111****4111",
      "refund_price": "5.00",
      "refund_date": "2024-01-03 12:49:46",
      "refund_reason": "{\"reason\":\"Test .\",\"user\":\"API:\"}",
      "is_refund": 1,
      "provider_id": 8,
      "provider_transaction_id": "e963981a-4ee1-494b-b1e8-73db2a694c58",
      "provider_status": "unknown",
      "provider_name": "Zotlo",
      "quantity": 1,
      "package_price": "12.00",
      "subscription_id": 5370
    },
    "refundHistory": [
      {
        "id": 3627,
        "team_id": 5,
        "app_id": 5,
        "provider_id": 8,
        "package_id": "premium",
        "subscriber_id": "905456757656",
        "transaction_id": "0741a0ac-21d8-4750-941f-064f340700c3",
        "country": "TR",
        "price": "5.00",
        "currency": "TRY",
        "reason": "{\"reason\":\"Test .\",\"user\":\"API:\"}",
        "refund_date": "2024-01-03 12:49:46"
      }
    ]
  }
}

Key Response Fields

Field	Description
providerResponse	Raw response returned by the payment provider during the refund.
transaction	Updated transaction record after the refund. Contains refund amount, refund date, status, and provider information.
refundHistory	List of all refunds issued for this transaction (useful for partial or multiple refunds).

Failed Response

All failed responses follow the same standard error format. (See: Error Handling)