CLclover
PAYMENTS

Get a list of credits

Changed on
get/v3/merchants/{mId}/credits

Request

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

Path parameters

mIdstring required

Merchant Id

Query parameters

filterstring

Filter fields: [employee.id, order.modifiedTime, reason, amount, cardType, order.id, failed, device.id, merchantTender.databaseId, externalReferenceId, result, clientCreatedTime, merchantId, id, tender.id, taxAmount, orderType.databaseId, deletedTime]

expandstring

Expandable fields: [dccInfo, germanInfo, appTracking, tender, employee, cardTransaction, order, taxRates, 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

idstring

Unique identifier

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