PaymentSession object

A unique payment transaction.

Required access

read_payment_sessions access scope.

Fields

  • authorizationExpiresAt (DateTime)

    The date and time when an authorized payment session expires.

  • id (ID!)

    A globally-unique identifier.

  • The next action expected of the partner.

  • pendingExpiresAt (DateTime)

    The date and time when a pending payment session expires.

  • 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, using redirectUrl in nextAction.

    Upon completion, pending payments must be finalized into either a successful or failed state using the paymentSessionResolve or paymentSessionReject mutations. Both sale and authorization payments can be marked as pending.

  • Rejects an open payment session. After the paymentSessionReject mutation completes on a given payment session, any paymentSessionResolve mutation attempts will fail. Subsequent paymentSessionReject mutation attempts will succeed, but the RejectionReasonInput argument will be ignored.

  • Resolves an open payment session. After the paymentSessionResolve mutation completes on a given payment session, any paymentSessionReject mutation attempts will fail. Subsequent paymentSessionResolve mutation attempts will succeed, but the Details argument will be ignored.

Deprecated fields

  • status (PaymentSessionStatus!) deprecated

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

Fields

  • authorizationExpiresAt (DateTime)

    The date and time when an authorized payment session expires.

  • id (ID!)

    A globally-unique identifier.

  • The next action expected of the partner.

  • pendingExpiresAt (DateTime)

    The date and time when a pending payment session expires.

  • 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, using redirectUrl in nextAction.

    Upon completion, pending payments must be finalized into either a successful or failed state using the paymentSessionResolve or paymentSessionReject mutations. Both sale and authorization payments can be marked as pending.

  • Rejects an open payment session. After the paymentSessionReject mutation completes on a given payment session, any paymentSessionResolve mutation attempts will fail. Subsequent paymentSessionReject mutation attempts will succeed, but the RejectionReasonInput argument will be ignored.

  • Resolves an open payment session. After the paymentSessionResolve mutation completes on a given payment session, any paymentSessionReject mutation attempts will fail. Subsequent paymentSessionResolve mutation attempts will succeed, but the Details argument will be ignored.

Deprecated fields

  • status (PaymentSessionStatus!) deprecated

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

Fields

  • authorizationExpiresAt (DateTime)

    The date and time when an authorized payment session expires.

  • id (ID!)

    A globally-unique identifier.

  • The next action expected of the partner.

  • pendingExpiresAt (DateTime)

    The date and time when a pending payment session expires.

  • 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, using redirectUrl in nextAction.

    Upon completion, pending payments must be finalized into either a successful or failed state using the paymentSessionResolve or paymentSessionReject mutations. Both sale and authorization payments can be marked as pending.

  • Rejects an open payment session. After the paymentSessionReject mutation completes on a given payment session, any paymentSessionResolve mutation attempts will fail. Subsequent paymentSessionReject mutation attempts will succeed, but the RejectionReasonInput argument will be ignored.

  • Resolves an open payment session. After the paymentSessionResolve mutation completes on a given payment session, any paymentSessionReject mutation attempts will fail. Subsequent paymentSessionResolve mutation attempts will succeed, but the Details argument will be ignored.

Deprecated fields

  • status (PaymentSessionStatus!) deprecated

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

Fields

  • authorizationExpiresAt (DateTime)

    The date and time when an authorized payment session expires.

  • id (ID!)

    A globally-unique identifier.

  • The next action expected of the partner.

  • pendingExpiresAt (DateTime)

    The date and time when a pending payment session expires.

  • 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, using redirectUrl in nextAction.

    Upon completion, pending payments must be finalized into either a successful or failed state using the paymentSessionResolve or paymentSessionReject mutations. Both sale and authorization payments can be marked as pending.

  • Rejects an open payment session. After the paymentSessionReject mutation completes on a given payment session, any paymentSessionResolve mutation attempts will fail. Subsequent paymentSessionReject mutation attempts will succeed, but the RejectionReasonInput argument will be ignored.

  • Resolves an open payment session. After the paymentSessionResolve mutation completes on a given payment session, any paymentSessionReject mutation attempts will fail. Subsequent paymentSessionResolve mutation attempts will succeed, but the Details argument will be ignored.

Deprecated fields

  • status (PaymentSessionStatus!) deprecated

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

Fields

  • authorizationExpiresAt (DateTime)

    The date and time when an authorized payment session expires.

  • id (ID!)

    A globally-unique identifier.

  • The next action expected of the partner.

  • pendingExpiresAt (DateTime)

    The date and time when a pending payment session expires.

  • 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, using redirectUrl in nextAction.

    Upon completion, pending payments must be finalized into either a successful or failed state using the paymentSessionResolve or paymentSessionReject mutations. Both sale and authorization payments can be marked as pending.

  • Rejects an open payment session. After the paymentSessionReject mutation completes on a given payment session, any paymentSessionResolve mutation attempts will fail. Subsequent paymentSessionReject mutation attempts will succeed, but the RejectionReasonInput argument will be ignored.

  • Resolves an open payment session. After the paymentSessionResolve mutation completes on a given payment session, any paymentSessionReject mutation attempts will fail. Subsequent paymentSessionResolve mutation attempts will succeed, but the Details argument will be ignored.

Deprecated fields

  • status (PaymentSessionStatus!) deprecated

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

Fields

  • authorizationExpiresAt (DateTime)

    The date and time when an authorized payment session expires.

  • id (ID!)

    A globally-unique identifier.

  • The next action expected of the partner.

Mutations for PaymentSession

  • Rejects an open payment session. After the paymentSessionReject mutation completes on a given payment session, any paymentSessionResolve mutation attempts will fail. Subsequent paymentSessionReject mutation attempts will succeed, but the RejectionReasonInput argument will be ignored.

  • Resolves an open payment session. After the paymentSessionResolve mutation completes on a given payment session, any paymentSessionReject mutation attempts will fail. Subsequent paymentSessionResolve mutation attempts will succeed, but the Details argument will be ignored.

Deprecated fields

  • status (PaymentSessionStatus!) deprecated

    The payment status. For pending status, use state.

    Deprecation warning

    Deprecated in API Version 2022-04. Use state instead.