Skip to main content
Vindicia Knowledge Center

List all refunds (for a transaction)

List all refunds (for a transaction)

Retrieves all Refunds issued against a specified transaction.

Route (URL) Parameters

Parameter Default Description Required
transaction n/a The id or the vid of the Transaction to retrieve Yes

Query Parameters

None.

Accepts

None.

Returns

JSON A list array with a data property that contains an array of up to limit Refunds, starting after the specified starting_after Refund (or ending before the specified ending_before Refund). Each entry in the array is a full Refund object. If no more Refunds are available, the resulting array will be empty. This request should never throw an error.

A list of Refund objects matching the query. Also:

  • “total_count”: Integer count of the number of Refunds in the returned list.

  • “url”: The query string provided in the request

  • “next”: The route (partial URL) to the next Refund object (string to select the “next”); included id should match that of the last object returned here

  • “previous”: The route (partial URL) to the previous Refund object (string to select the “previous”); included id should match that of the first object returned here

  • cURL
  • Java
Example Request
 curl -X GET \
-u acaff38d462f9430d5cbcbaf:a575771fc679b9de \  
"https://api.prodtest.vindicia.com/transactions/FLX200001501/refunds?limit=3"
 
The above command returns JSON structured like this:
 {
    "object": "List",
    "data": [
        {
            "object": "Refund",
            "id": "FLX200001561",
            "vid": "64a6bad051bdf489c7cf90ed52fca549c0048d3d",
            "created": "2016-05-24T17:50:47-07:00",
            "transaction": {`...`},
            "refund_distribution_strategy": "None",
            "amount": 14.99,
            "amount_includes_tax": false,
            "currency": "USD",
            "metadata": {`...`},
            "note": "Refund 14.99USD",
            "token_action": "None",
            "status": "Complete"
        }
    ],
    "total_count": 1,
    "url": "/transactions/FLX200001501/refunds?limit=3",
    "next": "/transactions/FLX200001501/refunds?limit=3&starting_after=FLX200001561",
    "previous": "/transactions/FLX200001501/refunds?limit=3&ending_before=FLX200001561"
}
 

import com.vindicia.client.CashBox; CashBox.apiKey = "acaff38d462f9430d5cbcbafa575771fc679b9de"; Map<string,> params = new HashMap<string,>(); params.put("limit", 1); Refund.list(params); 
The above command returns JSON structured like this:
{
    "object": "List",
    "data": [
        {
            "object": "Refund",
            "id": "FLX200001561",
            "vid": "64a6bad051bdf489c7cf90ed52fca549c0048d3d",
            "created": "2016-05-24T17:50:47-07:00",
            "transaction": {`...`},
            "refund_distribution_strategy": "None",
            "amount": 14.99,
            "amount_includes_tax": false,
            "currency": "USD",
            "metadata": {`...`},
            "note": "Refund 14.99USD",
            "token_action": "None",
            "status": "Complete"
        }
    ],
    "total_count": 1,
    "url": "/transactions/FLX200001501/refunds?limit=3",
    "next": "/transactions/FLX200001501/refunds?limit=3&starting_after=FLX200001561",
    "previous": "/transactions/FLX200001501/refunds?limit=3&ending_before=FLX200001561"
}
          

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top