Choose a version:

orderCapture

mutation

Requires write_orders access scope or write_marketplace_orders access scope. Also: The user must have capture_payments_for_orders permission.

Captures payment for an authorized transaction on an order. Use this mutation to claim the money that was previously reserved by an authorization transaction.

The orderCapture mutation can be used in the following scenarios:

To capture the full amount of an authorized transaction
To capture a partial payment by specifying an amount less than the total order amount
To perform multiple captures on the same order, as long as the order transaction is multi-capturable

Note

Multi-capture functionality is only available to stores on a Shopify Plus plan. For multi-currency orders, the currency field is required and should match the presentment currency from the order.

After capturing a payment, you can:

View the transaction details including status, amount, and processing information.
Track the captured amount in both shop and presentment currencies.
Monitor the transaction's settlement status.

Learn more about order transactions.

Arguments

Anchor to inputinput •OrderCaptureInput!required: The input for the mutation.

Was this section helpful?

Anchor to OrderCapturePayload returnsOrderCapturePayload returns

Anchor to transactiontransaction •OrderTransaction: The created capture transaction.
Anchor to userErrorsuserErrors •[UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Creates a transaction for an order
orderCapture reference

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation TransactionCreate($input: OrderCaptureInput!) {

orderCapture(input: $input) {

transaction {

accountNumber

amountSet {

presentmentMoney {

amount

currencyCode

}

shopMoney {

amount

currencyCode

}

authorizationCode

authorizationExpiresAt

createdAt

errorCode

fees {

amount {

amount

currencyCode

}

formattedGateway

gateway

kind

manuallyCapturable

maximumRefundableV2 {

amount

currencyCode

}

multiCapturable

order {

}

parentTransaction {

}

paymentDetails {

... on CardPaymentDetails {

paymentMethodName

}

... on ShopPayInstallmentsPaymentDetails {

paymentMethodName

}

paymentIcon {

url

}

paymentId

processedAt

receiptJson

settlementCurrency

shopifyPaymentsSet {

refundSet {

acquirerReferenceNumber

}

status

test

totalUnsettledSet {

presentmentMoney {

amount

currencyCode

}

shopMoney {

amount

currencyCode

}

user {

}

userErrors {

field

message

}

}`,

{

variables: {

"input": {

"id": "gid://shopify/Order/431501862",

"parentTransactionId": "gid://shopify/OrderTransaction/336526656",

"amount": "1000.00"

}

);

const data = await response.json();

mutation TransactionCreate($input: OrderCaptureInput!) {
  orderCapture(input: $input) {
    transaction {
      accountNumber
      amountSet {
        presentmentMoney {
          amount
          currencyCode
        }
        shopMoney {
          amount
          currencyCode
        }
      }
      authorizationCode
      authorizationExpiresAt
      createdAt
      errorCode
      fees {
        amount {
          amount
          currencyCode
        }
      }
      formattedGateway
      gateway
      id
      kind
      manuallyCapturable
      maximumRefundableV2 {
        amount
        currencyCode
      }
      multiCapturable
      order {
        id
      }
      parentTransaction {
        id
      }
      paymentDetails {
        ... on CardPaymentDetails {
          paymentMethodName
        }
        ... on ShopPayInstallmentsPaymentDetails {
          paymentMethodName
        }
      }
      paymentIcon {
        url
      }
      paymentId
      processedAt
      receiptJson
      settlementCurrency
      shopifyPaymentsSet {
        refundSet {
          acquirerReferenceNumber
        }
      }
      status
      test
      totalUnsettledSet {
        presentmentMoney {
          amount
          currencyCode
        }
        shopMoney {
          amount
          currencyCode
        }
      }
      user {
        id
      }
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation TransactionCreate($input: OrderCaptureInput!) { orderCapture(input: $input) { transaction { accountNumber amountSet { presentmentMoney { amount currencyCode } shopMoney { amount currencyCode } } authorizationCode authorizationExpiresAt createdAt errorCode fees { amount { amount currencyCode } } formattedGateway gateway id kind manuallyCapturable maximumRefundableV2 { amount currencyCode } multiCapturable order { id } parentTransaction { id } paymentDetails { ... on CardPaymentDetails { paymentMethodName } ... on ShopPayInstallmentsPaymentDetails { paymentMethodName } } paymentIcon { url } paymentId processedAt receiptJson settlementCurrency shopifyPaymentsSet { refundSet { acquirerReferenceNumber } } status test totalUnsettledSet { presentmentMoney { amount currencyCode } shopMoney { amount currencyCode } } user { id } } userErrors { field message } } }",
 "variables": {
    "input": {
      "id": "gid://shopify/Order/431501862",
      "parentTransactionId": "gid://shopify/OrderTransaction/336526656",
      "amount": "1000.00"
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation TransactionCreate($input: OrderCaptureInput!) {
    orderCapture(input: $input) {
      transaction {
        accountNumber
        amountSet {
          presentmentMoney {
            amount
            currencyCode
          }
          shopMoney {
            amount
            currencyCode
          }
        }
        authorizationCode
        authorizationExpiresAt
        createdAt
        errorCode
        fees {
          amount {
            amount
            currencyCode
          }
        }
        formattedGateway
        gateway
        id
        kind
        manuallyCapturable
        maximumRefundableV2 {
          amount
          currencyCode
        }
        multiCapturable
        order {
          id
        }
        parentTransaction {
          id
        }
        paymentDetails {
          ... on CardPaymentDetails {
            paymentMethodName
          }
          ... on ShopPayInstallmentsPaymentDetails {
            paymentMethodName
          }
        }
        paymentIcon {
          url
        }
        paymentId
        processedAt
        receiptJson
        settlementCurrency
        shopifyPaymentsSet {
          refundSet {
            acquirerReferenceNumber
          }
        }
        status
        test
        totalUnsettledSet {
          presentmentMoney {
            amount
            currencyCode
          }
          shopMoney {
            amount
            currencyCode
          }
        }
        user {
          id
        }
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "input": {
        "id": "gid://shopify/Order/431501862",
        "parentTransactionId": "gid://shopify/OrderTransaction/336526656",
        "amount": "1000.00"
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation TransactionCreate($input: OrderCaptureInput!) {
      orderCapture(input: $input) {
        transaction {
          accountNumber
          amountSet {
            presentmentMoney {
              amount
              currencyCode
            }
            shopMoney {
              amount
              currencyCode
            }
          }
          authorizationCode
          authorizationExpiresAt
          createdAt
          errorCode
          fees {
            amount {
              amount
              currencyCode
            }
          }
          formattedGateway
          gateway
          id
          kind
          manuallyCapturable
          maximumRefundableV2 {
            amount
            currencyCode
          }
          multiCapturable
          order {
            id
          }
          parentTransaction {
            id
          }
          paymentDetails {
            ... on CardPaymentDetails {
              paymentMethodName
            }
            ... on ShopPayInstallmentsPaymentDetails {
              paymentMethodName
            }
          }
          paymentIcon {
            url
          }
          paymentId
          processedAt
          receiptJson
          settlementCurrency
          shopifyPaymentsSet {
            refundSet {
              acquirerReferenceNumber
            }
          }
          status
          test
          totalUnsettledSet {
            presentmentMoney {
              amount
              currencyCode
            }
            shopMoney {
              amount
              currencyCode
            }
          }
          user {
            id
          }
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "input": {
        "id": "gid://shopify/Order/431501862",
        "parentTransactionId": "gid://shopify/OrderTransaction/336526656",
        "amount": "1000.00"
      }
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation TransactionCreate($input: OrderCaptureInput!) {
    orderCapture(input: $input) {
      transaction {
        accountNumber
        amountSet {
          presentmentMoney {
            amount
            currencyCode
          }
          shopMoney {
            amount
            currencyCode
          }
        }
        authorizationCode
        authorizationExpiresAt
        createdAt
        errorCode
        fees {
          amount {
            amount
            currencyCode
          }
        }
        formattedGateway
        gateway
        id
        kind
        manuallyCapturable
        maximumRefundableV2 {
          amount
          currencyCode
        }
        multiCapturable
        order {
          id
        }
        parentTransaction {
          id
        }
        paymentDetails {
          ... on CardPaymentDetails {
            paymentMethodName
          }
          ... on ShopPayInstallmentsPaymentDetails {
            paymentMethodName
          }
        }
        paymentIcon {
          url
        }
        paymentId
        processedAt
        receiptJson
        settlementCurrency
        shopifyPaymentsSet {
          refundSet {
            acquirerReferenceNumber
          }
        }
        status
        test
        totalUnsettledSet {
          presentmentMoney {
            amount
            currencyCode
          }
          shopMoney {
            amount
            currencyCode
          }
        }
        user {
          id
        }
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "id": "gid://shopify/Order/431501862",
    "parentTransactionId": "gid://shopify/OrderTransaction/336526656",
    "amount": "1000.00"
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"input": {

"id": "gid://shopify/Order/431501862",

"parentTransactionId": "gid://shopify/OrderTransaction/336526656",

"amount": "1000.00"

}

Response

JSON

{

"orderCapture": {

"transaction": {

"accountNumber": "",

"amountSet": {

"presentmentMoney": {

"amount": "1000.0",

"currencyCode": "USD"

"shopMoney": {

"amount": "1000.0",

"currencyCode": "USD"

}

"authorizationCode": null,

"authorizationExpiresAt": null,

"createdAt": "2024-11-05T18:47:35Z",

"errorCode": null,

"fees": [],

"formattedGateway": "(For Testing) Bogus Gateway",

"gateway": "bogus",

"id": "gid://shopify/OrderTransaction/1068278467",

"kind": "CAPTURE",

"manuallyCapturable": false,

"maximumRefundableV2": null,

"multiCapturable": true,

"order": {

"id": "gid://shopify/Order/431501862"

"parentTransaction": {

"id": "gid://shopify/OrderTransaction/336526656"

"paymentDetails": null,

"paymentIcon": null,

"paymentId": "#1014.3",

"processedAt": "2024-11-05T18:47:35Z",

"receiptJson": "{}",

"settlementCurrency": null,

"shopifyPaymentsSet": null,

"status": "SUCCESS",

"test": true,

"totalUnsettledSet": {

"presentmentMoney": {

"amount": "0.0",

"currencyCode": "USD"

"shopMoney": {

"amount": "0.0",

"currencyCode": "USD"

}

"user": null

"userErrors": []

}