SchemaPaymentsRefunds

List refunds

Return a list of refunds.
To filter your results, use query parameters.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

processingTerminalIdstringOptional>=4 characters<=50 characters

Filter by terminal ID.

orderIdstringOptional>=1 character<=24 characters

Filter refunds by the unique identifier that the merchant assigned to the order.

operatorstringOptional>=1 character<=50 characters

Filter refunds by the operator who initiated the request.

cardholderNamestringOptional>=1 character<=50 characters

Filter refunds by cardholder name.

first6stringOptionalformat: "[0-9]{6}"

Filter refunds by the first six digits of the card number.

last4stringOptionalformat: "[0-9]{4}"

Filter refunds by the last four digits of the card number.

tenderenumOptional

Filter by tender type.

Allowed values:
statuslist of enumsOptional

Filter refunds by the current status of the refund.

dateFromstringOptionalformat: "date-time"

Filter by refunds processed after a specific date. The date format follows the ISO 8601 standard.

dateTostringOptionalformat: "date-time"

Filter by refunds processed before a specific date. The date format follows the ISO 8601 standard.

settlementStateenumOptional

Status of the settlement.

Allowed values:
settlementDatestringOptionalformat: "date"

Date the transaction was settled.

beforestringOptional

Points to the resource identifier that you want to receive your results before. Typically, this is the first resource on the previous page.

afterstringOptional

Points to the resource identifier that you want to receive your results after. Typically, this is the last resource on the previous page.

limitintegerOptional<=100Defaults to 10

States the total amount of results the response is limited to.

Response

Successful request. Returns a paginated list of refunds.

datalist of objects

Array of refund objects.

countintegerOptional

Number of results that we returned.

hasMorebooleanOptional

Indicates that further results are available.

limitintegerOptional

Maximum number of results that we return for each page.