Skip to main content

Charge

No description

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

The charge ID

Charge.accountId ● ID! non-null scalar

The account ID

Charge.providerId ● ID scalar

The provider ID

Charge.checkoutId ● ID! non-null scalar

Charge.providerInternalId ● ID scalar

Charge.providerReferenceId ● ID scalar

Charge.createdAt ● AWSTimestamp scalar

Created date as a Unix timestamp

Charge.updatedAt ● AWSTimestamp scalar

Updated date as a Unix timestamp

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 intended to be collected by this payment in EUR. A positive integer representing how much to charge in the smallest currency unit (e.g. 100 cents to charge 1.00 EUR).

Charge.authorizationCode ● String scalar

The authorization code

Charge.billingDetails ● ContactDetails object

Billing information

Charge.billingPlan ● BillingPlans enum

Billing plan

Charge.currency ● String! non-null scalar

The currency of the payment

Charge.customer ● Customer object

Basic information about the customer

Charge.description ● String scalar

The payment description

Charge.descriptor ● String scalar

The payment descriptor that will appear on the customer's statement

Charge.livemode ● Boolean scalar

Whether the charge was made in live mode

Charge.orderId ● ID scalar

The order ID in your platform (eg: the invoice number)

Charge.storeId ● ID scalar

The ID of the store

Charge.pointOfSaleId ● ID scalar

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

Charge.terminalId ● ID scalar

The ID of the terminal this payment will be associated to

Charge.sequenceId ● ID scalar

The sequence ID

Charge.subscriptionId ● ID scalar

The subscription ID

Charge.paymentMethod ● PaymentMethod object

The payment method

Charge.cancellationReason ● CancellationReason enum

The reason why the payment is being canceled

Charge.lastRefundAmount ● Int scalar

The last refund amount

Charge.lastRefundReason ● RefundReason enum

The last refund reason

Charge.refundedAmount ● Int scalar

Total refunded amount

Charge.shippingDetails ● ContactDetails object

Shipping information

Charge.shop ● Shop object

Shop information

Charge.status ● ChargeStatus! non-null enum

The charge status

Charge.statusCode ● String scalar

The status code, full list of possible values can be found in the documentation

Charge.statusMessage ● String scalar

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

Charge.sessionDetails ● SessionDetails object

Session details

Charge.traceDetails ● TraceDetails object

Trace details

Charge.pageOpenedAt ● AWSTimestamp scalar

Time when the payment page was opened by customer as a Unix timestamp

Charge.metadata ● [KeyValueItem!] list object

Metadata key-value pairs

Charge.fraudDetectorScore ● Int scalar

Fraud detector score (0-1000)

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

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