> ## Documentation Index
> Fetch the complete documentation index at: https://www.commercengine.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Mark an order payment paid

> Marks an order's pending manual payment paid once the store has the money, for example a cheque it received. The money is recorded as a payment of the order (`payment`, `settled`), the order payment becomes `success` and the order's payment status is updated; an order now paid in full is confirmed, and a gateway payment still pending on it is marked failed. Returns the order payment and the recorded payment. Fails with a 400 when the order is cancelled, the payment isn't a pending manual one, it is for more than the order still owes, or `payment_method` isn't one of the store's; with a 404 for an unknown order or payment; and with a 409, changing nothing, while payment records are briefly being updated.



## OpenAPI

````yaml https://openapi.commercengine.io/ce-admin.json post /orders/{order_number}/payments/{request_number}/mark-paid
openapi: 3.2.0
info:
  title: CE Admin APIs
  version: '1.0'
  summary: Comprehensive admin interface for managing your e-commerce platform
  description: >-
    Complete administrative API suite for Commerce Engine, providing powerful
    tools to manage products, orders, customers, inventory, analytics, and
    system configuration. Designed for administrators and backend integrations
    requiring full platform control.
  license:
    name: All Rights Reserved
    url: https://www.commercengine.io/contact-us
  contact:
    email: support@commercengine.io
    url: https://www.commercengine.io/contact-us
    name: Support
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/admin
    description: Staging Server
    variables:
      store_id:
        default: store_id
        description: Store ID
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/admin
    description: Prod Server
    variables:
      store_id:
        default: store_id
        description: Store ID
security:
  - Authorization: []
