CreatePaymentInput

Input for createPayment. The Pay By Link page of the dashboard (Create payment) sends it; its labels are given in parentheses.

input CreatePaymentInput {
  id: ID
  amount: Int!
  orderId: ID
  storeId: ID
  pointOfSaleId: ID
  description: String
  descriptor: String
  customerId: ID
  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: 32 to 40 hexadecimal characters. 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). At most 10000000. 0 is accepted only with sequence or generatePaymentToken: true.

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. 1 to 40 characters: letters, digits and _@./#&+-. When omitted, MONEI generates 12 digits, or 6 capital letters and digits for a point-of-sale payment. The payment fails when another payment of the account with the same order ID is already paid, authorized or being processed.

CreatePaymentInput.storeId ● ID scalar

A unique identifier of the Store (Store). If specified the payment is attached to this Store. A caller restricted to a store always creates payments in that 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. A caller restricted to a point of sale always creates payments for it.

CreatePaymentInput.description ● String scalar

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

CreatePaymentInput.descriptor ● String scalar

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

CreatePaymentInput.customerId ● ID scalar

Links the payment to an existing customer of the current account, so the buyer's saved cards and payments hang together.

CreatePaymentInput.customer ● CustomerInput input

Customer identification (email, name, phone) (Customer name, Customer email, Customer phone).

CreatePaymentInput.billingDetails ● ContactDetailsInput input

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

CreatePaymentInput.shippingDetails ● ContactDetailsInput input

Shipping information associated with the payment (Shipping Address).

CreatePaymentInput.currency ● Currencies enum

Three-letter ISO 4217 currency code, in uppercase. Defaults to the default currency of the account, then EUR.

CreatePaymentInput.allowedPaymentMethods ● [PaymentMethods] list enum

An array of allowed payment methods (used in hosted payment page) (Allowed payment methods). When set, it holds at least one method.

CreatePaymentInput.transactionType ● TransactionTypes enum

Controls when the funds will be captured. Defaults to SALE (auth + capture). AUTH (auth only) is Manually capture payment in the dashboard. See TransactionTypes.

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. For a point-of-sale payment, defaults to the payment callback URL of the point of sale.

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) (Expiration date). The payment cannot be paid after this. Must be in the future. Defaults to 7 days after creation. It does not change when an authorized (AUTH) payment expires.

CreatePaymentInput.metadata ● [KeyValueInput!] list input

Merchant-defined metadata.

CreatePaymentInput.paymentMethod ● PaymentMethodInput input

Payment method to confirm the payment with at once, instead of returning a hosted-page redirect. Set exactly one sub-object. Through this API the sub-objects carry only the phone number of bizum and mbway; every other field is ignored. A card, cardPresent or sepa object fails validation, because this input cannot carry the card number or the IBAN: to pay with a card, use paymentToken.

CreatePaymentInput.paymentToken ● String scalar

Payment token to pay with: a single-use token created on the payment page or by MONEI Components, or a permanent token from Payment.paymentToken. With it, MONEI confirms the payment at once and may return a nextAction for 3D Secure.

CreatePaymentInput.generatePaymentToken ● Boolean scalar

Saves the payment method and returns a permanent payment token in Payment.paymentToken. Pass that token as paymentToken on later payments to charge the same payment method again.

CreatePaymentInput.sequence ● SequenceInput input

Starts a recurring sequence with this payment. When the payment succeeds, it gets a sequenceId, and the later payments of the sequence charge the saved payment method.

CreatePaymentInput.subscriptionId ● ID scalar

Subscription this payment belongs to. It must be a subscription of the current account.

CreatePaymentInput.sessionId ● String scalar

Your session identifier. A payment token created with a session ID can only pay a payment created with the same sessionId.

CreatePaymentInput.autoRecover ● Boolean scalar

When true, a customer who opens the payment link of a failed payment gets a new payment to retry. Payments created through this API always behave so, whatever the value.

CreatePaymentInput.sessionDetails ● SessionDetailsInput input

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

Member Of

createPayment mutation