CLclover
PAYMENTS

Get a credit refund

Displays a credit refund associated with a payment, including taxes and tips.

get/v3/merchants/{mId}/credit_refunds/{crId}

Request

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

Path parameters

mIdstring required

Merchant identifier (mId).

crIdstring required

Credit identifier (crId).

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 refund is displayed.

idstring

Unique identifier

createdTimeinteger

Time when the refund was recorded on the server.

clientCreatedTimeinteger

Time when the refund was recorded on the client

Changes

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