Skip to main content

Payment

Payment returned from create/refund/capture/cancel and the send-link/receipt mutations.

type Payment {
  id: ID!
  amount: Int
  amountEUR: Int
  currency: String!
  orderId: ID
  storeId: ID
  pointOfSaleId: ID
  description: String
  descriptor: String
  accountId: ID!
  authorizationCode: String
  livemode: Boolean
  status: PaymentStatus!
  statusCode: String
  statusMessage: String
  customer: Customer
  sequenceId: ID
  subscriptionId: ID
  paymentToken: String
  paymentMethod: PaymentMethod
  shop: Shop
  billingDetails: ContactDetails
  shippingDetails: ContactDetails
  refundedAmount: Int
  lastRefundAmount: Int
  lastRefundReason: RefundReason
  cancellationReason: CancellationReason
  sessionDetails: SessionDetails
  traceDetails: TraceDetails
  nextAction: NextAction
  createdAt: AWSTimestamp
  updatedAt: AWSTimestamp
  pageOpenedAt: AWSTimestamp
  metadata: [KeyValueItem!]
}

Fields​

Payment.id ● ID! non-null scalar​

Unique identifier for the payment.

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

Payment.amountEUR ● Int scalar​

Amount converted to EUR, in cents.

Payment.currency ● String! non-null scalar​

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

Payment.orderId ● ID scalar​

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

Payment.storeId ● ID scalar​

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

Payment.pointOfSaleId ● ID scalar​

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

Payment.description ● String scalar​

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

Payment.descriptor ● String scalar​

Statement descriptor (max 25 chars).

Payment.accountId ● ID! non-null scalar​

Merchant account that owns the payment.

Payment.authorizationCode ● String scalar​

Unique identifier provided by the bank performing transaction.

Payment.livemode ● Boolean scalar​

true for live, false for test mode.

Payment.status ● PaymentStatus! non-null enum​

Current lifecycle state.

Payment.statusCode ● String scalar​

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

Payment.statusMessage ● String scalar​

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

Payment.customer ● Customer object​

Customer identification.

Payment.sequenceId ● ID scalar​

A permanent identifier that refers to the initial payment of a sequence of payments.

Payment.subscriptionId ● ID scalar​

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

Payment.paymentToken ● String scalar​

Single-use token clients pass to the hosted page or confirmPayment to complete the payment.

Payment.paymentMethod ● PaymentMethod object​

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

Payment.shop ● Shop object​

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

Payment.billingDetails ● ContactDetails object​

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

Payment.shippingDetails ● ContactDetails object​

Shipping information associated with the payment.

Payment.refundedAmount ● Int scalar​

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

Payment.lastRefundAmount ● Int scalar​

Amount in cents refunded in the last transaction.

Payment.lastRefundReason ● RefundReason enum​

The reason of the last refund transaction.

Payment.cancellationReason ● CancellationReason enum​

The reason for canceling the Payment.

Payment.sessionDetails ● SessionDetails object​

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

Payment.traceDetails ● TraceDetails object​

Origin metadata for dashboard-initiated actions.

Payment.nextAction ● NextAction object​

If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.

Payment.createdAt ● AWSTimestamp scalar​

Creation time as a unix timestamp (seconds).

Payment.updatedAt ● AWSTimestamp scalar​

Last update time as a unix timestamp (seconds).

Payment.pageOpenedAt ● AWSTimestamp scalar​

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

Payment.metadata ● [KeyValueItem!] list object​

Merchant-defined metadata.

Returned By​

activateSubscription mutation ● cancelPayment mutation ● capturePayment mutation ● createPayment mutation ● refundPayment mutation ● sendPaymentLink mutation ● sendPaymentReceipt mutation ● sendPaymentRequest mutation