Common objects
You can use common objects to access common Payments Apps API objects.
In this section
Anchor link to section titled "In this section"ApiVersion — A version of the API, as defined by Shopify API versioning. Versions are commonly referred to by their handle (for example,
2021-10
).CaptureSession — Represents a unique capture transaction.
CaptureSessionRejectionReasonInput — The input fields to use for the reason why the capture was rejected.
CaptureSessionState — The state of a finalized capture transaction.
CaptureSessionStateCode — The possible values that can be used to describe the state of a finalized capture transaction.
CaptureSessionStateRejected — Additional details about a capture’s rejected state.
CaptureSessionStateRejectedReason — The possible values that can be used to describe the reason why the capture transaction is rejected.
CaptureSessionStateResolved — Additional details about a capture’s resolved state.
CaptureSessionStates — The possible values that can be used to describe the state of a finalized capture transaction.
CaptureSessionStatus — The status of a finalized capture transaction.
CaptureSessionStatusCode — The possible values that can be used to describe the status of a capture transaction.
CaptureSessionStatusReason — The reason why the capture was rejected.
CaptureSessionStatusReasonRejectionCode — The possible values that can be used to describe the reason why a capture transaction is rejected.
PaymentSession — A unique payment transaction.
PaymentSessionActionsRedirect — The payload required to redirect the customer to the shop after payment is finalized.
PaymentSessionNextAction — The next action that is expected of the Partner after the payment is finalized.
PaymentSessionNextActionAction — The possible values that can be used to describe the next action that a Partner should do after a payment is finalized.
PaymentSessionNextActionContext — The context required to perform an action.
PaymentSessionRejectionReasonInput — The reason why the payment was rejected.
PaymentSessionState — The state of a payment transaction.
PaymentSessionStateCode — The possible values that can be used to describe the state of a payment transaction.
PaymentSessionStatePending — Additional details about a payment’s pending state.
PaymentSessionStatePendingReason — Reasons the finalization of the payment is pending.
PaymentSessionStateRejected — Additional details about a payment’s rejected state.
PaymentSessionStateRejectedReason — The possible values that can be used to describe the reasons why a payment is rejected.
PaymentSessionStateResolved — Additional details about a payment’s resolved state.
PaymentSessionStates — The possible values that can be used to describe the state of a payment transaction.
PaymentSessionStatus — The status of a payment transaction.
PaymentSessionStatusCode — The possible values that can be used to describe the status of a payment.
PaymentSessionStatusReason — The reason why the payment was rejected.
PaymentSessionStatusReasonRejectionCode — The possible values that can be used to describe why a payment transaction was rejected.
PaymentsAppConfiguration — The production configuration of the payments app.
QueryRoot — The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start.
RefundSession — A unique refund transaction.
RefundSessionRejectionReasonInput — The reason why the refund was rejected.
RefundSessionState — The State of a finalized refund transaction.
RefundSessionStateCode — The possible values that can be used to describe the state of a finalized refund transaction.
RefundSessionStateRejected — Additional details about a refund’s rejected state.
RefundSessionStateRejectedReason — The possible values that can be used to describe the reason why the refund is rejected.
RefundSessionStateResolved — Additional details about a refund’s resolved state.
RefundSessionStates — The possible values that can be used to describe the state of a finalized refund transaction.
RefundSessionStatus — The status of a finalized refund transaction.
RefundSessionStatusCode — The possible values that can be used to describe the status of a refund.
RefundSessionStatusReason — The reason why the refund was rejected.
RefundSessionStatusReasonRejectionCode — The possible values that can be used to describe the reason why a refund transaction was rejected.
VoidSession — A unique void transaction.
VoidSessionRejectionReasonInput — The reason why the void transaction was rejected.
VoidSessionState — The state of a finalized void transaction.
VoidSessionStateCode — The possible values that can be used to describe the state of a finalized void transaction.
VoidSessionStateRejected — Additional details about a void’s rejected state.
VoidSessionStateRejectedReason — The possible values that can be used to describe the reason why a void transaction is rejected.
VoidSessionStateResolved — Additional details about a void’s resolved state.
VoidSessionStates — The possible values that can be used to describe the state of a finalized void transaction.
VoidSessionStatus — The status of a finalized void transaction.
VoidSessionStatusCode — The possible values that can be used to describe the status of a void transaction.
VoidSessionStatusReason — The reason why the void transaction was rejected.
VoidSessionStatusReasonRejectionCode — The possible values that can be used to describe the reason why a void transaction is rejected.