CLclover
PAYMENTS

Get a list of credit refunds

Displays a list of credit refunds associated with a payment, including taxes and tips.

get/v3/merchants/{mId}/credit_refunds

Request

  • Base URL
    https://apisandbox.dev.clover.com
  • URL
    https://apisandbox.dev.clover.com/v3/merchants/{mId}/credit_refunds
  • Auth
    HTTP bearer

Path parameters

mIdstring required

Merchant identifier (mId).

Query parameters

expandstring

Fields that display when the list is expanded: [credit, germanInfo, appTracking, transactionInfo]

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <product> / <product-version> <comment>

Response

Successful response. Credit refunds list is displayed.

idstring

Unique identifier of the refund.

amountinteger

Amount paid

taxAmountinteger

Amount paid in tax

createdTimeinteger

Time payment was recorded on server

clientCreatedTimeinteger
voidedboolean
voidReasonstring
result'SUCCESS' | 'FAIL' | 'INITIATED' | 'VOIDED' | 'VOIDING' | 'VOID_FAILED' | 'AUTH' | 'AUTH_COMPLETED' | 'DISCOUNT' | 'OFFLINE_RETRYING' | 'PENDING'
reasonstring

Reason why the credit was initiated

externalReferenceIdstring

External reference identifier, if associated with the credit.

Changes

No recorded changes to this operation across all 2 revisions of this API.