v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

PAYMENTS

Get a single refund

Displays a single refund associated with a payment, including taxes and tips.

get/v3/merchants/{mId}/refunds/{refundId}

Path parameters

mIdstring required

Merchant identifier (mId).

refundIdstring required

Refund identifier (refundId).

Query parameters

expandstring

Fields that display when the list is expanded: [payment, germanInfo, appTracking, employee, overrideMerchantTender, serviceCharge, lineItems, transactionInfo, oceanGatewayInfo]

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. Single refund for a merchant is displayed.

idstring

Unique identifier of the refund.

amountinteger

Total amount refunded, including tax and tip

taxAmountinteger

Tax amount refunded.

tipAmountinteger

Tip amount refunded.

createdTimeinteger

Time when the refund was recorded on the server.

clientCreatedTimeinteger

Time when the refund was recorded on the client.

gatewayProcessingTimeinteger

Time when the refund was processed by the payment gateway.

voidedboolean

Indicates voided information.

voidReasonstring

Indicates reason of voided.

externalReferenceIdstring

External reference identifier, if associated with the refund.

authCodestring

Authorization code generated by the acquirer.

status'FAIL' | 'SUCCESS' | 'PENDING'

Status of the refund. It can be Fail/Success/Pending.

reasonstring

Reason why the refund initiated.