tags:
  - name: section-catalog
    summary: Catalog
    kind: nav
  - name: Products
    description: >-
      Create and update products; manage their channels and category
      assignments, and list SKUs.
    summary: Products
    kind: nav
    parent: section-catalog
  - name: Variants
    description: Create, read and update product variants individually or in bulk.
    summary: Variants
    kind: nav
    parent: section-catalog
  - name: Categories
    description: Manage catalog categories and the attributes assigned to them.
    summary: Categories
    kind: nav
    parent: section-catalog
  - name: Product attributes
    description: Define product attributes and the attribute sets that organize them.
    summary: Product attributes
    kind: nav
    parent: section-catalog
  - name: Inventory
    description: >-
      Read stock and inventory activity, update inventory, and record stock-in
      and stock-out movements.
    summary: Inventory
    kind: nav
    parent: section-catalog
  - name: Reviews
    description: Read, moderate and remove product reviews.
    summary: Reviews
    kind: nav
    parent: section-catalog
  - name: Media
    description: >-
      Request file uploads, manage uploaded files, and organize them into
      folders.
    summary: Media
    kind: nav
    parent: section-catalog
  - name: Catalog jobs
    description: Create catalog processing jobs and follow their status.
    summary: Catalog jobs
    kind: nav
    parent: section-catalog
  - name: section-customers
    summary: Customers
    kind: nav
  - name: Customers
    description: >-
      Create and update customers, view their details and activity, and manage
      profile images.
    summary: Customers
    kind: nav
    parent: section-customers
  - name: Users
    description: List the users attached to a customer and activate or deactivate them.
    summary: Users
    kind: nav
    parent: section-customers
  - name: Customer attributes
    description: Define customer attributes and manage the values assigned to customers.
    summary: Customer attributes
    kind: nav
    parent: section-customers
  - name: Customer groups
    description: Configure the customer groups available in the store.
    summary: Customer groups
    kind: nav
    parent: section-customers
  - name: Addresses
    description: Read and manage a customer’s saved addresses.
    summary: Addresses
    kind: nav
    parent: section-customers
  - name: Bank accounts
    description: Read and manage a customer’s bank accounts.
    summary: Bank accounts
    kind: nav
    parent: section-customers
  - name: KYC documents
    description: Configure the store’s KYC requirements and manage customer documents.
    summary: KYC documents
    kind: nav
    parent: section-customers
  - name: Visitors
    description: >-
      Read anonymous visitor profiles, their activity and their attribute
      values.
    summary: Visitors
    kind: nav
    parent: section-customers
  - name: Loyalty
    description: >-
      Configure loyalty programs, manage membership tiers, and inspect or record
      point activity.
    summary: Loyalty
    kind: nav
    parent: section-customers
  - name: Credit
    description: Set credit-line eligibility and read customer credit balances.
    summary: Credit
    kind: nav
    parent: section-customers
  - name: Mandates
    description: >-
      Inspect customer payment mandates and debit schedules, and pause, resume
      or revoke a mandate.
    summary: Mandates
    kind: nav
    parent: section-customers
  - name: Segments
    description: >-
      Manage customer segments, their members and associated advertising
      audiences.
    summary: Segments
    kind: nav
    parent: section-customers
  - name: section-shopping
    summary: Shopping
    kind: nav
  - name: Carts
    description: List abandoned carts for follow-up.
    summary: Carts
    kind: nav
    parent: section-shopping
  - name: Coupons & promotions
    description: Manage coupons, coupon codes and promotions, and inspect their usage.
    summary: Coupons & promotions
    kind: nav
    parent: section-shopping
  - name: section-orders
    summary: Orders
    kind: nav
  - name: Orders
    description: >-
      Read and update orders, accept or cancel them, check stock, and follow
      order activity.
    summary: Orders
    kind: nav
    parent: section-orders
  - name: Invoices
    description: List order invoices and retrieve an order’s invoice or receipt.
    summary: Invoices
    kind: nav
    parent: section-orders
  - name: Returns
    description: Read customer return requests and approve or reject them.
    summary: Returns
    kind: nav
    parent: section-orders
  - name: Shipments
    description: >-
      Create and manage shipments, follow delivery activity, and handle
      replacements and shortfalls.
    summary: Shipments
    kind: nav
    parent: section-orders
  - name: section-payments
    summary: Payments
    kind: nav
  - name: Order payments
    description: >-
      Create and inspect payment requests, verify order payments, and cancel or
      mark a payment paid.
    summary: Order payments
    kind: nav
    parent: section-payments
  - name: Refunds
    description: Estimate and issue refunds, or mark an order refund paid or forfeited.
    summary: Refunds
    kind: nav
    parent: section-payments
  - name: Payment exceptions
    description: Inspect payment exceptions and resolve them.
    summary: Payment exceptions
    kind: nav
    parent: section-payments
  - name: Payment methods
    description: Configure manual payment methods and list available payment options.
    summary: Payment methods
    kind: nav
    parent: section-payments
  - name: Seller payouts
    description: >-
      Configure seller payouts and manage invoices, adjustments, charges and
      payout batches.
    summary: Seller payouts
    kind: nav
    parent: section-payments
  - name: section-marketplace
    summary: Marketplace
    kind: nav
  - name: Marketplace catalog
    description: Inspect and publish marketplace products, variants, reviews and inventory.
    summary: Marketplace catalog
    kind: nav
    parent: section-marketplace
  - name: Marketplace listings
    description: List, synchronize and remove the store’s product listings on marketplaces.
    summary: Marketplace listings
    kind: nav
    parent: section-marketplace
  - name: Marketplace settings
    description: >-
      Read marketplace configuration and configure category schemas and
      attributes.
    summary: Marketplace settings
    kind: nav
    parent: section-marketplace
  - name: Sellers
    description: Manage the sellers a customer is authorized to buy from.
    summary: Sellers
    kind: nav
    parent: section-marketplace
  - name: section-fulfillment
    summary: Fulfillment
    kind: nav
  - name: Shipping methods
    description: Configure shipping methods and costs, and check courier serviceability.
    summary: Shipping methods
    kind: nav
    parent: section-fulfillment
  - name: Shipping boxes
    description: Manage shipping boxes and read the boxes available for a product.
    summary: Shipping boxes
    kind: nav
    parent: section-fulfillment
  - name: Shipping zones
    description: Create, read and maintain shipping zones.
    summary: Shipping zones
    kind: nav
    parent: section-fulfillment
  - name: Warehouses
    description: Create, read and maintain the store’s warehouses.
    summary: Warehouses
    kind: nav
    parent: section-fulfillment
  - name: section-point-of-sale
    summary: Point of sale
    kind: nav
  - name: Devices
    description: Manage POS devices, generate pairing codes and revoke devices.
    summary: Devices
    kind: nav
    parent: section-point-of-sale
  - name: POS users
    description: Manage staff accounts used at the point of sale.
    summary: Staff
    kind: nav
    parent: section-point-of-sale
  - name: POS roles
    description: Manage POS roles and inspect available permissions.
    summary: Roles & permissions
    kind: nav
    parent: section-point-of-sale
  - name: section-store
    summary: Store
    kind: nav
  - name: Store
    description: Read and update the store configuration.
    summary: Store
    kind: nav
    parent: section-store
  - name: Locations
    description: List countries, states and pincodes.
    summary: Locations
    kind: nav
    parent: section-store
  - name: Notifications
    description: >-
      Manage notification templates and store or customer notification
      preferences.
    summary: Notifications
    kind: nav
    parent: section-store
  - name: Downloads
    description: Request data downloads and follow download jobs.
    summary: Downloads
    kind: nav
    parent: section-store
  - name: Search
    description: Search customers, orders and products across the store.
    summary: Search
    kind: nav
    parent: section-store
  - name: Filter options
    description: >-
      Retrieve the available filters for resource lists in the administration
      interface.
    summary: Filter options
    kind: nav
    parent: section-store
  - name: section-integrations
    summary: Integrations
    kind: nav
  - name: Catalog integrations
    description: Request catalog synchronization and inspect sync results and activity.
    summary: Catalog integrations
    kind: nav
    parent: section-integrations
  - name: Service providers
    description: Configure service providers and test their connections.
    summary: Service providers
    kind: nav
    parent: section-integrations
  - name: Webhooks
    description: >-
      Manage webhook subscriptions, rotate their secrets and send test
      deliveries.
    summary: Webhooks
    kind: nav
    parent: section-integrations
  - name: Webhook deliveries
    description: >-
      Inspect webhook delivery logs, retry deliveries and replay events to a
      subscription.
    summary: Webhook deliveries
    kind: nav
    parent: section-integrations
  - name: Events
    description: >-
      Browse recorded events and the event types available for webhook
      subscriptions.
    summary: Events
    kind: nav
    parent: section-integrations
  - name: Live updates
    description: Read the store’s live event stream and global state.
    summary: Live updates
    kind: nav
    parent: section-integrations
  - name: section-analytics
    summary: Analytics
    kind: nav
  - name: Analytics
    description: Query analytics data, read charts and inspect visitor sessions and events.
    summary: Analytics
    kind: nav
    parent: section-analytics
  - name: Metrics
    description: >-
      Read aggregate metrics for catalog, customers, orders, payments,
      fulfillment and webhooks.
    summary: Metrics
    kind: nav
    parent: section-analytics
