Skip to main content

PaymentProcessor

Payment processor that can take payments for one payment method on the account: MONEI, or a processor the merchant holds a contract with.

type PaymentProcessor {
  id: ID!
  kind: PaymentProcessorKind!
  name: String!
  paymentMethod: PaymentMethods!
  enabled: Boolean!
  status: PaymentProcessorStatus!
  deleted: Boolean!
  supportedWallets: [PaymentMethods!]
  brand: MerchantProcessorBrand
  acquirer: MerchantAcquirer
  metadata: [MetadataItem!]
  currencies: [Currencies!]
  createdAt: AWSDateTime
  rules: PaymentProcessorRules
}

Fields​

PaymentProcessor.id ● ID! non-null scalar​

Payment processor ID. monei:<paymentMethod> for MONEI, for example monei:card.

PaymentProcessor.kind ● PaymentProcessorKind! non-null enum​

Who runs the processor.

PaymentProcessor.name ● String! non-null scalar​

Display name. MONEI for MONEI processors. For the merchant's own processors, the name the merchant gave it, else a label built from its brand and account details.

PaymentProcessor.paymentMethod ● PaymentMethods! non-null enum​

Payment method this processor takes.

PaymentProcessor.enabled ● Boolean! non-null scalar​

Whether the processor takes payments. true only when status is ACTIVE.

PaymentProcessor.status ● PaymentProcessorStatus! non-null enum​

Whether the processor can take payments, and why not.

PaymentProcessor.deleted ● Boolean! non-null scalar​

true when the merchant deleted this processor. Only paymentProcessor returns deleted processors, so past payments can still show their name.

PaymentProcessor.supportedWallets ● [PaymentMethods!] list enum​

Wallets this processor serves. Set on card processors.

PaymentProcessor.brand ● MerchantProcessorBrand enum​

Brand of a processor the merchant holds a contract with. null for MONEI processors.

PaymentProcessor.acquirer ● MerchantAcquirer enum​

Acquiring entity that settles the funds. null for MONEI processors.

PaymentProcessor.metadata ● [MetadataItem!] list object​

Configuration values of a processor the merchant holds a contract with. Secret values are masked. null for MONEI processors. Schema is described by paymentProcessorConfig.

PaymentProcessor.currencies ● [Currencies!] list enum​

Currencies this processor can take given its current configuration.

PaymentProcessor.createdAt ● AWSDateTime scalar​

When the processor was added to the account. For MONEI processors, when MONEI was first set up for the payment method.

PaymentProcessor.rules ● PaymentProcessorRules object​

Conditions a payment must meet for the processor to take it. null for MONEI processors.

Returned By​

createPaymentProcessor mutation ● deletePaymentProcessor mutation ● enablePaymentProcessor mutation ● paymentProcessor query ● paymentProcessors query ● updatePaymentProcessor mutation