PaymentSession object
A unique payment transaction.
Required access
read_payment_sessions
access scope.
On this page
Fields
-
authorizationExpiresAt (
DateTime
)The date and time when an authorized payment session expires.
-
id (
ID!
)A globally-unique identifier.
-
nextAction (
PaymentSessionNextAction
)The next action expected by the partner.
-
pendingExpiresAt (
DateTime
)The date and time when a pending payment session expires.
-
state (
PaymentSessionStates!
)Details about the payment state.
Mutations for PaymentSession
-
Change a payment session status to pending.
Upon receiving the response from the
PaymentSessionPending
mutation, you must redirect the customer back to Shopify, usingredirectUrl
innextAction
.Upon completion, pending payments must be finalized into either a successful or failed state using the
paymentSessionResolve
orpaymentSessionReject
mutations. Bothsale
andauthorization
payments can be marked as pending. -
Rejects an open payment session. After the
paymentSessionReject
mutation completes on a given payment session, anypaymentSessionResolve
mutation attempts will fail. SubsequentpaymentSessionReject
mutation attempts will succeed, but theRejectionReasonInput
argument will be ignored. -
Resolves an open payment session. After the
paymentSessionResolve
mutation completes on a given payment session, anypaymentSessionReject
mutation attempts will fail. SubsequentpaymentSessionResolve
mutation attempts will succeed, but theDetails
argument will be ignored.
Deprecated fields
-
status (
PaymentSessionStatus!
) deprecatedThe payment status. For pending status, use
state
.Deprecation warning
Deprecated in API Version 2022-04. Use
state
instead.
A unique payment transaction.
Required access
read_payment_sessions
access scope.
On this page
Fields
-
authorizationExpiresAt (
DateTime
)The date and time when an authorized payment session expires.
-
id (
ID!
)A globally-unique identifier.
-
nextAction (
PaymentSessionNextAction
)The next action expected by the partner.
-
pendingExpiresAt (
DateTime
)The date and time when a pending payment session expires.
-
state (
PaymentSessionStates!
)Details about the payment state.
Mutations for PaymentSession
-
Change a payment session status to pending.
Upon receiving the response from the
PaymentSessionPending
mutation, you must redirect the customer back to Shopify, usingredirectUrl
innextAction
.Upon completion, pending payments must be finalized into either a successful or failed state using the
paymentSessionResolve
orpaymentSessionReject
mutations. Bothsale
andauthorization
payments can be marked as pending. -
Rejects an open payment session. After the
paymentSessionReject
mutation completes on a given payment session, anypaymentSessionResolve
mutation attempts will fail. SubsequentpaymentSessionReject
mutation attempts will succeed, but theRejectionReasonInput
argument will be ignored. -
Resolves an open payment session. After the
paymentSessionResolve
mutation completes on a given payment session, anypaymentSessionReject
mutation attempts will fail. SubsequentpaymentSessionResolve
mutation attempts will succeed, but theDetails
argument will be ignored.
Deprecated fields
-
status (
PaymentSessionStatus!
) deprecatedThe payment status. For pending status, use
state
.Deprecation warning
Deprecated in API Version 2022-04. Use
state
instead.
A unique payment transaction.
Required access
read_payment_sessions
access scope.
On this page
Fields
-
authorizationExpiresAt (
DateTime
)The date and time when an authorized payment session expires.
-
id (
ID!
)A globally-unique identifier.
-
nextAction (
PaymentSessionNextAction
)The next action expected by the partner.
-
pendingExpiresAt (
DateTime
)The date and time when a pending payment session expires.
-
state (
PaymentSessionStates!
)Details about the payment state.
Mutations for PaymentSession
-
Change a payment session status to pending.
Upon receiving the response from the
PaymentSessionPending
mutation, you must redirect the customer back to Shopify, usingredirectUrl
innextAction
.Upon completion, pending payments must be finalized into either a successful or failed state using the
paymentSessionResolve
orpaymentSessionReject
mutations. Bothsale
andauthorization
payments can be marked as pending. -
Rejects an open payment session. After the
paymentSessionReject
mutation completes on a given payment session, anypaymentSessionResolve
mutation attempts will fail. SubsequentpaymentSessionReject
mutation attempts will succeed, but theRejectionReasonInput
argument will be ignored. -
Resolves an open payment session. After the
paymentSessionResolve
mutation completes on a given payment session, anypaymentSessionReject
mutation attempts will fail. SubsequentpaymentSessionResolve
mutation attempts will succeed, but theDetails
argument will be ignored.
Deprecated fields
-
status (
PaymentSessionStatus!
) deprecatedThe payment status. For pending status, use
state
.Deprecation warning
Deprecated in API Version 2022-04. Use
state
instead.
A unique payment transaction.
Required access
read_payment_sessions
access scope.
On this page
Fields
-
authorizationExpiresAt (
DateTime
)The date and time when an authorized payment session expires.
-
id (
ID!
)A globally-unique identifier.
-
nextAction (
PaymentSessionNextAction
)The next action expected by the partner.
-
pendingExpiresAt (
DateTime
)The date and time when a pending payment session expires.
-
state (
PaymentSessionStates!
)Details about the payment state.
Mutations for PaymentSession
-
Change a payment session status to pending.
Upon receiving the response from the
PaymentSessionPending
mutation, you must redirect the customer back to Shopify, usingredirectUrl
innextAction
.Upon completion, pending payments must be finalized into either a successful or failed state using the
paymentSessionResolve
orpaymentSessionReject
mutations. Bothsale
andauthorization
payments can be marked as pending. -
Rejects an open payment session. After the
paymentSessionReject
mutation completes on a given payment session, anypaymentSessionResolve
mutation attempts will fail. SubsequentpaymentSessionReject
mutation attempts will succeed, but theRejectionReasonInput
argument will be ignored. -
Resolves an open payment session. After the
paymentSessionResolve
mutation completes on a given payment session, anypaymentSessionReject
mutation attempts will fail. SubsequentpaymentSessionResolve
mutation attempts will succeed, but theDetails
argument will be ignored.
Deprecated fields
-
status (
PaymentSessionStatus!
) deprecatedThe payment status. For pending status, use
state
.Deprecation warning
Deprecated in API Version 2022-04. Use
state
instead.
A unique payment transaction.
Required access
read_payment_sessions
access scope.
On this page
Fields
-
authorizationExpiresAt (
DateTime
)The date and time when an authorized payment session expires.
-
id (
ID!
)A globally-unique identifier.
-
nextAction (
PaymentSessionNextAction
)The next action expected by the partner.
Mutations for PaymentSession
-
Rejects an open payment session. After the
paymentSessionReject
mutation completes on a given payment session, anypaymentSessionResolve
mutation attempts will fail. SubsequentpaymentSessionReject
mutation attempts will succeed, but theRejectionReasonInput
argument will be ignored. -
Resolves an open payment session. After the
paymentSessionResolve
mutation completes on a given payment session, anypaymentSessionReject
mutation attempts will fail. SubsequentpaymentSessionResolve
mutation attempts will succeed, but theDetails
argument will be ignored.
Deprecated fields
-
status (
PaymentSessionStatus!
) deprecatedThe payment status. For pending status, use
state
.Deprecation warning
Deprecated in API Version 2022-04. Use
state
instead.
A unique payment transaction.
Required access
read_payment_sessions
access scope.
On this page
Fields
-
authorizationExpiresAt (
DateTime
)The date and time when an authorized payment session expires.
-
id (
ID!
)A globally-unique identifier.
-
nextAction (
PaymentSessionNextAction
)The next action expected by the partner.
Mutations for PaymentSession
-
Rejects an open payment session. After the
paymentSessionReject
mutation completes on a given payment session, anypaymentSessionResolve
mutation attempts will fail. SubsequentpaymentSessionReject
mutation attempts will succeed, but theRejectionReasonInput
argument will be ignored. -
Resolves an open payment session. After the
paymentSessionResolve
mutation completes on a given payment session, anypaymentSessionReject
mutation attempts will fail. SubsequentpaymentSessionResolve
mutation attempts will succeed, but theDetails
argument will be ignored.
Deprecated fields
-
status (
PaymentSessionStatus!
) deprecatedThe payment status. For pending status, use
state
.Deprecation warning
Deprecated in API Version 2022-04. Use
state
instead.