CLclover
CREDITS

Get a credit

Get information about a credit by specifying its Clover credit UUID.

get/v1/credits/{creditId}

Request

  • Base URL
    https://deviceIpOrHost:12346/connect
  • URL
    https://deviceIpOrHost:12346/connect/v1/credits/{creditId}
  • Auth
    HTTP bearer

Path parameters

creditIdstring required

A Clover credit UUID.

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

X-Clover-Device-Idstring required

The Clover device to route the request to.

X-POS-Idstring required

An identifier for the POS making the request.

X-Clover-Timeoutinteger

The amount of time, in seconds, that this operation will process before timing out. A value of 0 indicates no timeout will be enforced by Remote Pay, although protocol specified timeouts may still apply.

Response

A valid CreditResponse

Example response

{
  "credit": {
    "cardTransaction": {
      "last4": "1234"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.