YQueue DocsDevelopers

Schema

Transaction (Order)

Represents a transaction that has been processed against an order.

  • Orders

Overview

object · 11 properties · 0 required

Properties

uuid

string

The unique identifier.

Format uuid

status

reference

The current status of the transaction.

References Transaction Status.

finalised_at

string | null

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

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_tendered

reference

The amount tendered/provided by the customer.

References Money.

change_given

reference

The change that was supplied to the customer.

References Money.

gross_collected

reference

The net amount collected through this transaction (the successful amount, ignoring any refunds).

References Money.

refundable

boolean

Indicates if the transaction is in a refundable state.

refunds

array

The refunds that have been applied against this transaction.

Array items

Items

reference

References Refund (Order).

net_collected

reference

The net amount collected through this transaction (the successful amount, minus the successul refund amount).

References Money.

Used by

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

      This field will be `null` for a pending transaction.
  gateway:
    $ref: ./PaymentGateway.yaml
    description: The gateway that was used.
  tender:
    $ref: ./Tender.yaml
    description: The tender that was supplied.
  amount_tendered:
    $ref: ./Money.yaml
    description: The amount tendered/provided by the customer.
  change_given:
    $ref: ./Money.yaml
    description: The change that was supplied to the customer.
  gross_collected:
    $ref: ./Money.yaml
    description: 'The net amount collected through this transaction (the successful amount, ignoring any refunds).'
  refundable:
    type: boolean
    description: Indicates if the transaction is in a refundable state.
  refunds:
    type: array
    description: The refunds that have been applied against this transaction.
    items:
      $ref: ./OrderRefund.yaml
  net_collected:
    $ref: ./Money.yaml
    description: 'The net amount collected through this transaction (the successful amount, minus the successul refund amount).'

Search documentation

Search across this documentation site.