Charge

One payment of the account, as the Payments page of the dashboard lists it. Amounts are integers in the smallest unit of the currency: cents for EUR, whole yen for JPY.

type Charge {
  id: ID!
  accountId: ID!
  providerId: ID @deprecated
  paymentProcessorId: ID
  checkoutId: ID!
  providerInternalId: ID @deprecated
  providerReferenceId: ID
  createdAt: AWSTimestamp
  updatedAt: AWSTimestamp
  amount: Int
  amountEUR: Int
  authorizationCode: String
  billingDetails: ContactDetails
  billingPlan: BillingPlans
  currency: String!
  customerId: ID
  customer: Customer
  description: String
  descriptor: String
  livemode: Boolean
  orderId: ID
  storeId: ID
  pointOfSaleId: ID
  terminalId: ID
  sequenceId: ID
  subscriptionId: ID
  paymentMethod: PaymentMethod
  cancellationReason: CancellationReason
  lastRefundAmount: Int
  lastRefundReason: RefundReason
  refundedAmount: Int
  shippingDetails: ContactDetails
  shop: Shop
  status: ChargeStatus!
  statusCode: String
  statusMessage: String
  sessionDetails: SessionDetails
  traceDetails: TraceDetails
  pageOpenedAt: AWSTimestamp
  metadata: [KeyValueItem!]
  fraudDetectorScore: Int
  routingSignals: RoutingSignals
  callbackUrl: String
  completeUrl: String
  failUrl: String
  cancelUrl: String
  installmentsData: InstallmentsData
  chargeback: Boolean
}

Fields

Charge.id ● ID! non-null scalar

Unique identifier for the payment (Payment ID in the dashboard).

Charge.accountId ● ID! non-null scalar

Merchant account that owns the charge.

Charge.providerId ● ID deprecated scalar

DEPRECATED

Use paymentProcessorId instead

Always null.

Charge.paymentProcessorId ● ID scalar

Payment processor that processed the charge (Payment processor in the dashboard): monei:<paymentMethod> for MONEI, for example monei:card, or the ID of a processor the merchant holds a contract with. null when no processor took the charge. Pass it to the paymentProcessor query to read the processor.

Charge.checkoutId ● ID! non-null scalar

ID of the checkout that created the charge.

Charge.providerInternalId ● ID deprecated scalar

DEPRECATED

Use providerReferenceId instead

Always null.

Charge.providerReferenceId ● ID scalar

Reference of the payment at the processor (Provider reference ID in the dashboard).

Charge.createdAt ● AWSTimestamp scalar

Creation time as a unix timestamp (seconds).

Charge.updatedAt ● AWSTimestamp scalar

Last update time as a unix timestamp (seconds).

Charge.amount ● Int 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). After a partial capture, the captured amount.

Charge.amountEUR ● Int scalar

Amount converted to EUR, in cents. Used for cross-currency reporting.

Charge.authorizationCode ● String scalar

Authorization code returned by the bank that authorized the payment (Authorization code in the dashboard).

Charge.billingDetails ● ContactDetails object

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

Charge.billingPlan ● BillingPlans enum

Commercial billing plan of the merchant at the time of the charge.

Charge.currency ● String! non-null scalar

Three-letter ISO 4217 currency code, in uppercase. Must be a supported currency.

Charge.customerId ● ID scalar

Customer entity the payment is linked to.

Charge.customer ● Customer object

Customer identification (email, name, phone). When the payment was created without customer, taken from the billing details, else from the shipping details.

Charge.description ● String scalar

An arbitrary string attached to the payment, up to 1000 characters. Often useful for displaying to users.

Charge.descriptor ● String scalar

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

Charge.livemode ● Boolean scalar

true for live transactions, false for test mode.

Charge.orderId ● ID scalar

An order ID from your system. A unique identifier that can be used to reconcile the payment with your internal system. When createPayment gets none, MONEI generates one.

Charge.storeId ● ID scalar

A unique identifier of the Store. If specified the payment is attached to this Store. A point-of-sale payment gets the store of its point of sale.

Charge.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.

Charge.terminalId ● ID scalar

Terminal ID, taken from the point of sale of the payment.

Charge.sequenceId ● ID scalar

ID of the first payment of a recurring sequence (a payment created with sequence). The first payment gets it when it succeeds, and the later payments of the sequence carry the same value (Sequence ID in the dashboard).

Charge.subscriptionId ● ID scalar

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

Charge.paymentMethod ● PaymentMethod object

Details about the payment method at the time of the transaction.

Charge.cancellationReason ● CancellationReason enum

The reason for canceling the Payment.

Charge.lastRefundAmount ● Int scalar

Amount refunded by the last refund, in the smallest currency unit.

Charge.lastRefundReason ● RefundReason enum

The reason of the last refund transaction.

Charge.refundedAmount ● Int scalar

Total amount refunded so far, in the smallest currency unit. Less than amount after a partial refund.

Charge.shippingDetails ● ContactDetails object

Shipping information associated with the payment.

Charge.shop ● Shop object

The shop shown to the customer on the hosted payment page: the name and country of the store of the payment, else of the business of the account.

Charge.status ● ChargeStatus! non-null enum

Current lifecycle state (Status in the dashboard).

Charge.statusCode ● String scalar

MONEI status code of the payment. E000 means approved; E001 to E004 mean pending or expired. Error groups: E1xx account, processor setup or request errors; E2xx declines by the processor or issuer; E3xx 3D Secure; E4xx fraud and risk rules; E5xx card errors; E6xx digital wallet, PayPal, Bizum and Click to Pay errors; E7xx installment financing; E999 internal error.

Charge.statusMessage ● String scalar

Human readable status message, can be displayed to a user: the English text of statusCode. For a processor the merchant holds a contract with, the text that processor returned.

Charge.sessionDetails ● SessionDetails object

Information related to the browsing session of the user who initiated the payment.

Charge.traceDetails ● TraceDetails object

The request behind the last action on the payment (create, capture, refund or cancel): IP address, browser, the dashboard user or the masked API key, and the integration source.

Charge.pageOpenedAt ● AWSTimestamp scalar

When the customer first opened the hosted payment page, as a unix timestamp (seconds).

Charge.metadata ● [KeyValueItem!] list object

Merchant-defined metadata (KeyValueItem list).

Charge.fraudDetectorScore ● Int scalar

Fraud detector score, 0 (low risk) to 1000 (high risk). The dashboard shows it as Risk score, divided by 10 (out of 100).

Charge.routingSignals ● RoutingSignals object

Payment routing rule signals applied at confirm time.

Charge.callbackUrl ● String scalar

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

Charge.completeUrl ● String scalar

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

Charge.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.

Charge.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).

Charge.installmentsData ● InstallmentsData object

Installments financing details when the payment was paid in installments.

Charge.chargeback ● Boolean scalar

The payment has been disputed by the cardholder. true or null, never false: null on payments that were never disputed. To find disputed payments filter on eq: true; to find the others filter on ne: true, because eq: false finds none. Once set it is not cleared: winning a dispute leaves the flag in place. A disputed payment cannot be refunded.

Returned By

charge query

Member Of

ChargesConnection object