orderCreateManualPayment

Records a manual payment for an Order that isn't fully paid. Use this mutation to track payments received outside the standard checkout process, such as cash, check, bank transfer, or other offline payment methods.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the orderCreateManualPayment action (under Order).
Fill in the fields below, then reference the result from later steps as {{ordercreatemanualpayment.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation OrderCreateManualPayment($id: ID!, $amount: MoneyInput, $paymentMethodName: String, $processedAt: DateTime) {
  orderCreateManualPayment(
    id: $id
    amount: $amount
    paymentMethodName: $paymentMethodName
    processedAt: $processedAt
  ) {
    order {
      additionalFees {
        id
        name
        price
        taxLines
      }
      alerts {
        actions
        content
        dismissibleHandle
        icon
        severity
        title
      }
      app {
        icon
        id
        name
      }
      attribution {
        displayName
        handle
        icon
      }
      billingAddress {
        address1
        address2
        city
        company
        coordinatesValidated
        country
        countryCode
        countryCodeV2
        firstName
        formattedArea
        id
        lastName
        latitude
        longitude
        name
        phone
        province
        provinceCode
        timeZone
        validationResultSummary
        zip
      }
      billingAddressMatchesShippingAddress
      canMarkAsPaid
      canNotifyCustomer
      cancelReason
      cancellation {
        staffNote
      }
      cancelledAt
      capturable
      cartDiscountAmount
      cartDiscountAmountSet {
        presentmentMoney
        shopMoney
      }
      cartToken
      channel {
        accountId
        accountName
        activeRegions
        app
        handle
        id
        marketsCount
        name
        navigationItems
        overviewPath
        resourceFeedback
        specificationHandle
        supportsFuturePublishing
      }
      channelInformation {
        app
        channelDefinition
        channelId
        displayName
        id
      }
      checkoutToken
      clientIp
      closed
      closedAt
      confirmationNumber
      confirmed
      createdAt
      currencyCode
      currentCartDiscountAmountSet {
        presentmentMoney
        shopMoney
      }
      currentShippingPriceSet {
        presentmentMoney
        shopMoney
      }
      currentSubtotalLineItemsQuantity
      currentSubtotalPriceSet {
        presentmentMoney
        shopMoney
      }
      currentTaxLines {
        channelLiable
        price
        priceSet
        rate
        ratePercentage
        source
        title
      }
      currentTotalAdditionalFeesSet {
        presentmentMoney
        shopMoney
      }
      currentTotalDiscountsSet {
        presentmentMoney
        shopMoney
      }
      currentTotalDutiesSet {
        presentmentMoney
        shopMoney
      }
      currentTotalPriceSet {
        presentmentMoney
        shopMoney
      }
      currentTotalTaxSet {
        presentmentMoney
        shopMoney
      }
      currentTotalWeight
      customAttributes {
        key
        value
      }
      customer {
        amountSpent
        canDelete
        companyContactProfiles
        createdAt
        dataSaleOptOut
        defaultAddress
        defaultEmailAddress
        defaultPhoneNumber
        displayName
        email
        emailMarketingConsent
        firstName
        hasTimelineComment
        id
        identityProviderSubjects
        lastName
        lastOrder
        legacyResourceId
        lifetimeDuration
        locale
        market
        mergeable
        multipassIdentifier
        note
        numberOfOrders
        phone
        productSubscriberStatus
        smsMarketingConsent
        state
        statistics
        tags
        taxExempt
        taxExemptions
        taxSettings
        unsubscribeUrl
        updatedAt
        validEmailAddress
        verifiedEmail
      }
      customerAcceptsMarketing
      customerJourney {
        customerOrderIndex
        daysToConversion
        firstVisit
        lastVisit
        moments
      }
      customerJourneySummary {
        customerOrderIndex
        daysToConversion
        firstVisit
        lastVisit
        momentsCount
        ready
      }
      customerLocale
      discountCode
      discountCodes
      displayAddress {
        address1
        address2
        city
        company
        coordinatesValidated
        country
        countryCode
        countryCodeV2
        firstName
        formattedArea
        id
        lastName
        latitude
        longitude
        name
        phone
        province
        provinceCode
        timeZone
        validationResultSummary
        zip
      }
      displayFinancialStatus
      displayFulfillmentStatus
      disputes {
        id
        initiatedAs
        status
      }
      dutiesIncluded
      edited
      email
      estimatedTaxes
      fulfillable
      fulfillmentsCount {
        count
        precision
      }
      fullyPaid
      hasTimelineComment
      id
      landingPageDisplayText
      landingPageUrl
      legacyResourceId
      merchantBusinessEntity {
        address
        archived
        companyName
        displayName
        id
        legalEntityId
        primary
        shopifyPaymentsAccount
      }
      merchantEditable
      merchantEditableErrors
      merchantOfRecordApp {
        icon
        id
        name
      }
      name
      netPayment
      netPaymentSet {
        presentmentMoney
        shopMoney
      }
      note
      number
      originalTotalAdditionalFeesSet {
        presentmentMoney
        shopMoney
      }
      originalTotalDutiesSet {
        presentmentMoney
        shopMoney
      }
      originalTotalPriceSet {
        presentmentMoney
        shopMoney
      }
      paymentCollectionDetails {
        additionalPaymentCollectionUrl
        vaultedPaymentMethods
      }
      paymentGatewayNames
      paymentTerms {
        draftOrder
        due
        dueInDays
        id
        order
        overdue
        paymentTermsName
        paymentTermsType
        translatedName
      }
      phone
      physicalLocation {
        activatable
        address
        addressVerified
        createdAt
        deactivatable
        deactivatedAt
        deletable
        fulfillmentService
        fulfillsOnlineOrders
        hasActiveInventory
        hasUnfulfilledOrders
        id
        isActive
        isFulfillmentService
        isPrimary
        legacyResourceId
        localPickupSettingsV2
        name
        shipsInventory
        suggestedAddresses
        updatedAt
      }
      poNumber
      presentmentCurrencyCode
      processedAt
      productNetwork
      publication {
        app
        autoPublish
        catalog
        id
        name
        operation
        supportsFuturePublishing
      }
      purchasingEntity
      referralCode
      referrerDisplayText
      referrerUrl
      refundDiscrepancySet {
        presentmentMoney
        shopMoney
      }
      refundable
      registeredSourceUrl
      requiresShipping
      restockable
      retailLocation {
        activatable
        address
        addressVerified
        createdAt
        deactivatable
        deactivatedAt
        deletable
        fulfillmentService
        fulfillsOnlineOrders
        hasActiveInventory
        hasUnfulfilledOrders
        id
        isActive
        isFulfillmentService
        isPrimary
        legacyResourceId
        localPickupSettingsV2
        name
        shipsInventory
        suggestedAddresses
        updatedAt
      }
      returnStatus
      risk {
        assessments
        recommendation
      }
      riskLevel
      shippingAddress {
        address1
        address2
        city
        company
        coordinatesValidated
        country
        countryCode
        countryCodeV2
        firstName
        formattedArea
        id
        lastName
        latitude
        longitude
        name
        phone
        province
        provinceCode
        timeZone
        validationResultSummary
        zip
      }
      shippingLine {
        carrierIdentifier
        code
        currentDiscountedPriceSet
        custom
        deliveryCategory
        discountAllocations
        discountedPrice
        discountedPriceSet
        id
        isRemoved
        originalPrice
        originalPriceSet
        phone
        price
        requestedFulfillmentService
        shippingRateHandle
        source
        taxLines
        title
      }
      shopifyProtect {
        eligibility
        status
      }
      sourceIdentifier
      sourceName
      staffMember {
        accountType
        active
        email
        exists
        firstName
        id
        initials
        isShopOwner
        lastName
        locale
        name
        phone
        privateData
      }
      subtotalLineItemsQuantity
      subtotalPrice
      subtotalPriceSet {
        presentmentMoney
        shopMoney
      }
      tags
      taxExempt
      taxLines {
        channelLiable
        price
        priceSet
        rate
        ratePercentage
        source
        title
      }
      taxesIncluded
      test
      totalCapturable
      totalCapturableSet {
        presentmentMoney
        shopMoney
      }
      totalCashRoundingAdjustment {
        paymentSet
        refundSet
      }
      totalDiscounts
      totalDiscountsSet {
        presentmentMoney
        shopMoney
      }
      totalOutstandingSet {
        presentmentMoney
        shopMoney
      }
      totalPrice
      totalPriceSet {
        presentmentMoney
        shopMoney
      }
      totalReceived
      totalReceivedSet {
        presentmentMoney
        shopMoney
      }
      totalRefunded
      totalRefundedSet {
        presentmentMoney
        shopMoney
      }
      totalRefundedShippingSet {
        presentmentMoney
        shopMoney
      }
      totalShippingPrice
      totalShippingPriceSet {
        presentmentMoney
        shopMoney
      }
      totalTax
      totalTaxSet {
        presentmentMoney
        shopMoney
      }
      totalTipReceived {
        amount
        currencyCode
      }
      totalTipReceivedSet {
        presentmentMoney
        shopMoney
      }
      totalWeight
      transactionsCount {
        count
        precision
      }
      unpaid
      updatedAt
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

idstringrequired

The ID of the order to create a manual payment for.

amountobject

The manual payment amount to be created.

amountstringrequired

currencyCodestringrequired

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

paymentMethodNamestring

The name of the payment method used for creating the payment. If none is provided, then the default manual payment method ('Other') will be used.

processedAtstring

The date and time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when a manual payment was processed. If you're importing transactions from an app or another platform, then you can set processedAt to a date and time in the past to match when the original transaction was created.

json

{
  "id": "string",
  "amount": {
    "amount": "string",
    "currencyCode": "USD"
  },
  "paymentMethodName": "string",
  "processedAt": "string"
}

Response

Read the result with {{ordercreatemanualpayment.response.data.data.orderCreateManualPayment}}. If the API returns errors, the step fails and they are at {{ordercreatemanualpayment.response.data.errors}}.

orderobject

additionalFeesarray<object>

alertsarray<object>

appobject3 fields

attributionobject3 fields

billingAddressobject21 fields

billingAddressMatchesShippingAddressboolean

canMarkAsPaidboolean

canNotifyCustomerboolean

cancelReasonstring

One ofCUSTOMERDECLINEDFRAUDINVENTORYSTAFFOTHER

cancellationobject1 fields

cancelledAtstring

capturableboolean

cartDiscountAmountstring

cartDiscountAmountSetobject2 fields

cartTokenstring

channelobject13 fields

channelInformationobject5 fields

checkoutTokenstring

clientIpstring

closedboolean

closedAtstring

confirmationNumberstring

confirmedboolean

createdAtstring

currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

currentCartDiscountAmountSetobject2 fields

currentShippingPriceSetobject2 fields

currentSubtotalLineItemsQuantitynumber

currentSubtotalPriceSetobject2 fields

currentTaxLinesarray<object>

currentTotalAdditionalFeesSetobject2 fields

currentTotalDiscountsSetobject2 fields

currentTotalDutiesSetobject2 fields

currentTotalPriceSetobject2 fields

currentTotalTaxSetobject2 fields

currentTotalWeightstring

customAttributesarray<object>

customerobject38 fields

customerAcceptsMarketingboolean

customerJourneyobject5 fields

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?