YQueue DocsDevelopers

Schema

Refund (Order)

Represents a refund that has been processed against a transaction associated with an order.

  • Orders

Overview

object · 6 properties · 0 required

Properties

uuid

string

The unique identifier.

Format uuid

status

reference

The current status of the refund.

References Refund Status.

finalised_at

string | null

The date-time that the refund was finalised. This field will be `null` for a pending refund.

Format date-time
Nullable Yes

gateway

reference

The gateway that was used.

References Payment Gateway.

tender

reference

The tender that was supplied.

References Tender.

amount

reference

The value of the refund (irrespective of its status).

References Money.

Used by

Raw YAML
Download source
title: Refund (Order)
type: object
description: Represents a refund that has been processed against a transaction associated with an order.
x-tags:
  - Orders
properties:
  uuid:
    type: string
    format: uuid
    description: The unique identifier.
  status:
    $ref: ./RefundStatus.yaml
    description: The current status of the refund.
  finalised_at:
    type:
      - string
      - 'null'
    format: date-time
    description: |-
      The date-time that the refund was finalised.

      This field will be `null` for a pending refund.
  gateway:
    $ref: ./PaymentGateway.yaml
    description: The gateway that was used.
  tender:
    $ref: ./Tender.yaml
    description: The tender that was supplied.
  amount:
    $ref: ./Money.yaml
    description: The value of the refund (irrespective of its status).

Search documentation

Search across this documentation site.