v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB

Terminal

SearchTerminalRefunds

Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request.

post/v2/terminals/refunds/search

Request body

cursorstring

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.

limitinteger

Limits the number of results returned for a single request.

Example request

{
  "request_body": {
    "limit": 1,
    "query": {
      "filter": {
        "status": "COMPLETED"
      }
    }
  }
}

Response

Success

cursorstring

The pagination cursor to be used in a subsequent request. If empty, this is the final response.

See Pagination for more information.

Example response

{
  "refunds": [
    {
      "amount_money": {
        "amount": 111,
        "currency": "CAD"
      },
      "app_id": "sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ",
      "card": {
        "bin": "411111",
        "card_brand": "INTERAC",
        "card_type": "CREDIT",
        "exp_month": 1,
        "exp_year": 2022,
        "fingerprint": "sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw",
        "last_4": "1111"
      },
      "created_at": "2020-09-29T15:21:46.771Z",
      "deadline_duration": "PT5M",
      "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291",
      "id": "009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY",
      "location_id": "76C9W6K8CNNQ5",
      "order_id": "kcuKDKreRaI4gF4TjmEgZjHk8Z7YY",
      "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY",
      "reason": "Returning item",
      "refund_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY_43Q4iGp7sNeATiWrUruA1EYeMRUXaddXXlDDJ1EQLvb",
      "status": "COMPLETED",
      "updated_at": "2020-09-29T15:21:48.675Z"
    }
  ]
}