Skip to main content

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​

CreatePaymentInput.id ● ID scalar​

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

CreatePaymentInput.amount ● Int! non-null scalar​

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 ● ID scalar​

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

CreatePaymentInput.storeId ● ID scalar​

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

CreatePaymentInput.pointOfSaleId ● ID scalar​

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 ● String scalar​

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

CreatePaymentInput.descriptor ● String scalar​

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

CreatePaymentInput.customer ● CustomerInput input​

Customer identification (email, name, phone).

CreatePaymentInput.billingDetails ● ContactDetailsInput input​

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

CreatePaymentInput.shippingDetails ● ContactDetailsInput input​

Shipping information associated with the payment.

CreatePaymentInput.currency ● Currencies enum​

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

CreatePaymentInput.allowedPaymentMethods ● [PaymentMethods] list enum​

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

CreatePaymentInput.transactionType ● TransactionTypes enum​

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

CreatePaymentInput.completeUrl ● String scalar​

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

CreatePaymentInput.callbackUrl ● String scalar​

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

CreatePaymentInput.cancelUrl ● String scalar​

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 ● String scalar​

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 ● AWSTimestamp scalar​

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

CreatePaymentInput.metadata ● [KeyValueInput!] list input​

Merchant-defined metadata.

CreatePaymentInput.paymentMethod ● PaymentMethodInput input​

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 ● String scalar​

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 ● Boolean scalar​

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 ● SequenceInput input​

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 ● ID scalar​

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

CreatePaymentInput.sessionId ● String scalar​

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

CreatePaymentInput.autoRecover ● Boolean scalar​

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

CreatePaymentInput.sessionDetails ● SessionDetailsInput input​

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

Member Of​

createPayment mutation