Skip to main content

CreatePaymentInput

No description

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!]
}

Fields

`CreatePaymentInput.id` ● `ID` scalar

The ID of the payment to be created

`CreatePaymentInput.amount` ● `Int!` non-null scalar

The amount to be charged (for example 1075 for 10.75€)

`CreatePaymentInput.orderId` ● `ID` scalar

The order ID in your platform (eg: the invoice number). If not present, MONEI will generate a unique one

`CreatePaymentInput.storeId` ● `ID` scalar

The ID of the store

`CreatePaymentInput.pointOfSaleId` ● `ID` scalar

The ID of the Point of Sale this payment will be associated to

`CreatePaymentInput.description` ● `String` scalar

The payment description

`CreatePaymentInput.descriptor` ● `String` scalar

The payment descriptor

`CreatePaymentInput.customer` ● `CustomerInput` input

Basic information about the customer

`CreatePaymentInput.billingDetails` ● `ContactDetailsInput` input

Billing information

`CreatePaymentInput.shippingDetails` ● `ContactDetailsInput` input

Shipping details

`CreatePaymentInput.currency` ● `Currencies` enum

The currency of the payment

`CreatePaymentInput.allowedPaymentMethods` ● `[PaymentMethods]` list enum

Which payment methods are allowed

`CreatePaymentInput.transactionType` ● `TransactionTypes` enum

Transaction type

`CreatePaymentInput.completeUrl` ● `String` scalar

The URL where to send the user when the payment has finished

`CreatePaymentInput.callbackUrl` ● `String` scalar

The URL where to notify a success payment (server-to-server HTTP POST request)

`CreatePaymentInput.cancelUrl` ● `String` scalar

The URL where to send the user when he/she requests to cancel the payment

`CreatePaymentInput.failUrl` ● `String` scalar

The URL where to send the user when the payment has failed

`CreatePaymentInput.expireAt` ● `AWSTimestamp` scalar

Time at which the payment will expire. Measured in seconds since the Unix epoch.

`CreatePaymentInput.metadata` ● `[KeyValueInput!]` list input

The payment metadata

Member Of

createPayment mutation

Fields
Member Of