Skip to main content

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​

Charge.id ● ID! non-null scalar​

Unique identifier for the payment.

Charge.accountId ● ID! non-null scalar​

Merchant account that owns the charge.

Charge.providerId ● ID scalar​

Configured payment provider that processed the charge.

Charge.checkoutId ● ID! non-null scalar​

Underlying checkout/operation that produced this charge.

Charge.providerInternalId ● ID scalar​

Provider-side identifier of the transaction.

Charge.providerReferenceId ● ID scalar​

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

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

Charge.amountEUR ● Int scalar​

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

Charge.authorizationCode ● String scalar​

Unique identifier provided by the bank performing transaction.

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.customer ● Customer object​

Customer identification (email, name, phone).

Charge.description ● String scalar​

An arbitrary string attached to the payment. 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.

Charge.storeId ● ID scalar​

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

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​

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

Charge.sequenceId ● ID scalar​

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 ● 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 in cents refunded in the last transaction.

Charge.lastRefundReason ● RefundReason enum​

The reason of the last refund transaction.

Charge.refundedAmount ● Int scalar​

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

Charge.shippingDetails ● ContactDetails object​

Shipping information associated with the payment.

Charge.shop ● Shop object​

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

Charge.status ● ChargeStatus! non-null enum​

Current lifecycle state.

Charge.statusCode ● String scalar​

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

Charge.statusMessage ● String scalar​

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

Charge.sessionDetails ● SessionDetails object​

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

Charge.traceDetails ● TraceDetails object​

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

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

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

Returned By​

charge query

Member Of​

ChargesConnection object