Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
PAYMENTS

Get all payments

Retrieves payment information, including the total amount, tip amount, tax amount, and result status.

get/v3/merchants/{mId}/payments

Path parameters

mIdstring required

Merchant identifier.

Query parameters

filterstring

Filter fields to display search results: [modifiedTime, device.id, externalReferenceId, result, offline, createdTime, externalPaymentId, voided, id, tender.id, employee.id, order.modifiedTime, amount, cardType, clientCreatedTime]

expandstring

Expandable fields to display additional nested information: [tender, germanInfo, lineItemPayments, cardTransaction, dccInfo, refunds, transactionInfo, externalReferenceId, oceanGatewayInfo, taxRates, additionalCharges, appTracking, paymentAttributes, order]

Headers

User-Agentstring required

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

Response

Successful response. Displays all payment information.

idstring

Unique identifier of the merchant. Length: 13 digits

amountinteger

Total amount paid.

tipAmountinteger

Amount paid in tips.

taxAmountinteger

Amount paid in tax.

cashbackAmountinteger

Amount returned in a cashback transaction.

cashTenderedinteger

Amount paid by the customer in cash.

externalPaymentIdstring

Point of sale (POS)-assigned unique identifier for the transaction. Critical for reconciliation and recovery.

createdTimeinteger

Time when the payment was recorded on the server.

clientCreatedTimeinteger

Time when the payment was saved on the client.

gatewayProcessingTimeinteger

Time when the payment gateway processed the payment.

modifiedTimeinteger

Time when the payment was modified.

offlineboolean

Indicates whether the payment was accepted offline.

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

Result of the payment transaction, for example: initiated, success, fail, voided, and so on.

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'

Reason for void transaction, if applicable.

externalReferenceIdstring

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