# Charge

Single payment record. The merchant API's primary resource.

```
type Charge {

  id: ID!

  accountId: ID!

  providerId: ID

  checkoutId: ID!

  providerInternalId: ID

  providerReferenceId: ID

  createdAt: AWSTimestamp

  updatedAt: AWSTimestamp

  amount: Int

  amountEUR: Int

  authorizationCode: String

  billingDetails: ContactDetails

  billingPlan: BillingPlans

  currency: String!

  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

  callbackUrl: String

  completeUrl: String

  failUrl: String

  cancelUrl: String

}
```

### Fields[​](#fields "Direct link to Fields")

#### [`Charge.id`](#id) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#id "Direct link to id")

Unique identifier for the payment.

#### [`Charge.accountId`](#account-id) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#account-id "Direct link to account-id")

Merchant account that owns the charge.

#### [`Charge.providerId`](#provider-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#provider-id "Direct link to provider-id")

Configured payment provider that processed the charge.

#### [`Charge.checkoutId`](#checkout-id) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#checkout-id "Direct link to checkout-id")

Underlying checkout/operation that produced this charge.

#### [`Charge.providerInternalId`](#provider-internal-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#provider-internal-id "Direct link to provider-internal-id")

Provider-side identifier of the transaction.

#### [`Charge.providerReferenceId`](#provider-reference-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#provider-reference-id "Direct link to provider-reference-id")

Provider-side reference (often shown to the cardholder, e.g. acquirer reference number).

#### [`Charge.createdAt`](#created-at) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#created-at "Direct link to created-at")

Creation time as a unix timestamp (seconds).

#### [`Charge.updatedAt`](#updated-at) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#updated-at "Direct link to updated-at")

Last update time as a unix timestamp (seconds).

#### [`Charge.amount`](#amount) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#amount "Direct link to amount")

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

#### [`Charge.amountEUR`](#amount-eur) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#amount-eur "Direct link to amount-eur")

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

#### [`Charge.authorizationCode`](#authorization-code) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#authorization-code "Direct link to authorization-code")

Unique identifier provided by the bank performing transaction.

#### [`Charge.billingDetails`](#billing-details) ● [`ContactDetails`](https://docs.monei.com/apis/graphql/types/objects/contact-details/.md) object[​](#billing-details "Direct link to billing-details")

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

#### [`Charge.billingPlan`](#billing-plan) ● [`BillingPlans`](https://docs.monei.com/apis/graphql/types/enums/billing-plans/.md) enum[​](#billing-plan "Direct link to billing-plan")

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

#### [`Charge.currency`](#currency) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#currency "Direct link to currency")

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

#### [`Charge.customer`](#customer) ● [`Customer`](https://docs.monei.com/apis/graphql/types/objects/customer/.md) object[​](#customer "Direct link to customer")

Customer identification (email, name, phone).

#### [`Charge.description`](#description) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#description "Direct link to description")

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

#### [`Charge.descriptor`](#descriptor) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#descriptor "Direct link to descriptor")

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

#### [`Charge.livemode`](#livemode) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#livemode "Direct link to livemode")

`true` for live transactions, `false` for test mode.

#### [`Charge.orderId`](#order-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#order-id "Direct link to order-id")

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

#### [`Charge.storeId`](#store-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#store-id "Direct link to store-id")

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

