# CreatePaymentInput

Input for `createPayment`.

```
input CreatePaymentInput {

  id: ID

  amount: Int!

  orderId: ID

  storeId: ID

  pointOfSaleId: ID

  description: String

  descriptor: String

  customer: CustomerInput

  billingDetails: ContactDetailsInput

  shippingDetails: ContactDetailsInput

  currency: Currencies

  allowedPaymentMethods: [PaymentMethods]

  transactionType: TransactionTypes

  completeUrl: String

  callbackUrl: String

  cancelUrl: String

  failUrl: String

  expireAt: AWSTimestamp

  metadata: [KeyValueInput!]

  paymentMethod: PaymentMethodInput

  paymentToken: String

  generatePaymentToken: Boolean

  sequence: SequenceInput

  subscriptionId: ID

  sessionId: String

  autoRecover: Boolean

  sessionDetails: SessionDetailsInput

}
```

### Fields[​](#fields "Direct link to Fields")

#### [`CreatePaymentInput.id`](#id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#id "Direct link to id")

Optional client-supplied id. MONEI generates one when omitted.

#### [`CreatePaymentInput.amount`](#amount) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#amount "Direct link to amount")

Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00 USD).

#### [`CreatePaymentInput.orderId`](#order-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#order-id "Direct link to order-id")

An order ID from your system. A unique identifier that can be used to reconcile the payment with your internal system.

#### [`CreatePaymentInput.storeId`](#store-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#store-id "Direct link to store-id")

A unique identifier of the Store. If specified the payment is attached to this Store.

#### [`CreatePaymentInput.pointOfSaleId`](#point-of-sale-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#point-of-sale-id "Direct link to point-of-sale-id")

A unique identifier of the Point of Sale. If specified the payment is attached to this Point of Sale. If there is a QR code attached to the same Point of Sale, this payment will be available by scanning the QR code.

#### [`CreatePaymentInput.description`](#description) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#description "Direct link to description")

An arbitrary string attached to the payment. Often useful for displaying to users.

#### [`CreatePaymentInput.descriptor`](#descriptor) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#descriptor "Direct link to descriptor")

Statement descriptor shown on the cardholder's bank statement (max 25 chars).

#### [`CreatePaymentInput.customer`](#customer) ● [`CustomerInput`](https://docs.monei.com/apis/graphql/types/inputs/customer-input/.md) input[​](#customer "Direct link to customer")

Customer identification (email, name, phone).

#### [`CreatePaymentInput.billingDetails`](#billing-details) ● [`ContactDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/contact-details-input/.md) input[​](#billing-details "Direct link to billing-details")

Billing information associated with the payment method at the time of the transaction.

#### [`CreatePaymentInput.shippingDetails`](#shipping-details) ● [`ContactDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/contact-details-input/.md) input[​](#shipping-details "Direct link to shipping-details")

Shipping information associated with the payment.

#### [`CreatePaymentInput.currency`](#currency) ● [`Currencies`](https://docs.monei.com/apis/graphql/types/enums/currencies/.md) enum[​](#currency "Direct link to currency")

Three-letter ISO 4217 currency code, in uppercase. Defaults to `EUR`.

#### [`CreatePaymentInput.allowedPaymentMethods`](#allowed-payment-methods) ● [`[PaymentMethods]`](https://docs.monei.com/apis/graphql/types/enums/payment-methods/.md) list enum[​](#allowed-payment-methods "Direct link to allowed-payment-methods")

An array of allowed payment methods (used in hosted payment page). Must be enabled payment methods.

#### [`CreatePaymentInput.transactionType`](#transaction-type) ● [`TransactionTypes`](https://docs.monei.com/apis/graphql/types/enums/transaction-types/.md) enum[​](#transaction-type "Direct link to transaction-type")

Controls when the funds will be captured. `SALE` (auth + capture), `AUTH` (auth only).

#### [`CreatePaymentInput.completeUrl`](#complete-url) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#complete-url "Direct link to complete-url")

The URL the customer will be directed to after transaction completed (successful or failed - except if `failUrl` is provided).

#### [`CreatePaymentInput.callbackUrl`](#callback-url) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#callback-url "Direct link to callback-url")

The URL to which a payment result should be sent asynchronously.

#### [`CreatePaymentInput.cancelUrl`](#cancel-url) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#cancel-url "Direct link to cancel-url")

The URL the customer will be directed to if they decide to cancel payment and return to your website (used in hosted payment page).

#### [`CreatePaymentInput.failUrl`](#fail-url) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#fail-url "Direct link to fail-url")

The URL the customer will be directed to after transaction has failed, instead of `completeUrl` (used in hosted payment page). This allows to provide two different URLs for successful and failed payments.

#### [`CreatePaymentInput.expireAt`](#expire-at) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#expire-at "Direct link to expire-at")

Payment expiration time as a unix timestamp (seconds). The payment cannot be paid after this.

#### [`CreatePaymentInput.metadata`](#metadata) ● [`[KeyValueInput!]`](https://docs.monei.com/apis/graphql/types/inputs/key-value-input/.md) list input[​](#metadata "Direct link to metadata")

Merchant-defined metadata.

#### [`CreatePaymentInput.paymentMethod`](#payment-method) ● [`PaymentMethodInput`](https://docs.monei.com/apis/graphql/types/inputs/payment-method-input/.md) input[​](#payment-method "Direct link to payment-method")

Polymorphic payment method input. When provided, attempts direct confirmation instead of returning a hosted-page redirect. Provide only the sub-object matching `method`.

#### [`CreatePaymentInput.paymentToken`](#payment-token) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#payment-token "Direct link to payment-token")

Payment token from a prior tokenization. Routes to the direct-confirm path. Single-use unless `generatePaymentToken: true` was passed when the token was minted.

#### [`CreatePaymentInput.generatePaymentToken`](#generate-payment-token) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#generate-payment-token "Direct link to generate-payment-token")

Mints a permanent reusable payment token from this payment's payment method. The resulting token is exposed on the resulting `Charge`/`Payment` and can be passed as `paymentToken` on subsequent payments.

#### [`CreatePaymentInput.sequence`](#sequence) ● [`SequenceInput`](https://docs.monei.com/apis/graphql/types/inputs/sequence-input/.md) input[​](#sequence "Direct link to sequence")

Marks the start of a payment sequence (recurring/installments). Required for the first payment of a sequence; subsequent payments reuse `paymentToken` without `sequence`.

#### [`CreatePaymentInput.subscriptionId`](#subscription-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#subscription-id "Direct link to subscription-id")

Subscription this payment belongs to. Set automatically when the payment is created by a subscription billing cycle.

#### [`CreatePaymentInput.sessionId`](#session-id) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#session-id "Direct link to session-id")

Session/checkout reference. When set, the payment is bound to that session and shares its lifecycle.

#### [`CreatePaymentInput.autoRecover`](#auto-recover) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#auto-recover "Direct link to auto-recover")

When `true`, MONEI automatically retries this payment on transient failures.

#### [`CreatePaymentInput.sessionDetails`](#session-details) ● [`SessionDetailsInput`](https://docs.monei.com/apis/graphql/types/inputs/session-details-input/.md) input[​](#session-details "Direct link to session-details")

Customer browser/device fingerprint captured at checkout (used for fraud detection and 3DS).

### Member Of[​](#member-of "Direct link to Member Of")

[`createPayment`](https://docs.monei.com/apis/graphql/operations/mutations/create-payment/.md) mutation