Skip to content

Latest commit

 

History

History
52 lines (43 loc) · 3 KB

terminal-refund.md

File metadata and controls

52 lines (43 loc) · 3 KB
Raw

Terminal Refund

Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds.

Structure

TerminalRefund

Fields

Name Type Tags Description
id string | undefined Optional A unique ID for this TerminalRefund.
Constraints: Minimum Length: 10, Maximum Length: 255
refundId string | undefined Optional The reference to the payment refund created by completing this TerminalRefund.
paymentId string Required The unique ID of the payment being refunded.
Constraints: Minimum Length: 1
orderId string | undefined Optional The reference to the Square order ID for the payment identified by the payment_id.
amountMoney Money Required Represents an amount of money. Money fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
Working with Monetary Amounts
for more information.
reason string Required A description of the reason for the refund.
Constraints: Maximum Length: 192
deviceId string Required The unique ID of the device intended for this TerminalRefund.
The Id can be retrieved from /v2/devices api.
deadlineDuration string | undefined Optional The RFC 3339 duration, after which the refund is automatically canceled.
A TerminalRefund that is PENDING is automatically CANCELED and has a cancellation reason
of TIMED_OUT.

Default: 5 minutes from creation.

Maximum: 5 minutes
status string | undefined Optional The status of the TerminalRefund.
Options: PENDING, IN_PROGRESS, CANCEL_REQUESTED, CANCELED, or COMPLETED.
cancelReason string | undefined Optional -
createdAt string | undefined Optional The time when the TerminalRefund was created, as an RFC 3339 timestamp.
updatedAt string | undefined Optional The time when the TerminalRefund was last updated, as an RFC 3339 timestamp.
appId string | undefined Optional The ID of the application that created the refund.
locationId string | undefined Optional The location of the device where the TerminalRefund was directed.

Example (as JSON)

{
  "id": null,
  "refund_id": null,
  "payment_id": "payment_id0",
  "order_id": null,
  "amount_money": {
    "amount": null,
    "currency": null
  },
  "reason": "reason4",
  "device_id": "device_id6",
  "deadline_duration": null,
  "status": null,
  "cancel_reason": null,
  "created_at": null,
  "updated_at": null,
  "app_id": null,
  "location_id": null
}