---
title: orderCreateMandatePayment - GraphQL Admin
description: Creates a payment for an order by mandate.
api_version: unstable
api_name: admin
source_url:
  html: >-
    https://shopify.dev/docs/api/admin-graphql/unstable/mutations/orderCreateMandatePayment
  md: >-
    https://shopify.dev/docs/api/admin-graphql/unstable/mutations/orderCreateMandatePayment.md
---

# order​Create​Mandate​Payment

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

* amount

  [Money​Input](https://shopify.dev/docs/api/admin-graphql/unstable/input-objects/MoneyInput)

  The payment amount to collect.

* auto​Capture

  [Boolean](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Boolean)

  Default:true

  Whether the payment should be authorized or captured. If `false`, then the authorization of the payment is triggered.

* id

  [ID!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/ID)

  required

  The ID of the order to collect the balance for.

* idempotency​Key

  [String!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/String)

  required

  A unique key to identify the payment request.

* mandate​Id

  [ID!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/ID)

  required

  The mandate ID used for payment.

* payment​Schedule​Id

  [ID](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/ID)

  The ID of the payment schedule to collect the balance for.

***

## Order​Create​Mandate​Payment​Payload returns

* job

  [Job](https://shopify.dev/docs/api/admin-graphql/unstable/objects/Job)

  The async job used for charging the payment.

* payment​Reference​Id

  [String](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/String)

  The Unique ID for the created payment.

* user​Errors

  [\[Order​Create​Mandate​Payment​User​Error!\]!](https://shopify.dev/docs/api/admin-graphql/unstable/objects/OrderCreateMandatePaymentUserError)

  non-null

  The list of errors that occurred from executing the mutation.

***

## Examples

* ### orderCreateMandatePayment reference

## Mutation Reference

```graphql
mutation orderCreateMandatePayment($id: ID!, $paymentScheduleId: ID, $idempotencyKey: String!, $mandateId: ID!, $amount: MoneyInput, $autoCapture: Boolean) {
  orderCreateMandatePayment(id: $id, paymentScheduleId: $paymentScheduleId, idempotencyKey: $idempotencyKey, mandateId: $mandateId, amount: $amount, autoCapture: $autoCapture) {
    job {
      # Job fields
    }
    paymentReferenceId
    userErrors {
      field
      message
    }
  }
}
```

## Input

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

##### Variables

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

##### Schema

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