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. An order can only be captured if it has a successful authorization transaction. Capturing an order will claim the money reserved by the authorization. orderCapture can be used to capture multiple times as long as the OrderTransaction is multi-capturable. To capture a partial payment, the included amount value should be less than the total order amount. Multi-capture is available only to stores on a Shopify Plus plan.

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

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation TransactionCreate($input: OrderCaptureInput!) {
6    orderCapture(input: $input) {
7      transaction {
8        accountNumber
9        amountSet {
10          presentmentMoney {
11            amount
12            currencyCode
13          }
14          shopMoney {
15            amount
16            currencyCode
17          }
18        }
19        authorizationCode
20        authorizationExpiresAt
21        createdAt
22        errorCode
23        fees {
24          amount {
25            amount
26            currencyCode
27          }
28        }
29        formattedGateway
30        gateway
31        id
32        kind
33        manuallyCapturable
34        maximumRefundableV2 {
35          amount
36          currencyCode
37        }
38        multiCapturable
39        order {
40          id
41        }
42        parentTransaction {
43          id
44        }
45        paymentDetails {
46          ... on CardPaymentDetails {
47            paymentMethodName
48          }
49          ... on ShopPayInstallmentsPaymentDetails {
50            paymentMethodName
51          }
52        }
53        paymentIcon {
54          url
55        }
56        paymentId
57        processedAt
58        receiptJson
59        settlementCurrency
60        shopifyPaymentsSet {
61          refundSet {
62            acquirerReferenceNumber
63          }
64        }
65        status
66        test
67        totalUnsettledSet {
68          presentmentMoney {
69            amount
70            currencyCode
71          }
72          shopMoney {
73            amount
74            currencyCode
75          }
76        }
77        user {
78          id
79        }
80      }
81      userErrors {
82        field
83        message
84      }
85    }
86  }`,
87  {
88    variables: {
89      "input": {
90        "id": "gid://shopify/Order/431501862",
91        "parentTransactionId": "gid://shopify/OrderTransaction/336526656",
92        "amount": "1000.00"
93      }
94    },
95  },
96);
97
98const data = await response.json();
99

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/2024-04/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

1{
2  "input": {
3    "id": "gid://shopify/Order/431501862",
4    "parentTransactionId": "gid://shopify/OrderTransaction/336526656",
5    "amount": "1000.00"
6  }
7}

Response

JSON

1{
2  "orderCapture": {
3    "transaction": {
4      "accountNumber": "",
5      "amountSet": {
6        "presentmentMoney": {
7          "amount": "1000.0",
8          "currencyCode": "USD"
9        },
10        "shopMoney": {
11          "amount": "1000.0",
12          "currencyCode": "USD"
13        }
14      },
15      "authorizationCode": null,
16      "authorizationExpiresAt": null,
17      "createdAt": "2024-11-05T18:47:35Z",
18      "errorCode": null,
19      "fees": [],
20      "formattedGateway": "(For Testing) Bogus Gateway",
21      "gateway": "bogus",
22      "id": "gid://shopify/OrderTransaction/1068278467",
23      "kind": "CAPTURE",
24      "manuallyCapturable": false,
25      "maximumRefundableV2": null,
26      "multiCapturable": true,
27      "order": {
28        "id": "gid://shopify/Order/431501862"
29      },
30      "parentTransaction": {
31        "id": "gid://shopify/OrderTransaction/336526656"
32      },
33      "paymentDetails": null,
34      "paymentIcon": null,
35      "paymentId": "#1014.3",
36      "processedAt": "2024-11-05T18:47:35Z",
37      "receiptJson": "{}",
38      "settlementCurrency": null,
39      "shopifyPaymentsSet": null,
40      "status": "SUCCESS",
41      "test": true,
42      "totalUnsettledSet": {
43        "presentmentMoney": {
44          "amount": "0.0",
45          "currencyCode": "USD"
46        },
47        "shopMoney": {
48          "amount": "0.0",
49          "currencyCode": "USD"
50        }
51      },
52      "user": null
53    },
54    "userErrors": []
55  }
56}