Skip to content

CreditBalanceRefund ​

Type: schema

Description ​

A refund of a customer's unused bank-transfer credit to their bank account, as the credit_balance.refund.* events carry it: the fields of an order refund, with its own statuses.

TypeScript Definition ​

typescript
CreditBalanceRefund: {{
            /** @description The refund's reference, sent to the bank with the transfer. */
            request_number?: string;
            /**
             * @description `pending`: created; not sent to the bank yet, or the bank couldn't be reached. `refund_initiated`: being sent to the bank; stays so if the bank's answer was lost. `initiated`: the bank accepted it; its result is awaited. `settled`: paid to the customer's account. `failed`: the bank rejected it. `cancelled`: cancelled while `pending`, by an admin or because the credit is held for an admin's review.
             * @enum {string}
             */
            status?: "pending" | "refund_initiated" | "initiated" | "settled" | "failed" | "cancelled";
            /**
             * Format: double
             * @description What was left of the payment's credit when the refund was made, at most what the customer could spend.
             */
            refund_amount?: number;
            /** Format: date-time */
            refund_date?: string;
            /** @description `bank-transfer`: the refund is paid by bank transfer to `bank_account_number`. */
            payment_mode?: string;
            payment_method?: string | null;
            payment_gateway?: string | null;
            /** @description The reference of the payment whose unused credit is refunded (e.g. the bank transfer's UTR). */
            payment_reference_number?: string | null;
            /** @description Always `null`: the refund pays back credit, not a payment attempt. */
            payment_request_number?: string | null;
            is_manual_refund?: boolean;
            /** @description The customer's bank account the refund is paid to. */
            bank_account_number?: string | null;
            bank_name?: string | null;
            refund_remarks?: string;
            /** Format: date-time */
            created_at?: string;
            /** Format: date-time */
            modified_at?: string;
        };
        /**
         * CreditLine
         * @description A customer's NACH credit line: whether they may order on credit, and their current balance.
         */
}

OpenAPI Schema ​

json
{
  "title": "CreditBalanceRefund",
  "description": "A refund of a customer's unused bank-transfer credit to their bank account, as the `credit_balance.refund.*` events carry it: the fields of an order refund, with its own statuses.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CreditBalanceRefund",
    "description": "API reference for the CreditBalanceRefund schema"
  },
  "properties": {
    "request_number": {
      "description": "The refund's reference, sent to the bank with the transfer.",
      "type": "string"
    },
    "status": {
      "description": "`pending`: created; not sent to the bank yet, or the bank couldn't be reached. `refund_initiated`: being sent to the bank; stays so if the bank's answer was lost. `initiated`: the bank accepted it; its result is awaited. `settled`: paid to the customer's account. `failed`: the bank rejected it. `cancelled`: cancelled while `pending`, by an admin or because the credit is held for an admin's review.",
      "type": "string",
      "enum": [
        "pending",
        "refund_initiated",
        "initiated",
        "settled",
        "failed",
        "cancelled"
      ]
    },
    "refund_amount": {
      "description": "What was left of the payment's credit when the refund was made, at most what the customer could spend.",
      "type": "number",
      "format": "double"
    },
    "refund_date": {
      "type": "string",
      "format": "date-time"
    },
    "payment_mode": {
      "description": "`bank-transfer`: the refund is paid by bank transfer to `bank_account_number`.",
      "type": "string"
    },
    "payment_method": {
      "type": [
        "string",
        "null"
      ]
    },
    "payment_gateway": {
      "type": [
        "string",
        "null"
      ]
    },
    "payment_reference_number": {
      "description": "The reference of the payment whose unused credit is refunded (e.g. the bank transfer's UTR).",
      "type": [
        "string",
        "null"
      ]
    },
    "payment_request_number": {
      "description": "Always `null`: the refund pays back credit, not a payment attempt.",
      "type": [
        "string",
        "null"
      ]
    },
    "is_manual_refund": {
      "type": "boolean"
    },
    "bank_account_number": {
      "description": "The customer's bank account the refund is paid to.",
      "type": [
        "string",
        "null"
      ]
    },
    "bank_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "refund_remarks": {
      "type": "string"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: