Update a payment

post

https://apisandbox.dev.clover.com/v3/merchants/{mId}/payments/{payId}

This endpoint can only be used to update the following information:

lineItemPayments
employee.id (if the payment is a preauth with captured currently set to null).

All other properties in the request are ignored.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

mId

string

required

Merchant Id

payId

string

required

Payment Id

Body Params

string

13-digits unique identifier of the Merchant.

order

object

Order with which the payment is associated.

device

object

Device that processed the transaction for this payment, a 128-bit Universal unique identifier. Note: its not the 13-digits Clover identifier.

tender

object

Tender type associated with this payment. For example: credit card, cash, and so on.

amount

int64

Total amount paid.

tipAmount

integer

Tip amount paid.

taxAmount

integer

Tax amount paid.

cashbackAmount

integer

Cash amount given by the customer to the merchant.

cashTendered

integer

Payment amount given by the customer.

externalPaymentId

string

External payment identifier.

employee

object

Employee who processed the payment.

createdTime

int64

Time when payment was recorded on the server.

clientCreatedTime

int64

Time when payment was recorded on the client server.

gatewayProcessingTime

int64

Time when the transaction was processed by the payment gateway.

modifiedTime

int64

Last modified time of the payment.

offline

boolean

Defaults to false

Indicates if the tender option is offline.

result

string

enum

Indicates the result of the tender.
Values: Success, fail, initiated, voided, voiding, void_failed, auth, auth_completed, discount, offline_retrying, and pending.

cardTransaction

object

Card details for credit or debit card payments.

serviceCharge

object

Amount of the service charge.

attributes

object

additionalCharges

array of objects

additionalCharges

taxRates

array of objects

taxRates

refunds

array of objects

Indicates the amount to be refunded.

refunds

note

string

Note for the refund.

lineItemPayments

array of objects

Payment line items.

lineItemPayments

authorization

object

Authorization to which the payment is associated, for example, (opening or closing payment) if it exists.

voidPaymentRef

object

If voided, the corresponding successful payment, and vice versa.

voidReason

string

enum

If voided, the reason for the payment void, if available.

voidReasonDetails

object

Detailed explanation on why the transaction is void.

dccInfo

object

Dynamic currency conversion information.

transactionSettings

object

Per transaction settings for the payment.

germanInfo

object

German region-specific information.

appTracking

object

Tracking information for the app that created this payment.

cashAdvanceExtra

object

Information specific to cash advance transactions.

transactionInfo

object

Transaction information

signatureDisclaimer

object

Information displayed to customers for storing electronic signatures.

externalReferenceId

string

External reference identifier (ID) if associated with the payment.

merchant

object

increments

array of objects

Indicates if there is any increment in the refund amount.

increments

purchaseCardL2

object

Purchase card level-2 data.

purchaseCardL3

object

Purchase card level-3 data.

oceanGatewayInfo

object

India-region specific Ocean Gateway information.

terminalManagementComponents

array of objects

Terminal management components as defined by nexo standards that contain general information on the terminal, the installed payment app, and so on.

terminalManagementComponents

emiInfo

object

Associated equated monthly installment (EMI) information.

Headers

User-Agent

string

required

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

Response

200

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here!