paths:
  /orders/{order_number}/payments/{request_number}/mark-paid:
    parameters:
      - name: order_number
        in: path
        description: Order number
        required: true
        schema:
          type: string
      - name: request_number
        in: path
        description: The order payment's request number
        required: true
        schema:
          type: string
    post:
      tags:
        - Order payments
      summary: Mark an order payment paid
      description: >-
        Marks an order's pending manual payment paid once the store has the
        money, for example a cheque it received. The money is recorded as a
        payment of the order (`payment`, `settled`), the order payment becomes
        `success` and the order's payment status is updated; an order now paid
        in full is confirmed, and a gateway payment still pending on it is
        marked failed. Returns the order payment and the recorded payment. Fails
        with a 400 when the order is cancelled, the payment isn't a pending
        manual one, it is for more than the order still owes, or
        `payment_method` isn't one of the store's; with a 404 for an unknown
        order or payment; and with a 409, changing nothing, while payment
        records are briefly being updated.
      operationId: mark-order-payment-paid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                payment_reference_number:
                  description: The money's reference, such as the cheque number.
                  type: string
                  maxLength: 128
                payment_method:
                  description: >-
                    One of the store's active manual payment methods, by its
                    slug, when the money came by another method than the
                    payment's: the recorded payment's `payment_method`.
                  type: string
                  maxLength: 64
                remarks:
                  description: Written to the order's activity.
                  type: string
                  maxLength: 1000
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - success
                  - content
                properties:
                  message:
                    type: string
                    examples:
                      - Payment marked as paid.
                  success:
                    type: boolean
                  content:
                    properties:
                      order_payment:
                        $ref: '#/components/schemas/OrderPayment'
                      payment:
                        $ref: '#/components/schemas/PaymentDetail'
                    required:
                      - order_payment
                      - payment
                    type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: >-
            Payment records are briefly being updated. Nothing is changed; retry
            shortly.
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - success
                properties:
                  message:
                    type: string
                    examples:
                      - >-
                        Marking a payment paid waits for the payment ledger
                        update to finish; try again shortly
                  success:
                    type: boolean
                    default: false
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    OrderPayment:
      title: OrderPayment
      description: >-
        Order payment. Each array entry matches one method-specific shape; only
        fields for that method are present (for example `card_number` on card
        payments, `bank_name` on bank transfer).
      anyOf:
        - $ref: '#/components/schemas/CardPayment'
        - $ref: '#/components/schemas/BankTransfer'
        - $ref: '#/components/schemas/NetbankingPayment'
        - $ref: '#/components/schemas/UpiPayment'
        - $ref: '#/components/schemas/WalletPayment'
        - $ref: '#/components/schemas/LoyaltyPointPayment'
        - $ref: '#/components/schemas/OrderPaymentCommonOnly'
      x-tags:
        - Orders
    PaymentDetail:
      title: PaymentDetail
      description: Payment info with settlement details.
      allOf:
        - $ref: '#/components/schemas/Payment'
        - type: object
          properties:
            settlement:
              type: array
              items:
                $ref: '#/components/schemas/PaymentSettlement'
            allowed_actions:
              type: array
              items:
                $ref: '#/components/schemas/PaymentAction'
      x-tags:
        - Payments
    CardPayment:
      title: CardPayment
      description: Payments using credit card, debit card
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
        - type: object
          properties:
            card_number:
              description: "masked card number\r\ne.g. ************1111"
              type:
                - string
                - 'null'
            card_type:
              description: Card brand supplied by the payment provider.
              type:
                - string
                - 'null'
    BankTransfer:
      title: BankTransfer
      description: Bank transfer payment - IMPS, NEFT, RTGS
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
        - type: object
          properties:
            bank_account_number:
              description: "masked account number\r\ne.g. ************1234"
              type:
                - string
                - 'null'
            bank_name:
              type:
                - string
                - 'null'
    NetbankingPayment:
      title: NetbankingPayment
      description: Payments using payment gateway netbanking option.
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
        - type: object
          properties:
            bank_name:
              type: string
    UpiPayment:
      title: UpiPayment
      description: UPI Payment
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
        - type: object
          properties:
            upi_id:
              type:
                - string
                - 'null'
    WalletPayment:
      title: WalletPayment
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
        - type: object
          properties:
            wallet_name:
              type:
                - string
                - 'null'
    LoyaltyPointPayment:
      title: LoyaltyPointPayment
      description: Loyalty point redemption.
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
      x-tags:
        - Orders
    OrderPaymentCommonOnly:
      title: OrderPaymentCommonOnly
      description: >-
        Order payment with only common fields, for methods such as Cash, NACH,
        or POS entries with no method-specific metadata.
      allOf:
        - $ref: '#/components/schemas/OrderPaymentInfo'
      x-tags:
        - Orders
    Payment:
      title: Payment
      description: Common fields in inbound and refund payments.
      allOf:
        - $ref: '#/components/schemas/PaymentCommonFields'
        - $ref: '#/components/schemas/PaymentMethodDetail'
      x-tags:
        - Payments
    PaymentSettlement:
      title: PaymentSettlement
      description: Order allocation, refund, or funding payment settlement.
      oneOf:
        - type: object
          properties:
            settlement_option:
              type: string
              const: order
            settlement_date:
              type: string
              format: date-time
            settled_amount:
              type: number
              format: double
            payment_method:
              type:
                - string
                - 'null'
            card_number:
              type:
                - string
                - 'null'
            card_type:
              type:
                - string
                - 'null'
            upi_id:
              type:
                - string
                - 'null'
            bank_account_number:
              type:
                - string
                - 'null'
            bank_name:
              type:
                - string
                - 'null'
            icon_url:
              type:
                - string
                - 'null'
            order_number:
              description: Present when `settlement_option` is `order`.
              type: string
              readOnly: true
            order_date:
              description: Present when `settlement_option` is `order`.
              type: string
              format: date-time
              readOnly: true
            order_amount:
              description: Present when `settlement_option` is `order`.
              type: number
              format: double
              readOnly: true
            order_status:
              $ref: '#/components/schemas/OrderStatus'
              description: Present when `settlement_option` is `order`.
              readOnly: true
            wallet_name:
              type:
                - string
                - 'null'
          required:
            - settlement_option
            - settlement_date
            - settled_amount
        - type: object
          properties:
            settlement_option:
              type: string
              const: refund
            settlement_date:
              type: string
              format: date-time
            settled_amount:
              type: number
              format: double
            payment_method:
              type:
                - string
                - 'null'
            card_number:
              type:
                - string
                - 'null'
            card_type:
              type:
                - string
                - 'null'
            upi_id:
              type:
                - string
                - 'null'
            bank_account_number:
              type:
                - string
                - 'null'
            bank_name:
              type:
                - string
                - 'null'
            icon_url:
              type:
                - string
                - 'null'
            payment_reference_number:
              type:
                - string
                - 'null'
            transaction_date:
              type: string
              format: date-time
            transaction_amount:
              type: number
            status:
              type: string
              examples:
                - pending
                - success
                - failed
                - settled
                - partially_settled
            wallet_name:
              type:
                - string
                - 'null'
          required:
            - settlement_option
            - settlement_date
            - settled_amount
        - type: object
          properties:
            settlement_option:
              type: string
              const: payment
            settlement_date:
              type: string
              format: date-time
            settled_amount:
              type: number
              format: double
            payment_method:
              type:
                - string
                - 'null'
            card_number:
              type:
                - string
                - 'null'
            card_type:
              type:
                - string
                - 'null'
            upi_id:
              type:
                - string
                - 'null'
            bank_account_number:
              type:
                - string
                - 'null'
            bank_name:
              type:
                - string
                - 'null'
            icon_url:
              type:
                - string
                - 'null'
            payment_reference_number:
              type:
                - string
                - 'null'
            transaction_date:
              type: string
              format: date-time
            transaction_amount:
              type: number
            status:
              type: string
              examples:
                - pending
                - success
                - failed
                - settled
                - partially_settled
            wallet_name:
              type:
                - string
                - 'null'
          required:
            - settlement_option
            - settlement_date
            - settled_amount
    PaymentAction:
      enum:
        - refund
        - send-reminder
        - cancel
    OrderPaymentInfo:
      title: OrderPaymentInfo
      description: Common fields in all types of payments.
      type: object
      properties:
        transaction_type:
          enum:
            - payment
            - refund
        request_number:
          type: string
        amount:
          type: number
          format: double
        payment_status:
          type: string
          enum:
            - pending
            - success
            - failed
            - partially_paid
            - refund_initiated
            - refunded
            - unsettled
            - settled
            - partially_settled
            - manual_review
            - debit_scheduled
            - collection_due
            - initiated
            - forfeited
        payment_date:
          type:
            - string
            - 'null'
          format: date-time
        payment_reference_number:
          type:
            - string
            - 'null'
        payment_method:
          description: >-
            How it was paid, e.g. `Card`, `Credit Card`, `Debit Card`,
            `Netbanking`, `UPI`, `Wallet`, `Loyalty Point`, `IMPS`, `NEFT`,
            `RTGS`, `Cash`, `NACH`. A manual payment carries the method it was
            requested or recorded with. Empty string when recorded without a
            method, as on point-of-sale orders; null for refunds and payments
            not paid yet.
          type:
            - string
            - 'null'
        payment_mode:
          type: string
        icon_url:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type: string
          format: date-time
          readOnly: true
      x-tags:
        - Orders
    PaymentCommonFields:
      title: PaymentCommonFields
      description: Common fields in inbound and refund payments.
      type: object
      properties:
        payment_id:
          description: >-
            The payment's id: the `payment_id` its `payment.*` events carry (a
            credit-balance refund's `balance_refund_id`). Absent when the detail
            shows an order's payment request with no payment recorded.
          type: string
        transaction_type:
          enum:
            - payment
            - refund
        request_number:
          type: string
        transaction_date:
          type: string
          format: date-time
        transaction_amount:
          type: number
          format: double
        settled_amount:
          type: number
          format: double
          default: 0
        unsettled_amount:
          type: number
          format: double
          default: 0
        payment_method:
          description: >-
            How it was paid, e.g. `Credit Card`, `Debit Card`, `Netbanking`,
            `UPI`, `Wallet`, `IMPS`, `NEFT`, `RTGS`, `NACH`; for a `manual`
            payment, the offline payment method it was recorded with.
          type:
            - string
            - 'null'
        payment_reference_number:
          type:
            - string
            - 'null'
        payment_mode:
          description: >-
            Where the money came from, or for a refund where it goes.
            `payment-gateway`: a gateway payment or NACH debit, or a refund
            through the gateway. `bank-transfer`: a bank deposit, or a refund
            paid to a bank account. `manual`: cash or another offline payment,
            or a refund given back the same way. `credit-balance`: a refund
            returning bank credit that paid an order to the customer's balance.
          enum:
            - bank-transfer
            - payment-gateway
            - manual
            - credit-balance
            - nach-mandate
        payment_gateway:
          description: >-
            Payment provider slug when `payment_mode` is `payment-gateway`.
            `null` otherwise.
          oneOf:
            - type: 'null'
            - type: string
              enum:
                - juspay
                - icici-ecollection
                - icici-cib
                - PAYU
                - DUMMY
        status:
          $ref: '#/components/schemas/PaymentRecordStatus'
        user_id:
          description: The customer's storefront user.
          type: string
        customer_id:
          type:
            - string
            - 'null'
        customer_name:
          type:
            - string
            - 'null'
      x-tags:
        - Payments
    PaymentMethodDetail:
      title: PaymentMethodDetail
      description: >-
        Method-specific details carried on a payment. Only fields for the
        payment's `payment_method` are populated; others are omitted or `null`.
      type: object
      properties:
        icon_url:
          type:
            - string
            - 'null'
        card_number:
          description: Masked card number when `payment_method` is a card type.
          type:
            - string
            - 'null'
        card_type:
          type:
            - string
            - 'null'
        bank_name:
          type:
            - string
            - 'null'
        wallet_name:
          type:
            - string
            - 'null'
        bank_account_number:
          type:
            - string
            - 'null'
        upi_id:
          type:
            - string
            - 'null'
      additionalProperties: true
      x-tags:
        - Payments
    OrderStatus:
      title: OrderStatus
      type: string
      enum:
        - draft
        - awaiting_approval
        - confirmed
        - schedule_requested
        - partially_scheduled
        - awaiting_shipment
        - shipped
        - partially_shipped
        - undelivered
        - partially_undelivered
        - return_to_origin
        - partially_return_to_origin
        - complete
        - partially_delivered
        - cancelled
        - pending
        - payment_failed
        - sent_to_store
        - ready_to_collect
        - processing
        - lost
    PaymentRecordStatus:
      title: PaymentRecordStatus
      description: >-
        A payment's status. Money received: `pending` (not received yet),
        `unsettled`, `partially_settled` or `settled` (how much of it orders
        hold or refunds took), or `cancelled` (cancelled by an admin while
        `pending`). A refund: `pending`, `refund_initiated` (a credit-balance
        refund being sent to the bank), `initiated` (accepted by the bank, its
        result awaited), `settled` (paid), `failed`, or `cancelled` (a
        credit-balance refund cancelled while `pending`); `refunded` for an
        older order refund paid by bank transfer. The detail of an order's
        payment request with no payment recorded shows the request's own status,
        `settled` once it succeeded.
      type: string
      enum:
        - pending
        - unsettled
        - partially_settled
        - settled
        - refund_initiated
        - initiated
        - failed
        - cancelled
        - refunded
        - partially_paid
        - manual_review
        - debit_scheduled
        - collection_due
  responses:
    BadRequest:
      description: The request is invalid or cannot be completed in the current state.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              errors:
                description: Validation details as a field map, a bulk list or a string.
                anyOf:
                  - type: object
                    additionalProperties: true
                  - type: array
                  - type: string
              content:
                type: object
                additionalProperties: true
              details:
                type: string
    Unauthorized:
      description: >-
        The token is missing, invalid or expired, or does not grant access to
        this store and operation.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              details:
                type: string
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              details:
                type: string
    InternalServerError:
      description: >-
        The request could not be completed. Quote error_id, when present, when
        contacting support.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              details:
                type: string
              error_id:
                type: string
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: >-
        Sign in to the admin dashboard and use the resulting ID token for a
        store and operation you can access. The authenticated dashboard cookie
        is accepted when the Authorization header is absent. Missing or
        insufficient access returns 401.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.