Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
PAYMENTS

Update a payment

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

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

All other properties in the request are ignored.

post/v3/merchants/{mId}/payments/{payId}

Path parameters

mIdstring required

Merchant Id

payIdstring required

Payment Id

Headers

User-Agentstring required

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

Request body

idstring

13-digits unique identifier of the Merchant.

amountinteger

Total amount paid.

tipAmountinteger

Tip amount paid.

taxAmountinteger

Tax amount paid.

cashbackAmountinteger

Cash amount given by the customer to the merchant.

cashTenderedinteger

Payment amount given by the customer.

externalPaymentIdstring

External payment identifier.

createdTimeinteger

Time when payment was recorded on the server.

clientCreatedTimeinteger

Time when payment was recorded on the client server.

gatewayProcessingTimeinteger

Time when the transaction was processed by the payment gateway.

modifiedTimeinteger

Last modified time of the payment.

offlineboolean

Indicates if the tender option is offline.

result'SUCCESS' | 'FAIL' | 'INITIATED' | 'VOIDED' | 'VOIDING' | 'VOID_FAILED' | 'AUTH' | 'AUTH_COMPLETED' | 'DISCOUNT' | 'OFFLINE_RETRYING' | 'PENDING'

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

notestring

Note for the refund.

voidReason'USER_CANCEL' | 'TRANSPORT_ERROR' | 'REJECT_SIGNATURE' | 'REJECT_PARTIAL_AUTH' | 'NOT_APPROVED' | 'FAILED' | 'AUTH_CLOSED_NEW_CARD' | 'DEVELOPER_PAY_PARTIAL_AUTH' | 'REJECT_DUPLICATE' | 'REJECT_OFFLINE' | 'GIFTCARD_LOAD_FAILED' | 'USER_GIFTCARD_LOAD_CANCEL' | 'DEVELOPER_PAY_TIP_ADJUST_FAILED' | 'USER_CUSTOMER_CANCEL' | 'FRAUD' | 'REJECT_GREATER_APPROVED_AMOUNT' | 'TIMEOUT'

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

externalReferenceIdstring

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