orderCreateMandatePayment

mutation

Requires write_payment_mandate access scope. Also: The user must have pay_orders_by_vaulted_card permission. The API client must be installed on a Shopify Plus store to use the amount field.

Creates a payment for an order by mandate.

Arguments

Anchor to amountamount • MoneyInput: The payment amount to collect.
Anchor to autoCaptureautoCapture • BooleanDefault:true: Whether the payment should be authorized or captured. If false, then the authorization of the payment is triggered.
Anchor to idid • ID!required: The ID of the order to collect the balance for.
Anchor to idempotencyKeyidempotencyKey • String!required: A unique key to identify the payment request.
Anchor to mandateIdmandateId • ID!required: The mandate ID used for payment.
Anchor to paymentScheduleIdpaymentScheduleId • ID: The ID of the payment schedule to collect the balance for.

Was this section helpful?

Anchor to OrderCreateMandatePaymentPayload returnsOrderCreateMandatePaymentPayload returns

Anchor to jobjob • Job: The async job used for charging the payment.
Anchor to paymentReferenceIdpaymentReferenceId • String: The Unique ID for the created payment.
Anchor to userErrorsuserErrors • [OrderCreateMandatePaymentUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation orderCreateMandatePayment($amount: MoneyInput, $autoCapture: Boolean, $id: ID!, $idempotencyKey: String!, $mandateId: ID!, $paymentScheduleId: ID) {
2  orderCreateMandatePayment(amount: $amount, autoCapture: $autoCapture, id: $id, idempotencyKey: $idempotencyKey, mandateId: $mandateId, paymentScheduleId: $paymentScheduleId) {
3    job {
4      # Job fields
5    }
6    paymentReferenceId
7    userErrors {
8      field
9      message
10    }
11  }
12}

Input

1{
2  "amount": {
3    "amount": "29.99",
4    "currencyCode": ""
5  },
6  "autoCapture": true,
7  "id": "gid://shopify/<objectName>/10079785100",
8  "idempotencyKey": "<your-idempotencyKey>",
9  "mandateId": "gid://shopify/<objectName>/10079785100",
10  "paymentScheduleId": "gid://shopify/<objectName>/10079785100"
11}

{
  "amount": {
    "amount": "29.99",
    "currencyCode": ""
  },
  "autoCapture": true,
  "id": "gid://shopify/<objectName>/10079785100",
  "idempotencyKey": "<your-idempotencyKey>",
  "mandateId": "gid://shopify/<objectName>/10079785100",
  "paymentScheduleId": "gid://shopify/<objectName>/10079785100"
}

input MoneyInput {
  amount: Decimal!
  currencyCode: CurrencyCode!
}