#### [`Charge.pointOfSaleId`](#point-of-sale-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#point-of-sale-id "Direct link to point-of-sale-id")

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`](#terminal-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#terminal-id "Direct link to terminal-id")

Physical terminal that processed the charge (card-present).

#### [`Charge.sequenceId`](#sequence-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#sequence-id "Direct link to sequence-id")

A permanent identifier that refers to the initial payment of a sequence of payments. This value needs to be sent in the path for `RECURRING` payments.

#### [`Charge.subscriptionId`](#subscription-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#subscription-id "Direct link to subscription-id")

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

#### [`Charge.paymentMethod`](#payment-method) ● [`PaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/payment-method/.md) object[​](#payment-method "Direct link to payment-method")

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

#### [`Charge.cancellationReason`](#cancellation-reason) ● [`CancellationReason`](https://docs.monei.com/apis/graphql/types/enums/cancellation-reason/.md) enum[​](#cancellation-reason "Direct link to cancellation-reason")

The reason for canceling the Payment.

#### [`Charge.lastRefundAmount`](#last-refund-amount) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#last-refund-amount "Direct link to last-refund-amount")

Amount in cents refunded in the last transaction.

#### [`Charge.lastRefundReason`](#last-refund-reason) ● [`RefundReason`](https://docs.monei.com/apis/graphql/types/enums/refund-reason/.md) enum[​](#last-refund-reason "Direct link to last-refund-reason")

The reason of the last refund transaction.

#### [`Charge.refundedAmount`](#refunded-amount) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#refunded-amount "Direct link to refunded-amount")

Amount in cents refunded (can be less than the amount attribute on the payment if a partial refund was issued).

#### [`Charge.shippingDetails`](#shipping-details) ● [`ContactDetails`](https://docs.monei.com/apis/graphql/types/objects/contact-details/.md) object[​](#shipping-details "Direct link to shipping-details")

Shipping information associated with the payment.

#### [`Charge.shop`](#shop) ● [`Shop`](https://docs.monei.com/apis/graphql/types/objects/shop/.md) object[​](#shop "Direct link to shop")

The information about the shop (used in hosted payment page).

#### [`Charge.status`](#status) ● [`ChargeStatus!`](https://docs.monei.com/apis/graphql/types/enums/charge-status/.md) non-null enum[​](#status "Direct link to status")

Current lifecycle state.

#### [`Charge.statusCode`](#status-code) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#status-code "Direct link to status-code")

Payment status code. `E000` succeeded; `E1xx` request errors; `E2xx` decline; `E5xx` system.

#### [`Charge.statusMessage`](#status-message) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#status-message "Direct link to status-message")

Human readable status message, can be displayed to a user.

#### [`Charge.sessionDetails`](#session-details) ● [`SessionDetails`](https://docs.monei.com/apis/graphql/types/objects/session-details/.md) object[​](#session-details "Direct link to session-details")

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

#### [`Charge.traceDetails`](#trace-details) ● [`TraceDetails`](https://docs.monei.com/apis/graphql/types/objects/trace-details/.md) object[​](#trace-details "Direct link to trace-details")

Origin metadata for actions taken from the dashboard or internal tools.

#### [`Charge.pageOpenedAt`](#page-opened-at) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#page-opened-at "Direct link to page-opened-at")

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

#### [`Charge.metadata`](#metadata) ● [`[KeyValueItem!]`](https://docs.monei.com/apis/graphql/types/objects/key-value-item/.md) list object[​](#metadata "Direct link to metadata")

Merchant-defined metadata (`KeyValueItem` list).

#### [`Charge.fraudDetectorScore`](#fraud-detector-score) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#fraud-detector-score "Direct link to fraud-detector-score")

Fraud detector score, `0` (low risk) to `1000` (high risk).

#### [`Charge.callbackUrl`](#callback-url) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#callback-url "Direct link to callback-url")

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

#### [`Charge.completeUrl`](#complete-url) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#complete-url "Direct link to complete-url")

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

#### [`Charge.failUrl`](#fail-url) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#fail-url "Direct link to fail-url")

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`](#cancel-url) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#cancel-url "Direct link to cancel-url")

The URL the customer will be directed to if they decide to cancel payment and return to your website (used in hosted payment page).

### Returned By[​](#returned-by "Direct link to Returned By")

[`charge`](https://docs.monei.com/apis/graphql/operations/queries/charge/.md) query

### Member Of[​](#member-of "Direct link to Member Of")

[`ChargesConnection`](https://docs.monei.com/apis/graphql/types/objects/charges-connection/.md) object
