Send a payment request to a Clover device

post

https://deviceIpOrHost:12346/connect/v1/payments

Starts the payment flow for the transaction type specified in the request. Once the customer finishes their payment, a payment response is returned, and the device returns to the idle state.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

int64

1 to 999999999

The amount of the payment, in cents.

capture

boolean

Defaults to true

If set to true (auth), the payment is automatically and immediately captured, but it may be adjustable until closeout runs at which time it will be settled/closed. If set to false (pre-auth), the payment will not be automatically captured, and a subsequent call to capture is required. Once captured, the payment will be settled/closed the next time closeout runs. NOTE: This value is ignored if the final field is set to true.

deviceOptions

object

Common (applies to payments and credits) device options.

externalPaymentId

string

length ≤ 32

A unique id assigned by the POS to identify this transaction. Critical for reconciliation and recovery.

externalReferenceId

string

length ≤ 12

An ID that can be passed to the merchant's gateway and ultimately appears in settlement records.

final

boolean

Defaults to false

If set to true, the payment will run as a closed, non-adjustable transaction (sale), the capture field will be ignored, and the tip will be set to the amount in the tipAmount field, or 0 if the tipAmount is not specified. If set to false then the capture flag is evaluated to determine if the payment will be automatically captured or if a subsequent call to capture is required. In addition, if set to false setting the tipAmount field will result in a validation error.

taxAmount

int64

0 to 999999999

The tax amount, in cents.

tipAmount

int64

0 to 999999999

The tip amount, in cents. NOTE: If the final field is set to false, setting this field will result in a validation error.

vaultedCard

object

Headers

User-Agent

string

required

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

X-Clover-Device-Id

string

required

The Clover device to route the request to.

X-POS-Id

string

required

An identifier for the POS making the request.

X-Clover-Timeout

integer

0 to 300

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.

Idempotency-Key

string

required

The idempotency key transmitted during the request, if any.

Responses

200A valid PayResponse

209Operation was canceled.

400The request is invalid, and subsequent calls will continue to fail; do not repeat the call.

401An invalid bearer token has been provided. The call may be repeated if the provided bearer token is updated.

415The request is invalid, and contains request data in an unsupported format. This call may be repeated if the content is changed to a supported format.

500The request processing failed with an unknown error, and the processing state of the operation is indeterminate. Do not repeat the call without additional analysis.

501The device does not have the ability to respond to the requested operation; do not repeat the call.

503The device is not available because it is currently servicing another call. This can be repeated at a later time, or cancel may be called to end the current operation.

504The Device did not respond in a timely manner. This can be repeated at a later time.