AlmondTill/G3N API

On this page

refundReturn

mutation · in the family Refunds and payment corrections

What it does

Pay the customer back for an approved, received return.

REFUND a received Return. method=original_tender drives the PROCESSOR walk: the order's INTEGRATED payments (captured|succeeded) refund LIFO through the StripePort — each attempt record-first (a Refund child mints created, the port fires after, the ACK commits the NEGATIVE card Tender + the Order rollup + the settled flip in ONE transaction); over-capacity refuses CONFLICT/OVER_TENDERED (route the remainder via cash/store_credit); a processor refusal refuses PAYMENT/REFUND_FAILED (retryable — committed sibling refunds STAND and the retry converges on the remainder); an order with NO integrated payments keeps the ratified record-only arm. method=cash pays out of the OPEN drawer; store_credit records (issuance). Requires the doc CURRENT revision (OCC) + the unrestricted capability.

What happens

Money goes back on the original payment method where possible; integrated card refunds ride the processor.

Careful

Money out, permanently. A card refund cannot be recalled once the processor takes it.

Who may call it

Capability area: Refunds and payment corrections — Refunds, corrective notes and voiding invoices.

Arguments

NameTypeRequiredNotes
inputRefundReturnInput RefundReturnInput!yesNo further notes.

Returns

Return Return! — A sales Return / RMA — the customer→merchant goods-back document (distinct from vendor RTV; the disjoint law: a billing correction is a CreditNote/DebitNote, never a Return). References the original Order (+ optionally one of its Invoices); returns WHOLE units of order lines; receive posts per-line disposition legs at the RECEIVING LF and stamps the telescoping refund money; refund RECORDS the routing (tender mechanics; store-credit issuance).

Example request

mutation ExampleRefundReturn($input: RefundReturnInput!) {
  refundReturn(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    orderId
    invoiceId
    organizationId
    currency
    refundTotalMinor
  }
}

Variables:

{
  "input": {
    "returnId": "01900000-0000-7000-8000-4d4c03d20000",
    "expectedRevision": "01900000-0000-7000-8000-e02b2e6c0000",
    "method": "original_tender",
    "reference": "<reference>"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "refundReturn": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "RT-EXMP-0000-000F",
      "type": "Return",
      "caption": "Blue jeans",
      "status": "requested",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "orderId": "01900000-0000-7000-8000-f6d8263a0000",
      "invoiceId": "01900000-0000-7000-8000-504ef4ed0000",
      "organizationId": "01900000-0000-7000-8000-44b781470000",
      "currency": "USD",
      "refundTotalMinor": 1
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

Used in