<- Terminal API

Terminal API

All versions ->

Search terminal refunds

POST

 /v2/terminals/refunds/search

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

Terminal refund requests are available for 30 days.

Permissions:PAYMENTS_READ

Guide

Search for Terminal refunds

Try in API Explorer
Link to section

Request body

Example code

Link to section

query

Queries the Terminal refunds based on given conditions and the sort order. Calling SearchTerminalRefunds without an explicit query parameter returns all available refunds with the default sort order.

Link to section

cursor

string

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.

Link to section

limit

integer(32-bit)

Limits the number of results returned for a single request.

Min
1
Max
100
Link to section

Response fields

Link to section

errors

Information about errors encountered during the request.

Link to section

refunds

The requested search result of TerminalRefund objects.

Link to section

cursor

string

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

See Pagination for more information.