Skip to main content
GET
/
v1
/
vouchers
/
{code}
/
transactions
List Voucher Transactions
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/vouchers/{code}/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "vtx_0c9dccc4d5813e71bd",
      "source_id": "20230317_subtract_1",
      "voucher_id": "v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp",
      "campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
      "source": "API",
      "reason": "Subtracting credits from card",
      "type": "CREDITS_REMOVAL",
      "details": {
        "balance": {
          "type": "gift_voucher",
          "total": 128020,
          "amount": -2000,
          "object": "balance",
          "balance": 121020,
          "related_object": {
            "id": "v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp",
            "type": "voucher"
          }
        }
      },
      "related_transaction_id": null,
      "created_at": "2023-03-17T15:50:00.786Z"
    },
    {
      "id": "vtx_0c9dcc920ac0e9ef82",
      "source_id": "20230317_add_1",
      "voucher_id": "v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp",
      "campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
      "source": "API",
      "reason": "Adding more points to card",
      "type": "CREDITS_ADDITION",
      "details": {
        "balance": {
          "type": "gift_voucher",
          "total": 130020,
          "amount": 20,
          "object": "balance",
          "balance": 123020,
          "related_object": {
            "id": "v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp",
            "type": "voucher"
          }
        }
      },
      "related_transaction_id": null,
      "created_at": "2023-03-17T15:49:08.768Z"
    },
    {
      "id": "vtx_0c94f018d30bef6689",
      "source_id": "HRwc0oHz_reward",
      "voucher_id": "v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp",
      "campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
      "source": "voucherify-web-ui",
      "reason": "cash reward",
      "type": "CREDITS_ADDITION",
      "details": {
        "balance": {
          "type": "gift_voucher",
          "total": 130000,
          "amount": 2000,
          "object": "balance",
          "balance": 123000,
          "related_object": {
            "id": "v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp",
            "type": "voucher"
          }
        }
      },
      "related_transaction_id": null,
      "created_at": "2023-03-10T18:38:02.055Z"
    },
    {
      "id": "vtx_0c94edbbaccbef5db6",
      "source_id": null,
      "voucher_id": "v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp",
      "campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
      "source": null,
      "reason": null,
      "type": "CREDITS_REFUND",
      "details": {
        "balance": {
          "type": "gift_voucher",
          "total": 128000,
          "amount": 44,
          "object": "balance",
          "balance": 121000,
          "related_object": {
            "id": "v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp",
            "type": "voucher"
          }
        },
        "order": {
          "id": "ord_jj5EzDxDOd2xFPsAJJ18IaZK",
          "source_id": null
        },
        "redemption": {
          "id": "r_0c94ed583fcafc31c1"
        },
        "rollback": {
          "id": "rr_0c94edbb8d0bef5d9e"
        }
      },
      "related_transaction_id": null,
      "created_at": "2023-03-10T18:27:42.389Z"
    },
    {
      "id": "vtx_0c94ed584f4afc31da",
      "source_id": null,
      "voucher_id": "v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp",
      "campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
      "source": null,
      "reason": null,
      "type": "CREDITS_REDEMPTION",
      "details": {
        "balance": {
          "type": "gift_voucher",
          "total": 128000,
          "amount": -44,
          "object": "balance",
          "balance": 120956,
          "related_object": {
            "id": "v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp",
            "type": "voucher"
          }
        },
        "order": {
          "id": "ord_jj5EzDxDOd2xFPsAJJ18IaZK",
          "source_id": null
        },
        "redemption": {
          "id": "r_0c94ed583fcafc31c1"
        }
      },
      "related_transaction_id": null,
      "created_at": "2023-03-10T18:26:00.640Z"
    },
    {
      "id": "vtx_0c94e9432c4afc2134",
      "source_id": "HRwc0oHz_removal",
      "voucher_id": "v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp",
      "campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
      "source": "voucherify-web-ui",
      "reason": "removal",
      "type": "CREDITS_REMOVAL",
      "details": {
        "balance": {
          "type": "gift_voucher",
          "total": 128000,
          "amount": -2000,
          "object": "balance",
          "balance": 121000,
          "related_object": {
            "id": "v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp",
            "type": "voucher"
          }
        }
      },
      "related_transaction_id": null,
      "created_at": "2023-03-10T18:08:10.413Z"
    },
    {
      "id": "vtx_0c94e8100f8afc1c6c",
      "source_id": null,
      "voucher_id": "v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp",
      "campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
      "source": null,
      "reason": null,
      "type": "CREDITS_REDEMPTION",
      "details": {
        "balance": {
          "type": "gift_voucher",
          "total": 130000,
          "amount": -7000,
          "object": "balance",
          "balance": 123000,
          "related_object": {
            "id": "v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp",
            "type": "voucher"
          }
        },
        "order": {
          "id": "ord_qZX3pEt5rFf5W23qRMDQcVt9",
          "source_id": null
        },
        "redemption": {
          "id": "r_0c94e80fda4afc1c59"
        }
      },
      "related_transaction_id": null,
      "created_at": "2023-03-10T18:02:55.935Z"
    },
    {
      "id": "vtx_0c94e6b82a4bef406c",
      "source_id": "walmart",
      "voucher_id": "v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp",
      "campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
      "source": "voucherify-web-ui",
      "reason": "return",
      "type": "CREDITS_ADDITION",
      "details": {
        "balance": {
          "type": "gift_voucher",
          "total": 130000,
          "amount": 5000,
          "object": "balance",
          "balance": 130000,
          "related_object": {
            "id": "v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp",
            "type": "voucher"
          }
        }
      },
      "related_transaction_id": null,
      "created_at": "2023-03-10T17:57:03.758Z"
    }
  ],
  "has_more": true,
  "more_starting_after": "vtx_0c94e6b82a4bef406c"
}

Authorizations

​
X-App-Id
string
header
required
​
X-App-Token
string
header
required
​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
code
string
required

A code that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.

Example:

"2CpRCE2c"

Query Parameters

​
limit
integer

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

Required range: 1 <= x <= 100
​
order
enum<string>

Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

Available options:
id,
-id
​
starting_after_id
string

A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID.

Response

Returns a dictionary of transaction objects

Response body schema for GET v1/vouchers/{code}/transactions.

​
object
enum<string>
default:list
required

The type of the object represented by JSON.

Available options:
list
​
data_ref
enum<string>
default:data
required

Identifies the name of the attribute that contains the array of transaction objects.

Available options:
data
​
data
Voucher Transaction · object[]
required

A dictionary that contains an array of transactions. Each entry in the array is a separate transaction object.

​
has_more
boolean
required

As query results are always limited (by the limit parameter), the has_more flag indicates if there are more records for given filter parameters. This lets you know if you can run another request (with a different paging or a different start date filter) to get more records returned in the results.

​
more_starting_after
string

Returns an ID that can be used to return another page of results. Use the transaction ID in the starting_after_id query parameter to display another page of the results starting after the transaction with that ID.

⌘I