# Payments Apps API The Payments Apps API enables you to programmatically access your payments app's configuration data. You can use the Payments Apps API to resolve, pend, or reject payments sessions. You can also use the Payments Apps API to reject or resolve captures, refunds, and void sessions. ## Authentication All Payments Apps API requests require a valid Shopify access token. Public and custom apps created in the Partner Dashboard generate tokens using [OAuth](/apps/auth/oauth). Include your token as a `X-Shopify-Access-Token` header on all API requests. To keep the platform secure, payments apps need to request specific [access scopes](/api/usage/access-scopes) during the install process. Only request as much data access as your app needs to work. All requests to the Payments Apps API must be authenticated. Learn more about [getting started with authentication](/apps/auth) and [building payments apps](/apps/payments). All Payments Apps API requests require a valid Shopify access token. Public and custom apps created in the Partner Dashboard generate tokens using [OAuth](/apps/auth/oauth). Include your token as a `X-Shopify-Access-Token` header on all API requests. To keep the platform secure, payments apps need to request specific [access scopes](/api/usage/access-scopes) during the install process. Only request as much data access as your app needs to work. All requests to the Payments Apps API must be authenticated. Learn more about [getting started with authentication](/apps/auth) and [building payments apps](/apps/payments). ### Code samples | Language | Code Sample | |----------|------------| | curl | ```bash curl -X POST \<br>https://{shop}.myshopify.com/payments_apps/api/2022-10/graphql.json \<br>-H 'Content-Type: application/json' \<br>-H 'X-Shopify-Access-Token: {password}' \<br>-d '{<br> "query": "{your_query}"<br>}'``` | ## GraphQL endpoint The Payments Apps API is available at a single GraphQL endpoint: The Payments Apps API is available at a single GraphQL endpoint: https://{shop_domain}/payments_apps/api/2022-10/graphql.json You can access the Payments Apps API using curl or any HTTP client. ### Versioning The Payments Apps API is a [versioned API](/api/usage/versioning). Updates are released quarterly. To keep your app stable, make sure that you specify a supported version in the URL. ### Usage limitations * The Payments Apps API is available only to [approved Payments Partners](/docs/apps/payments/payments-extension-review). * All apps and services connecting to the Payments Apps API are subject to Shopify's [API Terms of Service](https://www.shopify.com/legal/api-terms). * The Payments Apps API doesn't support sending additional information back to Shopify. ### Code samples | Language | Code Sample | |----------|------------| | curl | ```bash # Get the handles for all public API versions<br>curl -X POST \<br> https://{store_name}.myshopify.com/payments_apps/api/{API_VERSION}/graphql.json \<br> -H 'Content-Type: application/json' \<br> -H 'X-Shopify-Access-Token: {access_token}' \<br> -d '{<br> "query": "{<br> publicApiVersions {<br> handle<br> }<br> }"<br> }'``` | ## Rate limits The Payments Apps API enforces [rate limits](/api/usage/rate-limits) on all requests. The Payments Apps API enforces [rate limits](/api/usage/rate-limits) on all requests. ### Request ```graphql { products(first: 1) { edges { node { title } } } } ``` ### Response | Language | Code Sample | |----------|------------| | json | ```json {<br> "data": {<br> "products": {<br> "edges": [<br> {<br> "node": {<br> "title": "Hiking backpack"<br> }<br> }<br> ]<br> }<br> },<br> "extensions": {<br> "cost": {<br> "requestedQueryCost": 3,<br> "actualQueryCost": 3,<br> "throttleStatus": {<br> "maximumAvailable": 1000.0,<br> "currentlyAvailable": 997,<br> "restoreRate": 50.0<br> }<br> }<br> }<br>}``` | ## Status and error codes All API queries return HTTP status codes that contain more information about the response. All API queries return HTTP status codes that contain more information about the response.GraphQL HTTP status codes are different from REST API status codes. Most importantly, the GraphQL API can return a `200 OK` response code in cases that would typically produce 4xx or 5xx errors in REST.> NOTE: Didn’t find the status code you’re looking for? View the complete list of [API status response and error codes](/api/usage/response-codes). ### Sample 200 error responses | Language | Code Sample | |----------|------------| | Throttled | ```json {<br> "errors": [<br> {<br> "message": "Query cost is 2003, which exceeds the single query max cost limit (1000).<br><br>See https://shopify.dev/concepts/about-apis/rate-limits for more information on how the<br>cost of a query is calculated.<br><br>To query larger amounts of data with fewer limits, bulk operations should be used instead.<br>See https://shopify.dev/tutorials/perform-bulk-operations-with-admin-api for usage details.<br>",<br> "extensions": {<br> "code": "MAX_COST_EXCEEDED",<br> "cost": 2003,<br> "maxCost": 1000,<br> "documentation": "https://shopify.dev/api/usage/rate-limits"<br> }<br> }<br> ]<br>}``` | | Internal | ```json5 {<br> "errors": [<br> {<br> "message": "Internal error. Looks like something went wrong on our end.<br>Request ID: 1b355a21-7117-44c5-8d8b-8948082f40a8 (include this in support requests).",<br> "extensions": {<br> "code": "INTERNAL_SERVER_ERROR",<br> "requestId": "1b355a21-7117-44c5-8d8b-8948082f40a8"<br> }<br> }<br> ]<br> }``` | ### Sample error codes | Language | Code Sample | |----------|------------| | 400 | ```400 HTTP/1.1 400 Bad Request<br> {<br> "errors": {<br> "query": "Required parameter missing or invalid"<br> }<br> }``` | | 402 | ```402 HTTP/1.1 402 Payment Required<br> {<br> "errors": "This shop's plan does not have access to this feature"<br> }``` | | 403 | ```403 HTTP/1.1 403 Access Denied<br> {<br> "errors": "User does not have access"<br> }``` | | 404 | ```404 HTTP/1.1 404 Not Found<br> {<br> "errors": "Not Found"<br> }``` | | 423 | ```423 HTTP/1.1 423 Locked<br> {<br> "errors": "This shop is unavailable"<br> }``` | | 500 | ```500 HTTP/1.1 500 Internal Server Error<br> {<br> "errors": "An unexpected error occurred"<br> }``` | The response for the errors object contains additional detail to help you debug your operation. The response for mutations contains additional detail to help debug your query. To access this, you must request `userErrors`. #### Properties ##### THROTTLED The client has exceeded the [rate limit](#rate-limits). Similar to <span>429 Too Many Requests.</span> ##### ACCESS_DENIED The client doesn’t have correct [authentication](#authentication) credentials. Similar to <span>401 Unauthorized.</span> ##### SHOP_INACTIVE The shop is not active. This can happen when stores repeatedly exceed API rate limits or due to fraud risk. ##### INTERNAL_SERVER_ERROR Shopify experienced an internal error while processing the request. This error is returned instead of <span>500 Internal Server Error</span> in most circumstances. [{"title"=>"THROTTLED", "description"=>"The client has exceeded the [rate limit](#rate-limits). Similar to <span>429 Too Many Requests.</span>"}, {"title"=>"ACCESS_DENIED", "description"=>"The client doesn’t have correct [authentication](#authentication) credentials. Similar to <span>401 Unauthorized.</span>"}, {"title"=>"SHOP_INACTIVE", "description"=>"The shop is not active. This can happen when stores repeatedly exceed API rate limits or due to fraud risk."}, {"title"=>"INTERNAL_SERVER_ERROR", "description"=>"Shopify experienced an internal error while processing the request. This error is returned instead of <span>500 Internal Server Error</span> in most circumstances."}] #### 400 Bad Request The server will not process the request. #### 402 Payment Required The shop is frozen. The shop owner will need to pay the outstanding balance to [unfreeze](https://help.shopify.com/en/manual/your-account/pause-close-store#unfreeze-your-shopify-store) the shop. #### 403 Forbidden The shop is forbidden. Returned if the store has been marked as fraudulent. #### 404 Not Found The resource isn’t available. This is often caused by querying for something that’s been deleted. #### 423 Locked The shop isn’t available. This can happen when stores repeatedly exceed API rate limits or due to fraud risk. #### 5xx Errors An internal error occurred in Shopify. Check out the [Shopify status page](https://www.shopifystatus.com) for more information. [{"content"=>"#### 400 Bad Request\n\nThe server will not process the request."}, {"content"=>"#### 402 Payment Required\n\nThe shop is frozen. The shop owner will need to pay the outstanding balance to [unfreeze](https://help.shopify.com/en/manual/your-account/pause-close-store#unfreeze-your-shopify-store) the shop."}, {"content"=>"#### 403 Forbidden\n\nThe shop is forbidden. Returned if the store has been marked as fraudulent."}, {"content"=>"#### 404 Not Found\n\nThe resource isn’t available. This is often caused by querying for something that’s been deleted."}, {"content"=>"#### 423 Locked\n\nThe shop isn’t available. This can happen when stores repeatedly exceed API rate limits or due to fraud risk."}, {"content"=>"#### 5xx Errors\n\nAn internal error occurred in Shopify. Check out the [Shopify status page](https://www.shopifystatus.com) for more information."}] ## **unstable** API Reference - [ApiVersion](https://shopify.dev/docs/api/payments-apps/unstable/objects/ApiVersion.txt) - A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). Versions are commonly referred to by their handle (for example, `2021-10`). - [Boolean](https://shopify.dev/docs/api/payments-apps/unstable/scalars/Boolean.txt) - Represents `true` or `false` values. - [CaptureSession](https://shopify.dev/docs/api/payments-apps/unstable/objects/CaptureSession.txt) - Represents a unique capture transaction. - [CaptureSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/unstable/payloads/CaptureSessionRejectPayload.txt) - Return type for `captureSessionReject` mutation. - [CaptureSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/unstable/objects/CaptureSessionRejectUserError.txt) - An error that occurs during the execution of `CaptureSessionReject`. - [CaptureSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/CaptureSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `CaptureSessionRejectUserError`. - [CaptureSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/unstable/input-objects/CaptureSessionRejectionReasonInput.txt) - The input fields to use for the reason why the capture was rejected. - [CaptureSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/unstable/payloads/CaptureSessionResolvePayload.txt) - Return type for `captureSessionResolve` mutation. - [CaptureSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/unstable/objects/CaptureSessionResolveUserError.txt) - An error that occurs during the execution of `CaptureSessionResolve`. - [CaptureSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/CaptureSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `CaptureSessionResolveUserError`. - [CaptureSessionState](https://shopify.dev/docs/api/payments-apps/unstable/interfaces/CaptureSessionState.txt) - The state of a finalized capture transaction. - [CaptureSessionStateCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/CaptureSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized capture transaction. - [CaptureSessionStateRejected](https://shopify.dev/docs/api/payments-apps/unstable/objects/CaptureSessionStateRejected.txt) - Additional details about a capture's rejected state. - [CaptureSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/unstable/enums/CaptureSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why the capture transaction is rejected. - [CaptureSessionStateResolved](https://shopify.dev/docs/api/payments-apps/unstable/objects/CaptureSessionStateResolved.txt) - Additional details about a capture's resolved state. - [CaptureSessionStates](https://shopify.dev/docs/api/payments-apps/unstable/unions/CaptureSessionStates.txt) - The possible values that can be used to describe the state of a finalized capture transaction. - [CaptureSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/CaptureSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a capture transaction is rejected. - [DateTime](https://shopify.dev/docs/api/payments-apps/unstable/scalars/DateTime.txt) - Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date and time string. For example, 3:50 pm on September 7, 2019 in the time zone of UTC (Coordinated Universal Time) is represented as `"2019-09-07T15:50:00Z`". - [DigitalWallet](https://shopify.dev/docs/api/payments-apps/unstable/enums/DigitalWallet.txt) - Digital wallet, such as Apple Pay, which can be used for accelerated checkouts. - [DisplayableError](https://shopify.dev/docs/api/payments-apps/unstable/interfaces/DisplayableError.txt) - Represents an error in the input of a mutation. - [ID](https://shopify.dev/docs/api/payments-apps/unstable/scalars/ID.txt) - Represents a unique identifier, often used to refetch an object. The ID type appears in a JSON response as a String, but it is not intended to be human-readable. Example value: `"gid://shopify/Product/10079785100"` - [JSON](https://shopify.dev/docs/api/payments-apps/unstable/scalars/JSON.txt) - A [JSON](https://www.json.org/json-en.html) object. Example value: `{ "product": { "id": "gid://shopify/Product/1346443542550", "title": "White T-shirt", "options": [{ "name": "Size", "values": ["M", "L"] }] } }` - [ModalAction](https://shopify.dev/docs/api/payments-apps/unstable/input-objects/ModalAction.txt) - The input fields to capture action data from the provider, that will populate the buyer action modal. - [captureSessionReject](https://shopify.dev/docs/api/payments-apps/unstable/mutations/captureSessionReject.txt) - Rejects an open capture session. After the `captureSessionReject` mutation completes on a given capture session, any `captureSessionResolve` mutation attempts will fail. Subsequent `captureSessionReject` mutation attempts will succeed, but the `reason` argument will be ignored. - [captureSessionResolve](https://shopify.dev/docs/api/payments-apps/unstable/mutations/captureSessionResolve.txt) - Resolves an open capture session. After the `captureSessionResolve` mutation completes on a given capture session, any `captureSessionReject` mutation attempts will fail. Subsequent `captureSessionResolve` mutation attempts will succeed. - [paymentSessionConfirm](https://shopify.dev/docs/api/payments-apps/unstable/mutations/paymentSessionConfirm.txt) - Initiates the confirmation process of the given payment_session. Shopify will start confirming the payment. According to its business logic, Shopify determines if the payment can be authorized and sends a POST request to the payments app, delivering the confirmation result. - [paymentSessionModal](https://shopify.dev/docs/api/payments-apps/unstable/mutations/paymentSessionModal.txt) - Raises a modal that will be displayed to the buyer after a checkout is completed. Included data will be used to populate the UI extension in the modal. - [paymentSessionPending](https://shopify.dev/docs/api/payments-apps/unstable/mutations/paymentSessionPending.txt) - 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. - [paymentSessionRedirect](https://shopify.dev/docs/api/payments-apps/unstable/mutations/paymentSessionRedirect.txt) - Redirects the buyer to the given URL for the payment session. For example, Shopify will redirect the buyer to the URL where the 3DS authentication will take place for onsite payment with `credit_card` payment method. - [paymentSessionReject](https://shopify.dev/docs/api/payments-apps/unstable/mutations/paymentSessionReject.txt) - 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. - [paymentSessionResolve](https://shopify.dev/docs/api/payments-apps/unstable/mutations/paymentSessionResolve.txt) - 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. - [paymentsAppConfigure](https://shopify.dev/docs/api/payments-apps/unstable/mutations/paymentsAppConfigure.txt) - Configures the partner-managed payments gateway to work on the merchant's store. For an example of how to use the `paymentsAppConfigure` mutation, refer to the tutorial for [onboarding merchants to payments extensions](https://shopify.dev/docs/apps/build/payments/onboard-a-merchant-payments-extension). - [refundSessionReject](https://shopify.dev/docs/api/payments-apps/unstable/mutations/refundSessionReject.txt) - Rejects an open refund session. After the `refundSessionReject` mutation completes on a given refund session, any `refundSessionResolve` mutation attempts will fail. Subsequent `refundSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [refundSessionResolve](https://shopify.dev/docs/api/payments-apps/unstable/mutations/refundSessionResolve.txt) - Resolves an open refund session. After the `refundSessionResolve` mutation completes on a given refund session, any `refundSessionReject` mutation attempts will fail. Subsequent `refundSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [verificationSessionRedirect](https://shopify.dev/docs/api/payments-apps/unstable/mutations/verificationSessionRedirect.txt) - Redirects the buyer to the given URL for the verification session. Shopify will redirect the buyer to the URL where the 3DS authentication will take place when verifying the buyer's credit_card. - [verificationSessionReject](https://shopify.dev/docs/api/payments-apps/unstable/mutations/verificationSessionReject.txt) - Rejects an open verification session. After the `verificationSessionReject` mutation completes on a given verification session, any `verificationSessionResolve` mutation attempts will fail. Subsequent `verificationSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [verificationSessionResolve](https://shopify.dev/docs/api/payments-apps/unstable/mutations/verificationSessionResolve.txt) - Resolves an open verification session. After the `verificationSessionResolve` mutation completes on a given verification session, any `verificationSessionReject` mutation attempts will fail. Subsequent `verificationSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [voidSessionReject](https://shopify.dev/docs/api/payments-apps/unstable/mutations/voidSessionReject.txt) - Rejects an open void session. After the `voidSessionReject` mutation completes on a given void session, any `voidSessionResolve` mutation attempts will fail. Subsequent `voidSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [voidSessionResolve](https://shopify.dev/docs/api/payments-apps/unstable/mutations/voidSessionResolve.txt) - Resolves an open void session. After the `voidSessionResolve` mutation completes on a given void session, any `voidSessionReject` mutation attempts will fail. Subsequent `voidSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [PaymentSession](https://shopify.dev/docs/api/payments-apps/unstable/objects/PaymentSession.txt) - A unique payment transaction. - [PaymentSessionActionsRedirect](https://shopify.dev/docs/api/payments-apps/unstable/objects/PaymentSessionActionsRedirect.txt) - The payload required to redirect the customer to the shop after payment is finalized. - [PaymentSessionConfirmPayload](https://shopify.dev/docs/api/payments-apps/unstable/payloads/PaymentSessionConfirmPayload.txt) - Return type for `paymentSessionConfirm` mutation. - [PaymentSessionConfirmUserError](https://shopify.dev/docs/api/payments-apps/unstable/objects/PaymentSessionConfirmUserError.txt) - An error that occurs during the execution of `PaymentSessionConfirm`. - [PaymentSessionConfirmUserErrorCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/PaymentSessionConfirmUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionConfirmUserError`. - [PaymentSessionModalPayload](https://shopify.dev/docs/api/payments-apps/unstable/payloads/PaymentSessionModalPayload.txt) - Return type for `paymentSessionModal` mutation. - [PaymentSessionModalUserError](https://shopify.dev/docs/api/payments-apps/unstable/objects/PaymentSessionModalUserError.txt) - An error that occurs during the execution of `PaymentSessionModal`. - [PaymentSessionModalUserErrorCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/PaymentSessionModalUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionModalUserError`. - [PaymentSessionNextAction](https://shopify.dev/docs/api/payments-apps/unstable/objects/PaymentSessionNextAction.txt) - The next action that is expected of the Partner after the payment is finalized. - [PaymentSessionNextActionAction](https://shopify.dev/docs/api/payments-apps/unstable/enums/PaymentSessionNextActionAction.txt) - The possible values that can be used to describe the next action that a Partner should do after a payment is finalized. - [PaymentSessionNextActionContext](https://shopify.dev/docs/api/payments-apps/unstable/unions/PaymentSessionNextActionContext.txt) - The context required to perform an action. - [PaymentSessionPendingPayload](https://shopify.dev/docs/api/payments-apps/unstable/payloads/PaymentSessionPendingPayload.txt) - Return type for `paymentSessionPending` mutation. - [PaymentSessionPendingUserError](https://shopify.dev/docs/api/payments-apps/unstable/objects/PaymentSessionPendingUserError.txt) - Represents a payment session custom error. - [PaymentSessionPendingUserErrorCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/PaymentSessionPendingUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionPendingUserError`. - [PaymentSessionRedirectPayload](https://shopify.dev/docs/api/payments-apps/unstable/payloads/PaymentSessionRedirectPayload.txt) - Return type for `paymentSessionRedirect` mutation. - [PaymentSessionRedirectUserError](https://shopify.dev/docs/api/payments-apps/unstable/objects/PaymentSessionRedirectUserError.txt) - An error that occurs during the execution of `PaymentSessionRedirect`. - [PaymentSessionRedirectUserErrorCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/PaymentSessionRedirectUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionRedirectUserError`. - [PaymentSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/unstable/payloads/PaymentSessionRejectPayload.txt) - Return type for `paymentSessionReject` mutation. - [PaymentSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/unstable/input-objects/PaymentSessionRejectionReasonInput.txt) - The input fields for the reason why the payment was rejected. - [PaymentSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/unstable/payloads/PaymentSessionResolvePayload.txt) - Return type for `paymentSessionResolve` mutation. - [PaymentSessionState](https://shopify.dev/docs/api/payments-apps/unstable/interfaces/PaymentSessionState.txt) - The state of a payment transaction. - [PaymentSessionStateBuyerActionRequired](https://shopify.dev/docs/api/payments-apps/unstable/objects/PaymentSessionStateBuyerActionRequired.txt) - Buyer action required for the payment. - [PaymentSessionStateCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/PaymentSessionStateCode.txt) - The possible values that can be used to describe the state of a payment transaction. - [PaymentSessionStateConfirming](https://shopify.dev/docs/api/payments-apps/unstable/objects/PaymentSessionStateConfirming.txt) - Additional details about a payment's confirming state. - [PaymentSessionStatePending](https://shopify.dev/docs/api/payments-apps/unstable/objects/PaymentSessionStatePending.txt) - Additional details about a payment's pending state. - [PaymentSessionStatePendingReason](https://shopify.dev/docs/api/payments-apps/unstable/enums/PaymentSessionStatePendingReason.txt) - Reasons the finalization of the payment is pending. - [PaymentSessionStateRedirecting](https://shopify.dev/docs/api/payments-apps/unstable/objects/PaymentSessionStateRedirecting.txt) - Additional details about a payment's redirecting state. - [PaymentSessionStateRejected](https://shopify.dev/docs/api/payments-apps/unstable/objects/PaymentSessionStateRejected.txt) - Additional details about a payment's rejected state. - [PaymentSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/unstable/enums/PaymentSessionStateRejectedReason.txt) - The possible values that can be used to describe the reasons why a payment is rejected. - [PaymentSessionStateResolved](https://shopify.dev/docs/api/payments-apps/unstable/objects/PaymentSessionStateResolved.txt) - Additional details about a payment's resolved state. - [PaymentSessionStates](https://shopify.dev/docs/api/payments-apps/unstable/unions/PaymentSessionStates.txt) - The possible values that can be used to describe the state of a payment transaction. - [PaymentSessionThreeDSecureAuthentication](https://shopify.dev/docs/api/payments-apps/unstable/input-objects/PaymentSessionThreeDSecureAuthentication.txt) - The 3D Secure authentication data from the partner. One and only one of authentication_data and partner_error must be present. - [PaymentSessionThreeDSecureAuthenticationData](https://shopify.dev/docs/api/payments-apps/unstable/input-objects/PaymentSessionThreeDSecureAuthenticationData.txt) - The input fields for the 3D Secure authentication data from the partner. - [PaymentSessionThreeDSecureAuthenticationFlow](https://shopify.dev/docs/api/payments-apps/unstable/enums/PaymentSessionThreeDSecureAuthenticationFlow.txt) - The 3D Secure Authentication Flow. - [PaymentSessionThreeDSecureChargebackLiability](https://shopify.dev/docs/api/payments-apps/unstable/enums/PaymentSessionThreeDSecureChargebackLiability.txt) - Indicates if the liability for chargebacks has shifted away from the merchant. - [PaymentSessionThreeDSecurePartnerError](https://shopify.dev/docs/api/payments-apps/unstable/enums/PaymentSessionThreeDSecurePartnerError.txt) - The error that occurred in the partner environment while requesting the 3D Secure authentication or processing its result. - [PaymentSessionThreeDSecureTransStatus](https://shopify.dev/docs/api/payments-apps/unstable/enums/PaymentSessionThreeDSecureTransStatus.txt) - Indicates whether a transaction qualifies as an authenticated transaction. For 3DS version 2, the EMV 3D Secure transaction status from the last of the Authentication Response (ARes) or Results Request (RReq) messages. For 3DS version 1, the 3D Secure PARes Status. - [PaymentSessionThreeDSecureVersion](https://shopify.dev/docs/api/payments-apps/unstable/enums/PaymentSessionThreeDSecureVersion.txt) - The 3D Secure version. - [PaymentsAppConfiguration](https://shopify.dev/docs/api/payments-apps/unstable/objects/PaymentsAppConfiguration.txt) - The [production configuration](https://shopify.dev/apps/payments/onboarding-a-merchant-payments-apps) of the payments app. - [PaymentsAppConfigurePayload](https://shopify.dev/docs/api/payments-apps/unstable/payloads/PaymentsAppConfigurePayload.txt) - Return type for `paymentsAppConfigure` mutation. - [QrCode](https://shopify.dev/docs/api/payments-apps/unstable/input-objects/QrCode.txt) - The input fields will be used to render a QR code that the buyer will scan. - [QueryRoot](https://shopify.dev/docs/api/payments-apps/unstable/objects/QueryRoot.txt) - The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. - [publicApiVersions](https://shopify.dev/docs/api/payments-apps/unstable/queries/publicApiVersions.txt) - The list of public Payments Apps API versions, including supported, release candidate and unstable versions. - [RefundSession](https://shopify.dev/docs/api/payments-apps/unstable/objects/RefundSession.txt) - A unique refund transaction. - [RefundSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/unstable/payloads/RefundSessionRejectPayload.txt) - Return type for `refundSessionReject` mutation. - [RefundSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/unstable/objects/RefundSessionRejectUserError.txt) - An error that occurs during the execution of `RefundSessionReject`. - [RefundSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/RefundSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `RefundSessionRejectUserError`. - [RefundSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/unstable/input-objects/RefundSessionRejectionReasonInput.txt) - The input fields for the reason why the refund was rejected. - [RefundSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/unstable/payloads/RefundSessionResolvePayload.txt) - Return type for `refundSessionResolve` mutation. - [RefundSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/unstable/objects/RefundSessionResolveUserError.txt) - An error that occurs during the execution of `RefundSessionResolve`. - [RefundSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/RefundSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `RefundSessionResolveUserError`. - [RefundSessionState](https://shopify.dev/docs/api/payments-apps/unstable/interfaces/RefundSessionState.txt) - The State of a finalized refund transaction. - [RefundSessionStateCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/RefundSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized refund transaction. - [RefundSessionStateRejected](https://shopify.dev/docs/api/payments-apps/unstable/objects/RefundSessionStateRejected.txt) - Additional details about a refund's rejected state. - [RefundSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/unstable/enums/RefundSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why the refund is rejected. - [RefundSessionStateResolved](https://shopify.dev/docs/api/payments-apps/unstable/objects/RefundSessionStateResolved.txt) - Additional details about a refund's resolved state. - [RefundSessionStates](https://shopify.dev/docs/api/payments-apps/unstable/unions/RefundSessionStates.txt) - The possible values that can be used to describe the state of a finalized refund transaction. - [RefundSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/RefundSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a refund transaction was rejected. - [String](https://shopify.dev/docs/api/payments-apps/unstable/scalars/String.txt) - Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. - [URL](https://shopify.dev/docs/api/payments-apps/unstable/scalars/URL.txt) - Represents an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string. For example, `"https://example.myshopify.com"` is a valid URL. It includes a scheme (`https`) and a host (`example.myshopify.com`). - [UserError](https://shopify.dev/docs/api/payments-apps/unstable/objects/UserError.txt) - Represents an error in the input of a mutation. - [VerificationSession](https://shopify.dev/docs/api/payments-apps/unstable/objects/VerificationSession.txt) - A unique verification transaction. - [VerificationSessionActionsRedirect](https://shopify.dev/docs/api/payments-apps/unstable/objects/VerificationSessionActionsRedirect.txt) - The payload required to redirect the customer to the shop after verification is finalized. - [VerificationSessionAddressInput](https://shopify.dev/docs/api/payments-apps/unstable/input-objects/VerificationSessionAddressInput.txt) - The input fields for the address. - [VerificationSessionCardBrandInput](https://shopify.dev/docs/api/payments-apps/unstable/enums/VerificationSessionCardBrandInput.txt) - Card brand, such as Visa or Mastercard, which can be used for payments. - [VerificationSessionCardInput](https://shopify.dev/docs/api/payments-apps/unstable/input-objects/VerificationSessionCardInput.txt) - The input fields for the credit card. - [VerificationSessionNextAction](https://shopify.dev/docs/api/payments-apps/unstable/objects/VerificationSessionNextAction.txt) - The next action that is expected of the Partner after the verification is finalized. - [VerificationSessionNextActionAction](https://shopify.dev/docs/api/payments-apps/unstable/enums/VerificationSessionNextActionAction.txt) - The possible values that can be used to describe the next action that a Partner should do after a verification is finalized. - [VerificationSessionNextActionContext](https://shopify.dev/docs/api/payments-apps/unstable/unions/VerificationSessionNextActionContext.txt) - The context required to perform an action. - [VerificationSessionPaymentDetailsInput](https://shopify.dev/docs/api/payments-apps/unstable/input-objects/VerificationSessionPaymentDetailsInput.txt) - The input fields for the payment details. - [VerificationSessionRedirectPayload](https://shopify.dev/docs/api/payments-apps/unstable/payloads/VerificationSessionRedirectPayload.txt) - Return type for `verificationSessionRedirect` mutation. - [VerificationSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/unstable/payloads/VerificationSessionRejectPayload.txt) - Return type for `verificationSessionReject` mutation. - [VerificationSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/unstable/input-objects/VerificationSessionRejectionReasonInput.txt) - The input fields for the reason why the verification was rejected. - [VerificationSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/unstable/payloads/VerificationSessionResolvePayload.txt) - Return type for `verificationSessionResolve` mutation. - [VerificationSessionState](https://shopify.dev/docs/api/payments-apps/unstable/interfaces/VerificationSessionState.txt) - The state of a verification transaction. - [VerificationSessionStateCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/VerificationSessionStateCode.txt) - The possible values that can be used to describe the state of a verification transaction. - [VerificationSessionStateReason](https://shopify.dev/docs/api/payments-apps/unstable/enums/VerificationSessionStateReason.txt) - The possible values that can be used to describe the reasons why a verification is rejected. - [VerificationSessionStateRedirecting](https://shopify.dev/docs/api/payments-apps/unstable/objects/VerificationSessionStateRedirecting.txt) - Additional details about a verification's redirecting state. - [VerificationSessionStateRejected](https://shopify.dev/docs/api/payments-apps/unstable/objects/VerificationSessionStateRejected.txt) - Additional details about a verification's rejected state. - [VerificationSessionStateResolved](https://shopify.dev/docs/api/payments-apps/unstable/objects/VerificationSessionStateResolved.txt) - Additional details about a verification's resolved state. - [VerificationSessionStates](https://shopify.dev/docs/api/payments-apps/unstable/unions/VerificationSessionStates.txt) - The possible values that can be used to describe the state of a verification transaction. - [VerificationSessionThreeDSecureAuthentication](https://shopify.dev/docs/api/payments-apps/unstable/input-objects/VerificationSessionThreeDSecureAuthentication.txt) - The 3D Secure authentication data from the partner. One and only one of authentication_data and partner_error must be present. - [VerificationSessionThreeDSecureAuthenticationData](https://shopify.dev/docs/api/payments-apps/unstable/input-objects/VerificationSessionThreeDSecureAuthenticationData.txt) - The input fields for the 3D Secure authentication data from the partner. - [VerificationSessionThreeDSecureAuthenticationFlow](https://shopify.dev/docs/api/payments-apps/unstable/enums/VerificationSessionThreeDSecureAuthenticationFlow.txt) - The 3D Secure Authentication Flow. - [VerificationSessionThreeDSecureChargebackLiability](https://shopify.dev/docs/api/payments-apps/unstable/enums/VerificationSessionThreeDSecureChargebackLiability.txt) - Indicates if the liability for chargebacks has shifted away from the merchant. - [VerificationSessionThreeDSecurePartnerError](https://shopify.dev/docs/api/payments-apps/unstable/enums/VerificationSessionThreeDSecurePartnerError.txt) - The error that occurred in the partner environment while requesting the 3D Secure authentication or processing its result. - [VerificationSessionThreeDSecureTransStatus](https://shopify.dev/docs/api/payments-apps/unstable/enums/VerificationSessionThreeDSecureTransStatus.txt) - Indicates whether a transaction qualifies as an authenticated transaction. For 3DS version 2, the EMV 3D Secure transaction status from the last of the Authentication Response (ARes) or Results Request (RReq) messages. For 3DS version 1, the 3D Secure PARes Status. - [VerificationSessionThreeDSecureVersion](https://shopify.dev/docs/api/payments-apps/unstable/enums/VerificationSessionThreeDSecureVersion.txt) - The 3D Secure version. - [VerificationSessionUserError](https://shopify.dev/docs/api/payments-apps/unstable/objects/VerificationSessionUserError.txt) - Represents a verification session custom error. - [VerificationSessionUserErrorCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/VerificationSessionUserErrorCode.txt) - Possible error codes that can be returned by `VerificationSessionUserError`. - [VoidSession](https://shopify.dev/docs/api/payments-apps/unstable/objects/VoidSession.txt) - A unique void transaction. - [VoidSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/unstable/payloads/VoidSessionRejectPayload.txt) - Return type for `voidSessionReject` mutation. - [VoidSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/unstable/objects/VoidSessionRejectUserError.txt) - An error that occurs during the execution of `VoidSessionReject`. - [VoidSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/VoidSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `VoidSessionRejectUserError`. - [VoidSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/unstable/input-objects/VoidSessionRejectionReasonInput.txt) - The input fields for the reason why the void transaction was rejected. - [VoidSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/unstable/payloads/VoidSessionResolvePayload.txt) - Return type for `voidSessionResolve` mutation. - [VoidSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/unstable/objects/VoidSessionResolveUserError.txt) - An error that occurs during the execution of `VoidSessionResolve`. - [VoidSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/VoidSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `VoidSessionResolveUserError`. - [VoidSessionState](https://shopify.dev/docs/api/payments-apps/unstable/interfaces/VoidSessionState.txt) - The state of a finalized void transaction. - [VoidSessionStateCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/VoidSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized void transaction. - [VoidSessionStateRejected](https://shopify.dev/docs/api/payments-apps/unstable/objects/VoidSessionStateRejected.txt) - Additional details about a void's rejected state. - [VoidSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/unstable/enums/VoidSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why a void transaction is rejected. - [VoidSessionStateResolved](https://shopify.dev/docs/api/payments-apps/unstable/objects/VoidSessionStateResolved.txt) - Additional details about a void's resolved state. - [VoidSessionStates](https://shopify.dev/docs/api/payments-apps/unstable/unions/VoidSessionStates.txt) - The possible values that can be used to describe the state of a finalized void transaction. - [VoidSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/unstable/enums/VoidSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a void transaction is rejected. - [__Directive](https://shopify.dev/docs/api/payments-apps/unstable/objects/__Directive.txt) - A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor. - [__DirectiveLocation](https://shopify.dev/docs/api/payments-apps/unstable/enums/__DirectiveLocation.txt) - A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies. - [__EnumValue](https://shopify.dev/docs/api/payments-apps/unstable/objects/__EnumValue.txt) - One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string. - [__Field](https://shopify.dev/docs/api/payments-apps/unstable/objects/__Field.txt) - Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type. - [__InputValue](https://shopify.dev/docs/api/payments-apps/unstable/objects/__InputValue.txt) - Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value. - [__Schema](https://shopify.dev/docs/api/payments-apps/unstable/objects/__Schema.txt) - A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations. - [__Type](https://shopify.dev/docs/api/payments-apps/unstable/objects/__Type.txt) - The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types. - [__TypeKind](https://shopify.dev/docs/api/payments-apps/unstable/enums/__TypeKind.txt) - An enum describing what kind of type a given `__Type` is. ## **2024-10** API Reference - [ApiVersion](https://shopify.dev/docs/api/payments-apps/2024-10/objects/ApiVersion.txt) - A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). Versions are commonly referred to by their handle (for example, `2021-10`). - [Boolean](https://shopify.dev/docs/api/payments-apps/2024-10/scalars/Boolean.txt) - Represents `true` or `false` values. - [CaptureSession](https://shopify.dev/docs/api/payments-apps/2024-10/objects/CaptureSession.txt) - Represents a unique capture transaction. - [CaptureSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2024-10/payloads/CaptureSessionRejectPayload.txt) - Return type for `captureSessionReject` mutation. - [CaptureSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2024-10/objects/CaptureSessionRejectUserError.txt) - An error that occurs during the execution of `CaptureSessionReject`. - [CaptureSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/CaptureSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `CaptureSessionRejectUserError`. - [CaptureSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2024-10/input-objects/CaptureSessionRejectionReasonInput.txt) - The input fields to use for the reason why the capture was rejected. - [CaptureSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2024-10/payloads/CaptureSessionResolvePayload.txt) - Return type for `captureSessionResolve` mutation. - [CaptureSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2024-10/objects/CaptureSessionResolveUserError.txt) - An error that occurs during the execution of `CaptureSessionResolve`. - [CaptureSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/CaptureSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `CaptureSessionResolveUserError`. - [CaptureSessionState](https://shopify.dev/docs/api/payments-apps/2024-10/interfaces/CaptureSessionState.txt) - The state of a finalized capture transaction. - [CaptureSessionStateCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/CaptureSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized capture transaction. - [CaptureSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2024-10/objects/CaptureSessionStateRejected.txt) - Additional details about a capture's rejected state. - [CaptureSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2024-10/enums/CaptureSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why the capture transaction is rejected. - [CaptureSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2024-10/objects/CaptureSessionStateResolved.txt) - Additional details about a capture's resolved state. - [CaptureSessionStates](https://shopify.dev/docs/api/payments-apps/2024-10/unions/CaptureSessionStates.txt) - The possible values that can be used to describe the state of a finalized capture transaction. - [CaptureSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/CaptureSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a capture transaction is rejected. - [DateTime](https://shopify.dev/docs/api/payments-apps/2024-10/scalars/DateTime.txt) - Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date and time string. For example, 3:50 pm on September 7, 2019 in the time zone of UTC (Coordinated Universal Time) is represented as `"2019-09-07T15:50:00Z`". - [DisplayableError](https://shopify.dev/docs/api/payments-apps/2024-10/interfaces/DisplayableError.txt) - Represents an error in the input of a mutation. - [ID](https://shopify.dev/docs/api/payments-apps/2024-10/scalars/ID.txt) - Represents a unique identifier, often used to refetch an object. The ID type appears in a JSON response as a String, but it is not intended to be human-readable. Example value: `"gid://shopify/Product/10079785100"` - [captureSessionReject](https://shopify.dev/docs/api/payments-apps/2024-10/mutations/captureSessionReject.txt) - Rejects an open capture session. After the `captureSessionReject` mutation completes on a given capture session, any `captureSessionResolve` mutation attempts will fail. Subsequent `captureSessionReject` mutation attempts will succeed, but the `reason` argument will be ignored. - [captureSessionResolve](https://shopify.dev/docs/api/payments-apps/2024-10/mutations/captureSessionResolve.txt) - Resolves an open capture session. After the `captureSessionResolve` mutation completes on a given capture session, any `captureSessionReject` mutation attempts will fail. Subsequent `captureSessionResolve` mutation attempts will succeed. - [paymentSessionConfirm](https://shopify.dev/docs/api/payments-apps/2024-10/mutations/paymentSessionConfirm.txt) - Initiates the confirmation process of the given payment_session. Shopify will start confirming the payment. According to its business logic, Shopify determines if the payment can be authorized and sends a POST request to the payments app, delivering the confirmation result. - [paymentSessionPending](https://shopify.dev/docs/api/payments-apps/2024-10/mutations/paymentSessionPending.txt) - 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. - [paymentSessionRedirect](https://shopify.dev/docs/api/payments-apps/2024-10/mutations/paymentSessionRedirect.txt) - Redirects the buyer to the given URL for the payment session. For example, Shopify will redirect the buyer to the URL where the 3DS authentication will take place for onsite payment with `credit_card` payment method. - [paymentSessionReject](https://shopify.dev/docs/api/payments-apps/2024-10/mutations/paymentSessionReject.txt) - 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. - [paymentSessionResolve](https://shopify.dev/docs/api/payments-apps/2024-10/mutations/paymentSessionResolve.txt) - 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. - [paymentsAppConfigure](https://shopify.dev/docs/api/payments-apps/2024-10/mutations/paymentsAppConfigure.txt) - Configures the partner-managed payments gateway to work on the merchant's store. For an example of how to use the `paymentsAppConfigure` mutation, refer to the tutorial for [onboarding merchants to payments extensions](https://shopify.dev/docs/apps/build/payments/onboard-a-merchant-payments-extension). - [refundSessionReject](https://shopify.dev/docs/api/payments-apps/2024-10/mutations/refundSessionReject.txt) - Rejects an open refund session. After the `refundSessionReject` mutation completes on a given refund session, any `refundSessionResolve` mutation attempts will fail. Subsequent `refundSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [refundSessionResolve](https://shopify.dev/docs/api/payments-apps/2024-10/mutations/refundSessionResolve.txt) - Resolves an open refund session. After the `refundSessionResolve` mutation completes on a given refund session, any `refundSessionReject` mutation attempts will fail. Subsequent `refundSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [verificationSessionReject](https://shopify.dev/docs/api/payments-apps/2024-10/mutations/verificationSessionReject.txt) - Rejects an open verification session. After the `verificationSessionReject` mutation completes on a given verification session, any `verificationSessionResolve` mutation attempts will fail. Subsequent `verificationSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [verificationSessionResolve](https://shopify.dev/docs/api/payments-apps/2024-10/mutations/verificationSessionResolve.txt) - Resolves an open verification session. After the `verificationSessionResolve` mutation completes on a given verification session, any `verificationSessionReject` mutation attempts will fail. Subsequent `verificationSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [voidSessionReject](https://shopify.dev/docs/api/payments-apps/2024-10/mutations/voidSessionReject.txt) - Rejects an open void session. After the `voidSessionReject` mutation completes on a given void session, any `voidSessionResolve` mutation attempts will fail. Subsequent `voidSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [voidSessionResolve](https://shopify.dev/docs/api/payments-apps/2024-10/mutations/voidSessionResolve.txt) - Resolves an open void session. After the `voidSessionResolve` mutation completes on a given void session, any `voidSessionReject` mutation attempts will fail. Subsequent `voidSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [PaymentSession](https://shopify.dev/docs/api/payments-apps/2024-10/objects/PaymentSession.txt) - A unique payment transaction. - [PaymentSessionActionsRedirect](https://shopify.dev/docs/api/payments-apps/2024-10/objects/PaymentSessionActionsRedirect.txt) - The payload required to redirect the customer to the shop after payment is finalized. - [PaymentSessionConfirmPayload](https://shopify.dev/docs/api/payments-apps/2024-10/payloads/PaymentSessionConfirmPayload.txt) - Return type for `paymentSessionConfirm` mutation. - [PaymentSessionConfirmUserError](https://shopify.dev/docs/api/payments-apps/2024-10/objects/PaymentSessionConfirmUserError.txt) - An error that occurs during the execution of `PaymentSessionConfirm`. - [PaymentSessionConfirmUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/PaymentSessionConfirmUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionConfirmUserError`. - [PaymentSessionNextAction](https://shopify.dev/docs/api/payments-apps/2024-10/objects/PaymentSessionNextAction.txt) - The next action that is expected of the Partner after the payment is finalized. - [PaymentSessionNextActionAction](https://shopify.dev/docs/api/payments-apps/2024-10/enums/PaymentSessionNextActionAction.txt) - The possible values that can be used to describe the next action that a Partner should do after a payment is finalized. - [PaymentSessionNextActionContext](https://shopify.dev/docs/api/payments-apps/2024-10/unions/PaymentSessionNextActionContext.txt) - The context required to perform an action. - [PaymentSessionPendingPayload](https://shopify.dev/docs/api/payments-apps/2024-10/payloads/PaymentSessionPendingPayload.txt) - Return type for `paymentSessionPending` mutation. - [PaymentSessionPendingUserError](https://shopify.dev/docs/api/payments-apps/2024-10/objects/PaymentSessionPendingUserError.txt) - Represents a payment session custom error. - [PaymentSessionPendingUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/PaymentSessionPendingUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionPendingUserError`. - [PaymentSessionRedirectPayload](https://shopify.dev/docs/api/payments-apps/2024-10/payloads/PaymentSessionRedirectPayload.txt) - Return type for `paymentSessionRedirect` mutation. - [PaymentSessionRedirectUserError](https://shopify.dev/docs/api/payments-apps/2024-10/objects/PaymentSessionRedirectUserError.txt) - An error that occurs during the execution of `PaymentSessionRedirect`. - [PaymentSessionRedirectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/PaymentSessionRedirectUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionRedirectUserError`. - [PaymentSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2024-10/payloads/PaymentSessionRejectPayload.txt) - Return type for `paymentSessionReject` mutation. - [PaymentSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2024-10/input-objects/PaymentSessionRejectionReasonInput.txt) - The input fields for the reason why the payment was rejected. - [PaymentSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2024-10/payloads/PaymentSessionResolvePayload.txt) - Return type for `paymentSessionResolve` mutation. - [PaymentSessionState](https://shopify.dev/docs/api/payments-apps/2024-10/interfaces/PaymentSessionState.txt) - The state of a payment transaction. - [PaymentSessionStateCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/PaymentSessionStateCode.txt) - The possible values that can be used to describe the state of a payment transaction. - [PaymentSessionStateConfirming](https://shopify.dev/docs/api/payments-apps/2024-10/objects/PaymentSessionStateConfirming.txt) - Additional details about a payment's confirming state. - [PaymentSessionStatePending](https://shopify.dev/docs/api/payments-apps/2024-10/objects/PaymentSessionStatePending.txt) - Additional details about a payment's pending state. - [PaymentSessionStatePendingReason](https://shopify.dev/docs/api/payments-apps/2024-10/enums/PaymentSessionStatePendingReason.txt) - Reasons the finalization of the payment is pending. - [PaymentSessionStateRedirecting](https://shopify.dev/docs/api/payments-apps/2024-10/objects/PaymentSessionStateRedirecting.txt) - Additional details about a payment's redirecting state. - [PaymentSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2024-10/objects/PaymentSessionStateRejected.txt) - Additional details about a payment's rejected state. - [PaymentSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2024-10/enums/PaymentSessionStateRejectedReason.txt) - The possible values that can be used to describe the reasons why a payment is rejected. - [PaymentSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2024-10/objects/PaymentSessionStateResolved.txt) - Additional details about a payment's resolved state. - [PaymentSessionStates](https://shopify.dev/docs/api/payments-apps/2024-10/unions/PaymentSessionStates.txt) - The possible values that can be used to describe the state of a payment transaction. - [PaymentSessionThreeDSecureAuthentication](https://shopify.dev/docs/api/payments-apps/2024-10/input-objects/PaymentSessionThreeDSecureAuthentication.txt) - The 3D Secure authentication data from the partner. One and only one of authentication_data and partner_error must be present. - [PaymentSessionThreeDSecureAuthenticationData](https://shopify.dev/docs/api/payments-apps/2024-10/input-objects/PaymentSessionThreeDSecureAuthenticationData.txt) - The input fields for the 3D Secure authentication data from the partner. - [PaymentSessionThreeDSecureAuthenticationFlow](https://shopify.dev/docs/api/payments-apps/2024-10/enums/PaymentSessionThreeDSecureAuthenticationFlow.txt) - The 3D Secure Authentication Flow. - [PaymentSessionThreeDSecureChargebackLiability](https://shopify.dev/docs/api/payments-apps/2024-10/enums/PaymentSessionThreeDSecureChargebackLiability.txt) - Indicates if the liability for chargebacks has shifted away from the merchant. - [PaymentSessionThreeDSecurePartnerError](https://shopify.dev/docs/api/payments-apps/2024-10/enums/PaymentSessionThreeDSecurePartnerError.txt) - The error that occurred in the partner environment while requesting the 3D Secure authentication or processing its result. - [PaymentSessionThreeDSecureTransStatus](https://shopify.dev/docs/api/payments-apps/2024-10/enums/PaymentSessionThreeDSecureTransStatus.txt) - Indicates whether a transaction qualifies as an authenticated transaction. For 3DS version 2, the EMV 3D Secure transaction status from the last of the Authentication Response (ARes) or Results Request (RReq) messages. For 3DS version 1, the 3D Secure PARes Status. - [PaymentSessionThreeDSecureVersion](https://shopify.dev/docs/api/payments-apps/2024-10/enums/PaymentSessionThreeDSecureVersion.txt) - The 3D Secure version. - [PaymentsAppConfiguration](https://shopify.dev/docs/api/payments-apps/2024-10/objects/PaymentsAppConfiguration.txt) - The [production configuration](https://shopify.dev/apps/payments/onboarding-a-merchant-payments-apps) of the payments app. - [PaymentsAppConfigurePayload](https://shopify.dev/docs/api/payments-apps/2024-10/payloads/PaymentsAppConfigurePayload.txt) - Return type for `paymentsAppConfigure` mutation. - [QueryRoot](https://shopify.dev/docs/api/payments-apps/2024-10/objects/QueryRoot.txt) - The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. - [publicApiVersions](https://shopify.dev/docs/api/payments-apps/2024-10/queries/publicApiVersions.txt) - The list of public Payments Apps API versions, including supported, release candidate and unstable versions. - [RefundSession](https://shopify.dev/docs/api/payments-apps/2024-10/objects/RefundSession.txt) - A unique refund transaction. - [RefundSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2024-10/payloads/RefundSessionRejectPayload.txt) - Return type for `refundSessionReject` mutation. - [RefundSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2024-10/objects/RefundSessionRejectUserError.txt) - An error that occurs during the execution of `RefundSessionReject`. - [RefundSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/RefundSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `RefundSessionRejectUserError`. - [RefundSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2024-10/input-objects/RefundSessionRejectionReasonInput.txt) - The input fields for the reason why the refund was rejected. - [RefundSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2024-10/payloads/RefundSessionResolvePayload.txt) - Return type for `refundSessionResolve` mutation. - [RefundSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2024-10/objects/RefundSessionResolveUserError.txt) - An error that occurs during the execution of `RefundSessionResolve`. - [RefundSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/RefundSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `RefundSessionResolveUserError`. - [RefundSessionState](https://shopify.dev/docs/api/payments-apps/2024-10/interfaces/RefundSessionState.txt) - The State of a finalized refund transaction. - [RefundSessionStateCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/RefundSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized refund transaction. - [RefundSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2024-10/objects/RefundSessionStateRejected.txt) - Additional details about a refund's rejected state. - [RefundSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2024-10/enums/RefundSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why the refund is rejected. - [RefundSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2024-10/objects/RefundSessionStateResolved.txt) - Additional details about a refund's resolved state. - [RefundSessionStates](https://shopify.dev/docs/api/payments-apps/2024-10/unions/RefundSessionStates.txt) - The possible values that can be used to describe the state of a finalized refund transaction. - [RefundSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/RefundSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a refund transaction was rejected. - [String](https://shopify.dev/docs/api/payments-apps/2024-10/scalars/String.txt) - Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. - [URL](https://shopify.dev/docs/api/payments-apps/2024-10/scalars/URL.txt) - Represents an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string. For example, `"https://example.myshopify.com"` is a valid URL. It includes a scheme (`https`) and a host (`example.myshopify.com`). - [UserError](https://shopify.dev/docs/api/payments-apps/2024-10/objects/UserError.txt) - Represents an error in the input of a mutation. - [VerificationSession](https://shopify.dev/docs/api/payments-apps/2024-10/objects/VerificationSession.txt) - A unique verification transaction. - [VerificationSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2024-10/payloads/VerificationSessionRejectPayload.txt) - Return type for `verificationSessionReject` mutation. - [VerificationSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2024-10/input-objects/VerificationSessionRejectionReasonInput.txt) - The input fields for the reason why the verification was rejected. - [VerificationSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2024-10/payloads/VerificationSessionResolvePayload.txt) - Return type for `verificationSessionResolve` mutation. - [VerificationSessionState](https://shopify.dev/docs/api/payments-apps/2024-10/interfaces/VerificationSessionState.txt) - The state of a verification transaction. - [VerificationSessionStateCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/VerificationSessionStateCode.txt) - The possible values that can be used to describe the state of a verification transaction. - [VerificationSessionStateReason](https://shopify.dev/docs/api/payments-apps/2024-10/enums/VerificationSessionStateReason.txt) - The possible values that can be used to describe the reasons why a verification is rejected. - [VerificationSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2024-10/objects/VerificationSessionStateRejected.txt) - Additional details about a verification's rejected state. - [VerificationSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2024-10/objects/VerificationSessionStateResolved.txt) - Additional details about a verification's resolved state. - [VerificationSessionStates](https://shopify.dev/docs/api/payments-apps/2024-10/unions/VerificationSessionStates.txt) - The possible values that can be used to describe the state of a verification transaction. - [VerificationSessionUserError](https://shopify.dev/docs/api/payments-apps/2024-10/objects/VerificationSessionUserError.txt) - Represents a verification session custom error. - [VerificationSessionUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/VerificationSessionUserErrorCode.txt) - Possible error codes that can be returned by `VerificationSessionUserError`. - [VoidSession](https://shopify.dev/docs/api/payments-apps/2024-10/objects/VoidSession.txt) - A unique void transaction. - [VoidSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2024-10/payloads/VoidSessionRejectPayload.txt) - Return type for `voidSessionReject` mutation. - [VoidSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2024-10/objects/VoidSessionRejectUserError.txt) - An error that occurs during the execution of `VoidSessionReject`. - [VoidSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/VoidSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `VoidSessionRejectUserError`. - [VoidSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2024-10/input-objects/VoidSessionRejectionReasonInput.txt) - The input fields for the reason why the void transaction was rejected. - [VoidSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2024-10/payloads/VoidSessionResolvePayload.txt) - Return type for `voidSessionResolve` mutation. - [VoidSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2024-10/objects/VoidSessionResolveUserError.txt) - An error that occurs during the execution of `VoidSessionResolve`. - [VoidSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/VoidSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `VoidSessionResolveUserError`. - [VoidSessionState](https://shopify.dev/docs/api/payments-apps/2024-10/interfaces/VoidSessionState.txt) - The state of a finalized void transaction. - [VoidSessionStateCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/VoidSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized void transaction. - [VoidSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2024-10/objects/VoidSessionStateRejected.txt) - Additional details about a void's rejected state. - [VoidSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2024-10/enums/VoidSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why a void transaction is rejected. - [VoidSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2024-10/objects/VoidSessionStateResolved.txt) - Additional details about a void's resolved state. - [VoidSessionStates](https://shopify.dev/docs/api/payments-apps/2024-10/unions/VoidSessionStates.txt) - The possible values that can be used to describe the state of a finalized void transaction. - [VoidSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2024-10/enums/VoidSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a void transaction is rejected. - [__Directive](https://shopify.dev/docs/api/payments-apps/2024-10/objects/__Directive.txt) - A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor. - [__DirectiveLocation](https://shopify.dev/docs/api/payments-apps/2024-10/enums/__DirectiveLocation.txt) - A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies. - [__EnumValue](https://shopify.dev/docs/api/payments-apps/2024-10/objects/__EnumValue.txt) - One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string. - [__Field](https://shopify.dev/docs/api/payments-apps/2024-10/objects/__Field.txt) - Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type. - [__InputValue](https://shopify.dev/docs/api/payments-apps/2024-10/objects/__InputValue.txt) - Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value. - [__Schema](https://shopify.dev/docs/api/payments-apps/2024-10/objects/__Schema.txt) - A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations. - [__Type](https://shopify.dev/docs/api/payments-apps/2024-10/objects/__Type.txt) - The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types. - [__TypeKind](https://shopify.dev/docs/api/payments-apps/2024-10/enums/__TypeKind.txt) - An enum describing what kind of type a given `__Type` is. ## **2024-04** API Reference - [ApiVersion](https://shopify.dev/docs/api/payments-apps/2024-04/objects/ApiVersion.txt) - A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). Versions are commonly referred to by their handle (for example, `2021-10`). - [Boolean](https://shopify.dev/docs/api/payments-apps/2024-04/scalars/Boolean.txt) - Represents `true` or `false` values. - [CaptureSession](https://shopify.dev/docs/api/payments-apps/2024-04/objects/CaptureSession.txt) - Represents a unique capture transaction. - [CaptureSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2024-04/payloads/CaptureSessionRejectPayload.txt) - Return type for `captureSessionReject` mutation. - [CaptureSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2024-04/objects/CaptureSessionRejectUserError.txt) - An error that occurs during the execution of `CaptureSessionReject`. - [CaptureSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/CaptureSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `CaptureSessionRejectUserError`. - [CaptureSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2024-04/input-objects/CaptureSessionRejectionReasonInput.txt) - The input fields to use for the reason why the capture was rejected. - [CaptureSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2024-04/payloads/CaptureSessionResolvePayload.txt) - Return type for `captureSessionResolve` mutation. - [CaptureSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2024-04/objects/CaptureSessionResolveUserError.txt) - An error that occurs during the execution of `CaptureSessionResolve`. - [CaptureSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/CaptureSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `CaptureSessionResolveUserError`. - [CaptureSessionState](https://shopify.dev/docs/api/payments-apps/2024-04/interfaces/CaptureSessionState.txt) - The state of a finalized capture transaction. - [CaptureSessionStateCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/CaptureSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized capture transaction. - [CaptureSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2024-04/objects/CaptureSessionStateRejected.txt) - Additional details about a capture's rejected state. - [CaptureSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2024-04/enums/CaptureSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why the capture transaction is rejected. - [CaptureSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2024-04/objects/CaptureSessionStateResolved.txt) - Additional details about a capture's resolved state. - [CaptureSessionStates](https://shopify.dev/docs/api/payments-apps/2024-04/unions/CaptureSessionStates.txt) - The possible values that can be used to describe the state of a finalized capture transaction. - [CaptureSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/CaptureSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a capture transaction is rejected. - [DateTime](https://shopify.dev/docs/api/payments-apps/2024-04/scalars/DateTime.txt) - Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date and time string. For example, 3:50 pm on September 7, 2019 in the time zone of UTC (Coordinated Universal Time) is represented as `"2019-09-07T15:50:00Z`". - [DisplayableError](https://shopify.dev/docs/api/payments-apps/2024-04/interfaces/DisplayableError.txt) - Represents an error in the input of a mutation. - [ID](https://shopify.dev/docs/api/payments-apps/2024-04/scalars/ID.txt) - Represents a unique identifier, often used to refetch an object. The ID type appears in a JSON response as a String, but it is not intended to be human-readable. Example value: `"gid://shopify/Product/10079785100"` - [captureSessionReject](https://shopify.dev/docs/api/payments-apps/2024-04/mutations/captureSessionReject.txt) - Rejects an open capture session. After the `captureSessionReject` mutation completes on a given capture session, any `captureSessionResolve` mutation attempts will fail. Subsequent `captureSessionReject` mutation attempts will succeed, but the `reason` argument will be ignored. - [captureSessionResolve](https://shopify.dev/docs/api/payments-apps/2024-04/mutations/captureSessionResolve.txt) - Resolves an open capture session. After the `captureSessionResolve` mutation completes on a given capture session, any `captureSessionReject` mutation attempts will fail. Subsequent `captureSessionResolve` mutation attempts will succeed. - [paymentSessionConfirm](https://shopify.dev/docs/api/payments-apps/2024-04/mutations/paymentSessionConfirm.txt) - Initiates the confirmation process of the given payment_session. Shopify will start confirming the payment. According to its business logic, Shopify determines if the payment can be authorized and sends a POST request to the payments app, delivering the confirmation result. - [paymentSessionPending](https://shopify.dev/docs/api/payments-apps/2024-04/mutations/paymentSessionPending.txt) - 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. - [paymentSessionRedirect](https://shopify.dev/docs/api/payments-apps/2024-04/mutations/paymentSessionRedirect.txt) - Redirects the buyer to the given URL for the payment session. For example, Shopify will redirect the buyer to the URL where the 3DS authentication will take place for onsite payment with `credit_card` payment method. - [paymentSessionReject](https://shopify.dev/docs/api/payments-apps/2024-04/mutations/paymentSessionReject.txt) - 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. - [paymentSessionResolve](https://shopify.dev/docs/api/payments-apps/2024-04/mutations/paymentSessionResolve.txt) - 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. - [paymentsAppConfigure](https://shopify.dev/docs/api/payments-apps/2024-04/mutations/paymentsAppConfigure.txt) - Configures the partner-managed payments gateway to work on the merchant's store. For an example of how to use the `paymentsAppConfigure` mutation, refer to the tutorial for [onboarding merchants to payments extensions](https://shopify.dev/docs/apps/build/payments/onboard-a-merchant-payments-extension). - [refundSessionReject](https://shopify.dev/docs/api/payments-apps/2024-04/mutations/refundSessionReject.txt) - Rejects an open refund session. After the `refundSessionReject` mutation completes on a given refund session, any `refundSessionResolve` mutation attempts will fail. Subsequent `refundSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [refundSessionResolve](https://shopify.dev/docs/api/payments-apps/2024-04/mutations/refundSessionResolve.txt) - Resolves an open refund session. After the `refundSessionResolve` mutation completes on a given refund session, any `refundSessionReject` mutation attempts will fail. Subsequent `refundSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [verificationSessionReject](https://shopify.dev/docs/api/payments-apps/2024-04/mutations/verificationSessionReject.txt) - Rejects an open verification session. After the `verificationSessionReject` mutation completes on a given verification session, any `verificationSessionResolve` mutation attempts will fail. Subsequent `verificationSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [verificationSessionResolve](https://shopify.dev/docs/api/payments-apps/2024-04/mutations/verificationSessionResolve.txt) - Resolves an open verification session. After the `verificationSessionResolve` mutation completes on a given verification session, any `verificationSessionReject` mutation attempts will fail. Subsequent `verificationSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [voidSessionReject](https://shopify.dev/docs/api/payments-apps/2024-04/mutations/voidSessionReject.txt) - Rejects an open void session. After the `voidSessionReject` mutation completes on a given void session, any `voidSessionResolve` mutation attempts will fail. Subsequent `voidSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [voidSessionResolve](https://shopify.dev/docs/api/payments-apps/2024-04/mutations/voidSessionResolve.txt) - Resolves an open void session. After the `voidSessionResolve` mutation completes on a given void session, any `voidSessionReject` mutation attempts will fail. Subsequent `voidSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [PaymentSession](https://shopify.dev/docs/api/payments-apps/2024-04/objects/PaymentSession.txt) - A unique payment transaction. - [PaymentSessionActionsRedirect](https://shopify.dev/docs/api/payments-apps/2024-04/objects/PaymentSessionActionsRedirect.txt) - The payload required to redirect the customer to the shop after payment is finalized. - [PaymentSessionConfirmPayload](https://shopify.dev/docs/api/payments-apps/2024-04/payloads/PaymentSessionConfirmPayload.txt) - Return type for `paymentSessionConfirm` mutation. - [PaymentSessionConfirmUserError](https://shopify.dev/docs/api/payments-apps/2024-04/objects/PaymentSessionConfirmUserError.txt) - An error that occurs during the execution of `PaymentSessionConfirm`. - [PaymentSessionConfirmUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/PaymentSessionConfirmUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionConfirmUserError`. - [PaymentSessionNextAction](https://shopify.dev/docs/api/payments-apps/2024-04/objects/PaymentSessionNextAction.txt) - The next action that is expected of the Partner after the payment is finalized. - [PaymentSessionNextActionAction](https://shopify.dev/docs/api/payments-apps/2024-04/enums/PaymentSessionNextActionAction.txt) - The possible values that can be used to describe the next action that a Partner should do after a payment is finalized. - [PaymentSessionNextActionContext](https://shopify.dev/docs/api/payments-apps/2024-04/unions/PaymentSessionNextActionContext.txt) - The context required to perform an action. - [PaymentSessionPendingPayload](https://shopify.dev/docs/api/payments-apps/2024-04/payloads/PaymentSessionPendingPayload.txt) - Return type for `paymentSessionPending` mutation. - [PaymentSessionPendingUserError](https://shopify.dev/docs/api/payments-apps/2024-04/objects/PaymentSessionPendingUserError.txt) - Represents a payment session custom error. - [PaymentSessionPendingUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/PaymentSessionPendingUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionPendingUserError`. - [PaymentSessionRedirectPayload](https://shopify.dev/docs/api/payments-apps/2024-04/payloads/PaymentSessionRedirectPayload.txt) - Return type for `paymentSessionRedirect` mutation. - [PaymentSessionRedirectUserError](https://shopify.dev/docs/api/payments-apps/2024-04/objects/PaymentSessionRedirectUserError.txt) - An error that occurs during the execution of `PaymentSessionRedirect`. - [PaymentSessionRedirectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/PaymentSessionRedirectUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionRedirectUserError`. - [PaymentSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2024-04/payloads/PaymentSessionRejectPayload.txt) - Return type for `paymentSessionReject` mutation. - [PaymentSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2024-04/input-objects/PaymentSessionRejectionReasonInput.txt) - The input fields for the reason why the payment was rejected. - [PaymentSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2024-04/payloads/PaymentSessionResolvePayload.txt) - Return type for `paymentSessionResolve` mutation. - [PaymentSessionState](https://shopify.dev/docs/api/payments-apps/2024-04/interfaces/PaymentSessionState.txt) - The state of a payment transaction. - [PaymentSessionStateCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/PaymentSessionStateCode.txt) - The possible values that can be used to describe the state of a payment transaction. - [PaymentSessionStateConfirming](https://shopify.dev/docs/api/payments-apps/2024-04/objects/PaymentSessionStateConfirming.txt) - Additional details about a payment's confirming state. - [PaymentSessionStatePending](https://shopify.dev/docs/api/payments-apps/2024-04/objects/PaymentSessionStatePending.txt) - Additional details about a payment's pending state. - [PaymentSessionStatePendingReason](https://shopify.dev/docs/api/payments-apps/2024-04/enums/PaymentSessionStatePendingReason.txt) - Reasons the finalization of the payment is pending. - [PaymentSessionStateRedirecting](https://shopify.dev/docs/api/payments-apps/2024-04/objects/PaymentSessionStateRedirecting.txt) - Additional details about a payment's redirecting state. - [PaymentSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2024-04/objects/PaymentSessionStateRejected.txt) - Additional details about a payment's rejected state. - [PaymentSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2024-04/enums/PaymentSessionStateRejectedReason.txt) - The possible values that can be used to describe the reasons why a payment is rejected. - [PaymentSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2024-04/objects/PaymentSessionStateResolved.txt) - Additional details about a payment's resolved state. - [PaymentSessionStates](https://shopify.dev/docs/api/payments-apps/2024-04/unions/PaymentSessionStates.txt) - The possible values that can be used to describe the state of a payment transaction. - [PaymentSessionThreeDSecureAuthentication](https://shopify.dev/docs/api/payments-apps/2024-04/input-objects/PaymentSessionThreeDSecureAuthentication.txt) - The 3D Secure authentication data from the partner. One and only one of authentication_data and partner_error must be present. - [PaymentSessionThreeDSecureAuthenticationData](https://shopify.dev/docs/api/payments-apps/2024-04/input-objects/PaymentSessionThreeDSecureAuthenticationData.txt) - The input fields for the 3D Secure authentication data from the partner. - [PaymentSessionThreeDSecureAuthenticationFlow](https://shopify.dev/docs/api/payments-apps/2024-04/enums/PaymentSessionThreeDSecureAuthenticationFlow.txt) - The 3D Secure Authentication Flow. - [PaymentSessionThreeDSecureChargebackLiability](https://shopify.dev/docs/api/payments-apps/2024-04/enums/PaymentSessionThreeDSecureChargebackLiability.txt) - Indicates if the liability for chargebacks has shifted away from the merchant. - [PaymentSessionThreeDSecurePartnerError](https://shopify.dev/docs/api/payments-apps/2024-04/enums/PaymentSessionThreeDSecurePartnerError.txt) - The error that occurred in the partner environment while requesting the 3D Secure authentication or processing its result. - [PaymentSessionThreeDSecureTransStatus](https://shopify.dev/docs/api/payments-apps/2024-04/enums/PaymentSessionThreeDSecureTransStatus.txt) - Indicates whether a transaction qualifies as an authenticated transaction. For 3DS version 2, the EMV 3D Secure transaction status from the last of the Authentication Response (ARes) or Results Request (RReq) messages. For 3DS version 1, the 3D Secure PARes Status. - [PaymentSessionThreeDSecureVersion](https://shopify.dev/docs/api/payments-apps/2024-04/enums/PaymentSessionThreeDSecureVersion.txt) - The 3D Secure version. - [PaymentsAppConfiguration](https://shopify.dev/docs/api/payments-apps/2024-04/objects/PaymentsAppConfiguration.txt) - The [production configuration](https://shopify.dev/apps/payments/onboarding-a-merchant-payments-apps) of the payments app. - [PaymentsAppConfigurePayload](https://shopify.dev/docs/api/payments-apps/2024-04/payloads/PaymentsAppConfigurePayload.txt) - Return type for `paymentsAppConfigure` mutation. - [QueryRoot](https://shopify.dev/docs/api/payments-apps/2024-04/objects/QueryRoot.txt) - The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. - [publicApiVersions](https://shopify.dev/docs/api/payments-apps/2024-04/queries/publicApiVersions.txt) - The list of public Payments Apps API versions, including supported, release candidate and unstable versions. - [RefundSession](https://shopify.dev/docs/api/payments-apps/2024-04/objects/RefundSession.txt) - A unique refund transaction. - [RefundSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2024-04/payloads/RefundSessionRejectPayload.txt) - Return type for `refundSessionReject` mutation. - [RefundSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2024-04/objects/RefundSessionRejectUserError.txt) - An error that occurs during the execution of `RefundSessionReject`. - [RefundSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/RefundSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `RefundSessionRejectUserError`. - [RefundSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2024-04/input-objects/RefundSessionRejectionReasonInput.txt) - The input fields for the reason why the refund was rejected. - [RefundSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2024-04/payloads/RefundSessionResolvePayload.txt) - Return type for `refundSessionResolve` mutation. - [RefundSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2024-04/objects/RefundSessionResolveUserError.txt) - An error that occurs during the execution of `RefundSessionResolve`. - [RefundSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/RefundSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `RefundSessionResolveUserError`. - [RefundSessionState](https://shopify.dev/docs/api/payments-apps/2024-04/interfaces/RefundSessionState.txt) - The State of a finalized refund transaction. - [RefundSessionStateCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/RefundSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized refund transaction. - [RefundSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2024-04/objects/RefundSessionStateRejected.txt) - Additional details about a refund's rejected state. - [RefundSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2024-04/enums/RefundSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why the refund is rejected. - [RefundSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2024-04/objects/RefundSessionStateResolved.txt) - Additional details about a refund's resolved state. - [RefundSessionStates](https://shopify.dev/docs/api/payments-apps/2024-04/unions/RefundSessionStates.txt) - The possible values that can be used to describe the state of a finalized refund transaction. - [RefundSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/RefundSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a refund transaction was rejected. - [String](https://shopify.dev/docs/api/payments-apps/2024-04/scalars/String.txt) - Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. - [URL](https://shopify.dev/docs/api/payments-apps/2024-04/scalars/URL.txt) - Represents an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string. For example, `"https://example.myshopify.com"` is a valid URL. It includes a scheme (`https`) and a host (`example.myshopify.com`). - [UserError](https://shopify.dev/docs/api/payments-apps/2024-04/objects/UserError.txt) - Represents an error in the input of a mutation. - [VerificationSession](https://shopify.dev/docs/api/payments-apps/2024-04/objects/VerificationSession.txt) - A unique verification transaction. - [VerificationSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2024-04/payloads/VerificationSessionRejectPayload.txt) - Return type for `verificationSessionReject` mutation. - [VerificationSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2024-04/input-objects/VerificationSessionRejectionReasonInput.txt) - The input fields for the reason why the verification was rejected. - [VerificationSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2024-04/payloads/VerificationSessionResolvePayload.txt) - Return type for `verificationSessionResolve` mutation. - [VerificationSessionState](https://shopify.dev/docs/api/payments-apps/2024-04/interfaces/VerificationSessionState.txt) - The state of a verification transaction. - [VerificationSessionStateCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/VerificationSessionStateCode.txt) - The possible values that can be used to describe the state of a verification transaction. - [VerificationSessionStateReason](https://shopify.dev/docs/api/payments-apps/2024-04/enums/VerificationSessionStateReason.txt) - The possible values that can be used to describe the reasons why a verification is rejected. - [VerificationSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2024-04/objects/VerificationSessionStateRejected.txt) - Additional details about a verification's rejected state. - [VerificationSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2024-04/objects/VerificationSessionStateResolved.txt) - Additional details about a verification's resolved state. - [VerificationSessionStates](https://shopify.dev/docs/api/payments-apps/2024-04/unions/VerificationSessionStates.txt) - The possible values that can be used to describe the state of a verification transaction. - [VerificationSessionUserError](https://shopify.dev/docs/api/payments-apps/2024-04/objects/VerificationSessionUserError.txt) - Represents a verification session custom error. - [VerificationSessionUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/VerificationSessionUserErrorCode.txt) - Possible error codes that can be returned by `VerificationSessionUserError`. - [VoidSession](https://shopify.dev/docs/api/payments-apps/2024-04/objects/VoidSession.txt) - A unique void transaction. - [VoidSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2024-04/payloads/VoidSessionRejectPayload.txt) - Return type for `voidSessionReject` mutation. - [VoidSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2024-04/objects/VoidSessionRejectUserError.txt) - An error that occurs during the execution of `VoidSessionReject`. - [VoidSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/VoidSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `VoidSessionRejectUserError`. - [VoidSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2024-04/input-objects/VoidSessionRejectionReasonInput.txt) - The input fields for the reason why the void transaction was rejected. - [VoidSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2024-04/payloads/VoidSessionResolvePayload.txt) - Return type for `voidSessionResolve` mutation. - [VoidSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2024-04/objects/VoidSessionResolveUserError.txt) - An error that occurs during the execution of `VoidSessionResolve`. - [VoidSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/VoidSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `VoidSessionResolveUserError`. - [VoidSessionState](https://shopify.dev/docs/api/payments-apps/2024-04/interfaces/VoidSessionState.txt) - The state of a finalized void transaction. - [VoidSessionStateCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/VoidSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized void transaction. - [VoidSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2024-04/objects/VoidSessionStateRejected.txt) - Additional details about a void's rejected state. - [VoidSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2024-04/enums/VoidSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why a void transaction is rejected. - [VoidSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2024-04/objects/VoidSessionStateResolved.txt) - Additional details about a void's resolved state. - [VoidSessionStates](https://shopify.dev/docs/api/payments-apps/2024-04/unions/VoidSessionStates.txt) - The possible values that can be used to describe the state of a finalized void transaction. - [VoidSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2024-04/enums/VoidSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a void transaction is rejected. - [__Directive](https://shopify.dev/docs/api/payments-apps/2024-04/objects/__Directive.txt) - A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor. - [__DirectiveLocation](https://shopify.dev/docs/api/payments-apps/2024-04/enums/__DirectiveLocation.txt) - A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies. - [__EnumValue](https://shopify.dev/docs/api/payments-apps/2024-04/objects/__EnumValue.txt) - One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string. - [__Field](https://shopify.dev/docs/api/payments-apps/2024-04/objects/__Field.txt) - Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type. - [__InputValue](https://shopify.dev/docs/api/payments-apps/2024-04/objects/__InputValue.txt) - Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value. - [__Schema](https://shopify.dev/docs/api/payments-apps/2024-04/objects/__Schema.txt) - A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations. - [__Type](https://shopify.dev/docs/api/payments-apps/2024-04/objects/__Type.txt) - The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types. - [__TypeKind](https://shopify.dev/docs/api/payments-apps/2024-04/enums/__TypeKind.txt) - An enum describing what kind of type a given `__Type` is. ## **2025-04** API Reference - [ApiVersion](https://shopify.dev/docs/api/payments-apps/2025-04/objects/ApiVersion.txt) - A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). Versions are commonly referred to by their handle (for example, `2021-10`). - [Boolean](https://shopify.dev/docs/api/payments-apps/2025-04/scalars/Boolean.txt) - Represents `true` or `false` values. - [CaptureSession](https://shopify.dev/docs/api/payments-apps/2025-04/objects/CaptureSession.txt) - Represents a unique capture transaction. - [CaptureSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-04/payloads/CaptureSessionRejectPayload.txt) - Return type for `captureSessionReject` mutation. - [CaptureSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2025-04/objects/CaptureSessionRejectUserError.txt) - An error that occurs during the execution of `CaptureSessionReject`. - [CaptureSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/CaptureSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `CaptureSessionRejectUserError`. - [CaptureSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-04/input-objects/CaptureSessionRejectionReasonInput.txt) - The input fields to use for the reason why the capture was rejected. - [CaptureSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-04/payloads/CaptureSessionResolvePayload.txt) - Return type for `captureSessionResolve` mutation. - [CaptureSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2025-04/objects/CaptureSessionResolveUserError.txt) - An error that occurs during the execution of `CaptureSessionResolve`. - [CaptureSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/CaptureSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `CaptureSessionResolveUserError`. - [CaptureSessionState](https://shopify.dev/docs/api/payments-apps/2025-04/interfaces/CaptureSessionState.txt) - The state of a finalized capture transaction. - [CaptureSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/CaptureSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized capture transaction. - [CaptureSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-04/objects/CaptureSessionStateRejected.txt) - Additional details about a capture's rejected state. - [CaptureSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2025-04/enums/CaptureSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why the capture transaction is rejected. - [CaptureSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-04/objects/CaptureSessionStateResolved.txt) - Additional details about a capture's resolved state. - [CaptureSessionStates](https://shopify.dev/docs/api/payments-apps/2025-04/unions/CaptureSessionStates.txt) - The possible values that can be used to describe the state of a finalized capture transaction. - [CaptureSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/CaptureSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a capture transaction is rejected. - [DateTime](https://shopify.dev/docs/api/payments-apps/2025-04/scalars/DateTime.txt) - Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date and time string. For example, 3:50 pm on September 7, 2019 in the time zone of UTC (Coordinated Universal Time) is represented as `"2019-09-07T15:50:00Z`". - [DigitalWallet](https://shopify.dev/docs/api/payments-apps/2025-04/enums/DigitalWallet.txt) - Digital wallet, such as Apple Pay, which can be used for accelerated checkouts. - [DisplayableError](https://shopify.dev/docs/api/payments-apps/2025-04/interfaces/DisplayableError.txt) - Represents an error in the input of a mutation. - [ID](https://shopify.dev/docs/api/payments-apps/2025-04/scalars/ID.txt) - Represents a unique identifier, often used to refetch an object. The ID type appears in a JSON response as a String, but it is not intended to be human-readable. Example value: `"gid://shopify/Product/10079785100"` - [captureSessionReject](https://shopify.dev/docs/api/payments-apps/2025-04/mutations/captureSessionReject.txt) - Rejects an open capture session. After the `captureSessionReject` mutation completes on a given capture session, any `captureSessionResolve` mutation attempts will fail. Subsequent `captureSessionReject` mutation attempts will succeed, but the `reason` argument will be ignored. - [captureSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-04/mutations/captureSessionResolve.txt) - Resolves an open capture session. After the `captureSessionResolve` mutation completes on a given capture session, any `captureSessionReject` mutation attempts will fail. Subsequent `captureSessionResolve` mutation attempts will succeed. - [paymentSessionConfirm](https://shopify.dev/docs/api/payments-apps/2025-04/mutations/paymentSessionConfirm.txt) - Initiates the confirmation process of the given payment_session. Shopify will start confirming the payment. According to its business logic, Shopify determines if the payment can be authorized and sends a POST request to the payments app, delivering the confirmation result. - [paymentSessionPending](https://shopify.dev/docs/api/payments-apps/2025-04/mutations/paymentSessionPending.txt) - 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. - [paymentSessionRedirect](https://shopify.dev/docs/api/payments-apps/2025-04/mutations/paymentSessionRedirect.txt) - Redirects the buyer to the given URL for the payment session. For example, Shopify will redirect the buyer to the URL where the 3DS authentication will take place for onsite payment with `credit_card` payment method. - [paymentSessionReject](https://shopify.dev/docs/api/payments-apps/2025-04/mutations/paymentSessionReject.txt) - 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. - [paymentSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-04/mutations/paymentSessionResolve.txt) - 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. - [paymentsAppConfigure](https://shopify.dev/docs/api/payments-apps/2025-04/mutations/paymentsAppConfigure.txt) - Configures the partner-managed payments gateway to work on the merchant's store. For an example of how to use the `paymentsAppConfigure` mutation, refer to the tutorial for [onboarding merchants to payments extensions](https://shopify.dev/docs/apps/build/payments/onboard-a-merchant-payments-extension). - [refundSessionReject](https://shopify.dev/docs/api/payments-apps/2025-04/mutations/refundSessionReject.txt) - Rejects an open refund session. After the `refundSessionReject` mutation completes on a given refund session, any `refundSessionResolve` mutation attempts will fail. Subsequent `refundSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [refundSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-04/mutations/refundSessionResolve.txt) - Resolves an open refund session. After the `refundSessionResolve` mutation completes on a given refund session, any `refundSessionReject` mutation attempts will fail. Subsequent `refundSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [verificationSessionRedirect](https://shopify.dev/docs/api/payments-apps/2025-04/mutations/verificationSessionRedirect.txt) - Redirects the buyer to the given URL for the verification session. Shopify will redirect the buyer to the URL where the 3DS authentication will take place when verifying the buyer's credit_card. - [verificationSessionReject](https://shopify.dev/docs/api/payments-apps/2025-04/mutations/verificationSessionReject.txt) - Rejects an open verification session. After the `verificationSessionReject` mutation completes on a given verification session, any `verificationSessionResolve` mutation attempts will fail. Subsequent `verificationSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [verificationSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-04/mutations/verificationSessionResolve.txt) - Resolves an open verification session. After the `verificationSessionResolve` mutation completes on a given verification session, any `verificationSessionReject` mutation attempts will fail. Subsequent `verificationSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [voidSessionReject](https://shopify.dev/docs/api/payments-apps/2025-04/mutations/voidSessionReject.txt) - Rejects an open void session. After the `voidSessionReject` mutation completes on a given void session, any `voidSessionResolve` mutation attempts will fail. Subsequent `voidSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [voidSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-04/mutations/voidSessionResolve.txt) - Resolves an open void session. After the `voidSessionResolve` mutation completes on a given void session, any `voidSessionReject` mutation attempts will fail. Subsequent `voidSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [PaymentSession](https://shopify.dev/docs/api/payments-apps/2025-04/objects/PaymentSession.txt) - A unique payment transaction. - [PaymentSessionActionsRedirect](https://shopify.dev/docs/api/payments-apps/2025-04/objects/PaymentSessionActionsRedirect.txt) - The payload required to redirect the customer to the shop after payment is finalized. - [PaymentSessionConfirmPayload](https://shopify.dev/docs/api/payments-apps/2025-04/payloads/PaymentSessionConfirmPayload.txt) - Return type for `paymentSessionConfirm` mutation. - [PaymentSessionConfirmUserError](https://shopify.dev/docs/api/payments-apps/2025-04/objects/PaymentSessionConfirmUserError.txt) - An error that occurs during the execution of `PaymentSessionConfirm`. - [PaymentSessionConfirmUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/PaymentSessionConfirmUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionConfirmUserError`. - [PaymentSessionNextAction](https://shopify.dev/docs/api/payments-apps/2025-04/objects/PaymentSessionNextAction.txt) - The next action that is expected of the Partner after the payment is finalized. - [PaymentSessionNextActionAction](https://shopify.dev/docs/api/payments-apps/2025-04/enums/PaymentSessionNextActionAction.txt) - The possible values that can be used to describe the next action that a Partner should do after a payment is finalized. - [PaymentSessionNextActionContext](https://shopify.dev/docs/api/payments-apps/2025-04/unions/PaymentSessionNextActionContext.txt) - The context required to perform an action. - [PaymentSessionPendingPayload](https://shopify.dev/docs/api/payments-apps/2025-04/payloads/PaymentSessionPendingPayload.txt) - Return type for `paymentSessionPending` mutation. - [PaymentSessionPendingUserError](https://shopify.dev/docs/api/payments-apps/2025-04/objects/PaymentSessionPendingUserError.txt) - Represents a payment session custom error. - [PaymentSessionPendingUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/PaymentSessionPendingUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionPendingUserError`. - [PaymentSessionRedirectPayload](https://shopify.dev/docs/api/payments-apps/2025-04/payloads/PaymentSessionRedirectPayload.txt) - Return type for `paymentSessionRedirect` mutation. - [PaymentSessionRedirectUserError](https://shopify.dev/docs/api/payments-apps/2025-04/objects/PaymentSessionRedirectUserError.txt) - An error that occurs during the execution of `PaymentSessionRedirect`. - [PaymentSessionRedirectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/PaymentSessionRedirectUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionRedirectUserError`. - [PaymentSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-04/payloads/PaymentSessionRejectPayload.txt) - Return type for `paymentSessionReject` mutation. - [PaymentSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-04/input-objects/PaymentSessionRejectionReasonInput.txt) - The input fields for the reason why the payment was rejected. - [PaymentSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-04/payloads/PaymentSessionResolvePayload.txt) - Return type for `paymentSessionResolve` mutation. - [PaymentSessionState](https://shopify.dev/docs/api/payments-apps/2025-04/interfaces/PaymentSessionState.txt) - The state of a payment transaction. - [PaymentSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/PaymentSessionStateCode.txt) - The possible values that can be used to describe the state of a payment transaction. - [PaymentSessionStateConfirming](https://shopify.dev/docs/api/payments-apps/2025-04/objects/PaymentSessionStateConfirming.txt) - Additional details about a payment's confirming state. - [PaymentSessionStatePending](https://shopify.dev/docs/api/payments-apps/2025-04/objects/PaymentSessionStatePending.txt) - Additional details about a payment's pending state. - [PaymentSessionStatePendingReason](https://shopify.dev/docs/api/payments-apps/2025-04/enums/PaymentSessionStatePendingReason.txt) - Reasons the finalization of the payment is pending. - [PaymentSessionStateRedirecting](https://shopify.dev/docs/api/payments-apps/2025-04/objects/PaymentSessionStateRedirecting.txt) - Additional details about a payment's redirecting state. - [PaymentSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-04/objects/PaymentSessionStateRejected.txt) - Additional details about a payment's rejected state. - [PaymentSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2025-04/enums/PaymentSessionStateRejectedReason.txt) - The possible values that can be used to describe the reasons why a payment is rejected. - [PaymentSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-04/objects/PaymentSessionStateResolved.txt) - Additional details about a payment's resolved state. - [PaymentSessionStates](https://shopify.dev/docs/api/payments-apps/2025-04/unions/PaymentSessionStates.txt) - The possible values that can be used to describe the state of a payment transaction. - [PaymentSessionThreeDSecureAuthentication](https://shopify.dev/docs/api/payments-apps/2025-04/input-objects/PaymentSessionThreeDSecureAuthentication.txt) - The 3D Secure authentication data from the partner. One and only one of authentication_data and partner_error must be present. - [PaymentSessionThreeDSecureAuthenticationData](https://shopify.dev/docs/api/payments-apps/2025-04/input-objects/PaymentSessionThreeDSecureAuthenticationData.txt) - The input fields for the 3D Secure authentication data from the partner. - [PaymentSessionThreeDSecureAuthenticationFlow](https://shopify.dev/docs/api/payments-apps/2025-04/enums/PaymentSessionThreeDSecureAuthenticationFlow.txt) - The 3D Secure Authentication Flow. - [PaymentSessionThreeDSecureChargebackLiability](https://shopify.dev/docs/api/payments-apps/2025-04/enums/PaymentSessionThreeDSecureChargebackLiability.txt) - Indicates if the liability for chargebacks has shifted away from the merchant. - [PaymentSessionThreeDSecurePartnerError](https://shopify.dev/docs/api/payments-apps/2025-04/enums/PaymentSessionThreeDSecurePartnerError.txt) - The error that occurred in the partner environment while requesting the 3D Secure authentication or processing its result. - [PaymentSessionThreeDSecureTransStatus](https://shopify.dev/docs/api/payments-apps/2025-04/enums/PaymentSessionThreeDSecureTransStatus.txt) - Indicates whether a transaction qualifies as an authenticated transaction. For 3DS version 2, the EMV 3D Secure transaction status from the last of the Authentication Response (ARes) or Results Request (RReq) messages. For 3DS version 1, the 3D Secure PARes Status. - [PaymentSessionThreeDSecureVersion](https://shopify.dev/docs/api/payments-apps/2025-04/enums/PaymentSessionThreeDSecureVersion.txt) - The 3D Secure version. - [PaymentsAppConfiguration](https://shopify.dev/docs/api/payments-apps/2025-04/objects/PaymentsAppConfiguration.txt) - The [production configuration](https://shopify.dev/apps/payments/onboarding-a-merchant-payments-apps) of the payments app. - [PaymentsAppConfigurePayload](https://shopify.dev/docs/api/payments-apps/2025-04/payloads/PaymentsAppConfigurePayload.txt) - Return type for `paymentsAppConfigure` mutation. - [QueryRoot](https://shopify.dev/docs/api/payments-apps/2025-04/objects/QueryRoot.txt) - The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. - [publicApiVersions](https://shopify.dev/docs/api/payments-apps/2025-04/queries/publicApiVersions.txt) - The list of public Payments Apps API versions, including supported, release candidate and unstable versions. - [RefundSession](https://shopify.dev/docs/api/payments-apps/2025-04/objects/RefundSession.txt) - A unique refund transaction. - [RefundSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-04/payloads/RefundSessionRejectPayload.txt) - Return type for `refundSessionReject` mutation. - [RefundSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2025-04/objects/RefundSessionRejectUserError.txt) - An error that occurs during the execution of `RefundSessionReject`. - [RefundSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/RefundSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `RefundSessionRejectUserError`. - [RefundSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-04/input-objects/RefundSessionRejectionReasonInput.txt) - The input fields for the reason why the refund was rejected. - [RefundSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-04/payloads/RefundSessionResolvePayload.txt) - Return type for `refundSessionResolve` mutation. - [RefundSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2025-04/objects/RefundSessionResolveUserError.txt) - An error that occurs during the execution of `RefundSessionResolve`. - [RefundSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/RefundSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `RefundSessionResolveUserError`. - [RefundSessionState](https://shopify.dev/docs/api/payments-apps/2025-04/interfaces/RefundSessionState.txt) - The State of a finalized refund transaction. - [RefundSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/RefundSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized refund transaction. - [RefundSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-04/objects/RefundSessionStateRejected.txt) - Additional details about a refund's rejected state. - [RefundSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2025-04/enums/RefundSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why the refund is rejected. - [RefundSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-04/objects/RefundSessionStateResolved.txt) - Additional details about a refund's resolved state. - [RefundSessionStates](https://shopify.dev/docs/api/payments-apps/2025-04/unions/RefundSessionStates.txt) - The possible values that can be used to describe the state of a finalized refund transaction. - [RefundSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/RefundSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a refund transaction was rejected. - [String](https://shopify.dev/docs/api/payments-apps/2025-04/scalars/String.txt) - Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. - [URL](https://shopify.dev/docs/api/payments-apps/2025-04/scalars/URL.txt) - Represents an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string. For example, `"https://example.myshopify.com"` is a valid URL. It includes a scheme (`https`) and a host (`example.myshopify.com`). - [UserError](https://shopify.dev/docs/api/payments-apps/2025-04/objects/UserError.txt) - Represents an error in the input of a mutation. - [VerificationSession](https://shopify.dev/docs/api/payments-apps/2025-04/objects/VerificationSession.txt) - A unique verification transaction. - [VerificationSessionActionsRedirect](https://shopify.dev/docs/api/payments-apps/2025-04/objects/VerificationSessionActionsRedirect.txt) - The payload required to redirect the customer to the shop after verification is finalized. - [VerificationSessionAddressInput](https://shopify.dev/docs/api/payments-apps/2025-04/input-objects/VerificationSessionAddressInput.txt) - The input fields for the address. - [VerificationSessionCardBrandInput](https://shopify.dev/docs/api/payments-apps/2025-04/enums/VerificationSessionCardBrandInput.txt) - Card brand, such as Visa or Mastercard, which can be used for payments. - [VerificationSessionCardInput](https://shopify.dev/docs/api/payments-apps/2025-04/input-objects/VerificationSessionCardInput.txt) - The input fields for the credit card. - [VerificationSessionNextAction](https://shopify.dev/docs/api/payments-apps/2025-04/objects/VerificationSessionNextAction.txt) - The next action that is expected of the Partner after the verification is finalized. - [VerificationSessionNextActionAction](https://shopify.dev/docs/api/payments-apps/2025-04/enums/VerificationSessionNextActionAction.txt) - The possible values that can be used to describe the next action that a Partner should do after a verification is finalized. - [VerificationSessionNextActionContext](https://shopify.dev/docs/api/payments-apps/2025-04/unions/VerificationSessionNextActionContext.txt) - The context required to perform an action. - [VerificationSessionPaymentDetailsInput](https://shopify.dev/docs/api/payments-apps/2025-04/input-objects/VerificationSessionPaymentDetailsInput.txt) - The input fields for the payment details. - [VerificationSessionRedirectPayload](https://shopify.dev/docs/api/payments-apps/2025-04/payloads/VerificationSessionRedirectPayload.txt) - Return type for `verificationSessionRedirect` mutation. - [VerificationSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-04/payloads/VerificationSessionRejectPayload.txt) - Return type for `verificationSessionReject` mutation. - [VerificationSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-04/input-objects/VerificationSessionRejectionReasonInput.txt) - The input fields for the reason why the verification was rejected. - [VerificationSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-04/payloads/VerificationSessionResolvePayload.txt) - Return type for `verificationSessionResolve` mutation. - [VerificationSessionState](https://shopify.dev/docs/api/payments-apps/2025-04/interfaces/VerificationSessionState.txt) - The state of a verification transaction. - [VerificationSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/VerificationSessionStateCode.txt) - The possible values that can be used to describe the state of a verification transaction. - [VerificationSessionStateReason](https://shopify.dev/docs/api/payments-apps/2025-04/enums/VerificationSessionStateReason.txt) - The possible values that can be used to describe the reasons why a verification is rejected. - [VerificationSessionStateRedirecting](https://shopify.dev/docs/api/payments-apps/2025-04/objects/VerificationSessionStateRedirecting.txt) - Additional details about a verification's redirecting state. - [VerificationSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-04/objects/VerificationSessionStateRejected.txt) - Additional details about a verification's rejected state. - [VerificationSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-04/objects/VerificationSessionStateResolved.txt) - Additional details about a verification's resolved state. - [VerificationSessionStates](https://shopify.dev/docs/api/payments-apps/2025-04/unions/VerificationSessionStates.txt) - The possible values that can be used to describe the state of a verification transaction. - [VerificationSessionThreeDSecureAuthentication](https://shopify.dev/docs/api/payments-apps/2025-04/input-objects/VerificationSessionThreeDSecureAuthentication.txt) - The 3D Secure authentication data from the partner. One and only one of authentication_data and partner_error must be present. - [VerificationSessionThreeDSecureAuthenticationData](https://shopify.dev/docs/api/payments-apps/2025-04/input-objects/VerificationSessionThreeDSecureAuthenticationData.txt) - The input fields for the 3D Secure authentication data from the partner. - [VerificationSessionThreeDSecureAuthenticationFlow](https://shopify.dev/docs/api/payments-apps/2025-04/enums/VerificationSessionThreeDSecureAuthenticationFlow.txt) - The 3D Secure Authentication Flow. - [VerificationSessionThreeDSecureChargebackLiability](https://shopify.dev/docs/api/payments-apps/2025-04/enums/VerificationSessionThreeDSecureChargebackLiability.txt) - Indicates if the liability for chargebacks has shifted away from the merchant. - [VerificationSessionThreeDSecurePartnerError](https://shopify.dev/docs/api/payments-apps/2025-04/enums/VerificationSessionThreeDSecurePartnerError.txt) - The error that occurred in the partner environment while requesting the 3D Secure authentication or processing its result. - [VerificationSessionThreeDSecureTransStatus](https://shopify.dev/docs/api/payments-apps/2025-04/enums/VerificationSessionThreeDSecureTransStatus.txt) - Indicates whether a transaction qualifies as an authenticated transaction. For 3DS version 2, the EMV 3D Secure transaction status from the last of the Authentication Response (ARes) or Results Request (RReq) messages. For 3DS version 1, the 3D Secure PARes Status. - [VerificationSessionThreeDSecureVersion](https://shopify.dev/docs/api/payments-apps/2025-04/enums/VerificationSessionThreeDSecureVersion.txt) - The 3D Secure version. - [VerificationSessionUserError](https://shopify.dev/docs/api/payments-apps/2025-04/objects/VerificationSessionUserError.txt) - Represents a verification session custom error. - [VerificationSessionUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/VerificationSessionUserErrorCode.txt) - Possible error codes that can be returned by `VerificationSessionUserError`. - [VoidSession](https://shopify.dev/docs/api/payments-apps/2025-04/objects/VoidSession.txt) - A unique void transaction. - [VoidSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-04/payloads/VoidSessionRejectPayload.txt) - Return type for `voidSessionReject` mutation. - [VoidSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2025-04/objects/VoidSessionRejectUserError.txt) - An error that occurs during the execution of `VoidSessionReject`. - [VoidSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/VoidSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `VoidSessionRejectUserError`. - [VoidSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-04/input-objects/VoidSessionRejectionReasonInput.txt) - The input fields for the reason why the void transaction was rejected. - [VoidSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-04/payloads/VoidSessionResolvePayload.txt) - Return type for `voidSessionResolve` mutation. - [VoidSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2025-04/objects/VoidSessionResolveUserError.txt) - An error that occurs during the execution of `VoidSessionResolve`. - [VoidSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/VoidSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `VoidSessionResolveUserError`. - [VoidSessionState](https://shopify.dev/docs/api/payments-apps/2025-04/interfaces/VoidSessionState.txt) - The state of a finalized void transaction. - [VoidSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/VoidSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized void transaction. - [VoidSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-04/objects/VoidSessionStateRejected.txt) - Additional details about a void's rejected state. - [VoidSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2025-04/enums/VoidSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why a void transaction is rejected. - [VoidSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-04/objects/VoidSessionStateResolved.txt) - Additional details about a void's resolved state. - [VoidSessionStates](https://shopify.dev/docs/api/payments-apps/2025-04/unions/VoidSessionStates.txt) - The possible values that can be used to describe the state of a finalized void transaction. - [VoidSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2025-04/enums/VoidSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a void transaction is rejected. - [__Directive](https://shopify.dev/docs/api/payments-apps/2025-04/objects/__Directive.txt) - A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor. - [__DirectiveLocation](https://shopify.dev/docs/api/payments-apps/2025-04/enums/__DirectiveLocation.txt) - A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies. - [__EnumValue](https://shopify.dev/docs/api/payments-apps/2025-04/objects/__EnumValue.txt) - One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string. - [__Field](https://shopify.dev/docs/api/payments-apps/2025-04/objects/__Field.txt) - Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type. - [__InputValue](https://shopify.dev/docs/api/payments-apps/2025-04/objects/__InputValue.txt) - Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value. - [__Schema](https://shopify.dev/docs/api/payments-apps/2025-04/objects/__Schema.txt) - A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations. - [__Type](https://shopify.dev/docs/api/payments-apps/2025-04/objects/__Type.txt) - The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types. - [__TypeKind](https://shopify.dev/docs/api/payments-apps/2025-04/enums/__TypeKind.txt) - An enum describing what kind of type a given `__Type` is. ## **2024-07** API Reference - [ApiVersion](https://shopify.dev/docs/api/payments-apps/2024-07/objects/ApiVersion.txt) - A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). Versions are commonly referred to by their handle (for example, `2021-10`). - [Boolean](https://shopify.dev/docs/api/payments-apps/2024-07/scalars/Boolean.txt) - Represents `true` or `false` values. - [CaptureSession](https://shopify.dev/docs/api/payments-apps/2024-07/objects/CaptureSession.txt) - Represents a unique capture transaction. - [CaptureSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2024-07/payloads/CaptureSessionRejectPayload.txt) - Return type for `captureSessionReject` mutation. - [CaptureSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2024-07/objects/CaptureSessionRejectUserError.txt) - An error that occurs during the execution of `CaptureSessionReject`. - [CaptureSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/CaptureSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `CaptureSessionRejectUserError`. - [CaptureSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2024-07/input-objects/CaptureSessionRejectionReasonInput.txt) - The input fields to use for the reason why the capture was rejected. - [CaptureSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2024-07/payloads/CaptureSessionResolvePayload.txt) - Return type for `captureSessionResolve` mutation. - [CaptureSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2024-07/objects/CaptureSessionResolveUserError.txt) - An error that occurs during the execution of `CaptureSessionResolve`. - [CaptureSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/CaptureSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `CaptureSessionResolveUserError`. - [CaptureSessionState](https://shopify.dev/docs/api/payments-apps/2024-07/interfaces/CaptureSessionState.txt) - The state of a finalized capture transaction. - [CaptureSessionStateCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/CaptureSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized capture transaction. - [CaptureSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2024-07/objects/CaptureSessionStateRejected.txt) - Additional details about a capture's rejected state. - [CaptureSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2024-07/enums/CaptureSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why the capture transaction is rejected. - [CaptureSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2024-07/objects/CaptureSessionStateResolved.txt) - Additional details about a capture's resolved state. - [CaptureSessionStates](https://shopify.dev/docs/api/payments-apps/2024-07/unions/CaptureSessionStates.txt) - The possible values that can be used to describe the state of a finalized capture transaction. - [CaptureSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/CaptureSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a capture transaction is rejected. - [DateTime](https://shopify.dev/docs/api/payments-apps/2024-07/scalars/DateTime.txt) - Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date and time string. For example, 3:50 pm on September 7, 2019 in the time zone of UTC (Coordinated Universal Time) is represented as `"2019-09-07T15:50:00Z`". - [DisplayableError](https://shopify.dev/docs/api/payments-apps/2024-07/interfaces/DisplayableError.txt) - Represents an error in the input of a mutation. - [ID](https://shopify.dev/docs/api/payments-apps/2024-07/scalars/ID.txt) - Represents a unique identifier, often used to refetch an object. The ID type appears in a JSON response as a String, but it is not intended to be human-readable. Example value: `"gid://shopify/Product/10079785100"` - [captureSessionReject](https://shopify.dev/docs/api/payments-apps/2024-07/mutations/captureSessionReject.txt) - Rejects an open capture session. After the `captureSessionReject` mutation completes on a given capture session, any `captureSessionResolve` mutation attempts will fail. Subsequent `captureSessionReject` mutation attempts will succeed, but the `reason` argument will be ignored. - [captureSessionResolve](https://shopify.dev/docs/api/payments-apps/2024-07/mutations/captureSessionResolve.txt) - Resolves an open capture session. After the `captureSessionResolve` mutation completes on a given capture session, any `captureSessionReject` mutation attempts will fail. Subsequent `captureSessionResolve` mutation attempts will succeed. - [paymentSessionConfirm](https://shopify.dev/docs/api/payments-apps/2024-07/mutations/paymentSessionConfirm.txt) - Initiates the confirmation process of the given payment_session. Shopify will start confirming the payment. According to its business logic, Shopify determines if the payment can be authorized and sends a POST request to the payments app, delivering the confirmation result. - [paymentSessionPending](https://shopify.dev/docs/api/payments-apps/2024-07/mutations/paymentSessionPending.txt) - 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. - [paymentSessionRedirect](https://shopify.dev/docs/api/payments-apps/2024-07/mutations/paymentSessionRedirect.txt) - Redirects the buyer to the given URL for the payment session. For example, Shopify will redirect the buyer to the URL where the 3DS authentication will take place for onsite payment with `credit_card` payment method. - [paymentSessionReject](https://shopify.dev/docs/api/payments-apps/2024-07/mutations/paymentSessionReject.txt) - 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. - [paymentSessionResolve](https://shopify.dev/docs/api/payments-apps/2024-07/mutations/paymentSessionResolve.txt) - 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. - [paymentsAppConfigure](https://shopify.dev/docs/api/payments-apps/2024-07/mutations/paymentsAppConfigure.txt) - Configures the partner-managed payments gateway to work on the merchant's store. For an example of how to use the `paymentsAppConfigure` mutation, refer to the tutorial for [onboarding merchants to payments extensions](https://shopify.dev/docs/apps/build/payments/onboard-a-merchant-payments-extension). - [refundSessionReject](https://shopify.dev/docs/api/payments-apps/2024-07/mutations/refundSessionReject.txt) - Rejects an open refund session. After the `refundSessionReject` mutation completes on a given refund session, any `refundSessionResolve` mutation attempts will fail. Subsequent `refundSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [refundSessionResolve](https://shopify.dev/docs/api/payments-apps/2024-07/mutations/refundSessionResolve.txt) - Resolves an open refund session. After the `refundSessionResolve` mutation completes on a given refund session, any `refundSessionReject` mutation attempts will fail. Subsequent `refundSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [verificationSessionReject](https://shopify.dev/docs/api/payments-apps/2024-07/mutations/verificationSessionReject.txt) - Rejects an open verification session. After the `verificationSessionReject` mutation completes on a given verification session, any `verificationSessionResolve` mutation attempts will fail. Subsequent `verificationSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [verificationSessionResolve](https://shopify.dev/docs/api/payments-apps/2024-07/mutations/verificationSessionResolve.txt) - Resolves an open verification session. After the `verificationSessionResolve` mutation completes on a given verification session, any `verificationSessionReject` mutation attempts will fail. Subsequent `verificationSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [voidSessionReject](https://shopify.dev/docs/api/payments-apps/2024-07/mutations/voidSessionReject.txt) - Rejects an open void session. After the `voidSessionReject` mutation completes on a given void session, any `voidSessionResolve` mutation attempts will fail. Subsequent `voidSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [voidSessionResolve](https://shopify.dev/docs/api/payments-apps/2024-07/mutations/voidSessionResolve.txt) - Resolves an open void session. After the `voidSessionResolve` mutation completes on a given void session, any `voidSessionReject` mutation attempts will fail. Subsequent `voidSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [PaymentSession](https://shopify.dev/docs/api/payments-apps/2024-07/objects/PaymentSession.txt) - A unique payment transaction. - [PaymentSessionActionsRedirect](https://shopify.dev/docs/api/payments-apps/2024-07/objects/PaymentSessionActionsRedirect.txt) - The payload required to redirect the customer to the shop after payment is finalized. - [PaymentSessionConfirmPayload](https://shopify.dev/docs/api/payments-apps/2024-07/payloads/PaymentSessionConfirmPayload.txt) - Return type for `paymentSessionConfirm` mutation. - [PaymentSessionConfirmUserError](https://shopify.dev/docs/api/payments-apps/2024-07/objects/PaymentSessionConfirmUserError.txt) - An error that occurs during the execution of `PaymentSessionConfirm`. - [PaymentSessionConfirmUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/PaymentSessionConfirmUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionConfirmUserError`. - [PaymentSessionNextAction](https://shopify.dev/docs/api/payments-apps/2024-07/objects/PaymentSessionNextAction.txt) - The next action that is expected of the Partner after the payment is finalized. - [PaymentSessionNextActionAction](https://shopify.dev/docs/api/payments-apps/2024-07/enums/PaymentSessionNextActionAction.txt) - The possible values that can be used to describe the next action that a Partner should do after a payment is finalized. - [PaymentSessionNextActionContext](https://shopify.dev/docs/api/payments-apps/2024-07/unions/PaymentSessionNextActionContext.txt) - The context required to perform an action. - [PaymentSessionPendingPayload](https://shopify.dev/docs/api/payments-apps/2024-07/payloads/PaymentSessionPendingPayload.txt) - Return type for `paymentSessionPending` mutation. - [PaymentSessionPendingUserError](https://shopify.dev/docs/api/payments-apps/2024-07/objects/PaymentSessionPendingUserError.txt) - Represents a payment session custom error. - [PaymentSessionPendingUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/PaymentSessionPendingUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionPendingUserError`. - [PaymentSessionRedirectPayload](https://shopify.dev/docs/api/payments-apps/2024-07/payloads/PaymentSessionRedirectPayload.txt) - Return type for `paymentSessionRedirect` mutation. - [PaymentSessionRedirectUserError](https://shopify.dev/docs/api/payments-apps/2024-07/objects/PaymentSessionRedirectUserError.txt) - An error that occurs during the execution of `PaymentSessionRedirect`. - [PaymentSessionRedirectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/PaymentSessionRedirectUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionRedirectUserError`. - [PaymentSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2024-07/payloads/PaymentSessionRejectPayload.txt) - Return type for `paymentSessionReject` mutation. - [PaymentSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2024-07/input-objects/PaymentSessionRejectionReasonInput.txt) - The input fields for the reason why the payment was rejected. - [PaymentSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2024-07/payloads/PaymentSessionResolvePayload.txt) - Return type for `paymentSessionResolve` mutation. - [PaymentSessionState](https://shopify.dev/docs/api/payments-apps/2024-07/interfaces/PaymentSessionState.txt) - The state of a payment transaction. - [PaymentSessionStateCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/PaymentSessionStateCode.txt) - The possible values that can be used to describe the state of a payment transaction. - [PaymentSessionStateConfirming](https://shopify.dev/docs/api/payments-apps/2024-07/objects/PaymentSessionStateConfirming.txt) - Additional details about a payment's confirming state. - [PaymentSessionStatePending](https://shopify.dev/docs/api/payments-apps/2024-07/objects/PaymentSessionStatePending.txt) - Additional details about a payment's pending state. - [PaymentSessionStatePendingReason](https://shopify.dev/docs/api/payments-apps/2024-07/enums/PaymentSessionStatePendingReason.txt) - Reasons the finalization of the payment is pending. - [PaymentSessionStateRedirecting](https://shopify.dev/docs/api/payments-apps/2024-07/objects/PaymentSessionStateRedirecting.txt) - Additional details about a payment's redirecting state. - [PaymentSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2024-07/objects/PaymentSessionStateRejected.txt) - Additional details about a payment's rejected state. - [PaymentSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2024-07/enums/PaymentSessionStateRejectedReason.txt) - The possible values that can be used to describe the reasons why a payment is rejected. - [PaymentSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2024-07/objects/PaymentSessionStateResolved.txt) - Additional details about a payment's resolved state. - [PaymentSessionStates](https://shopify.dev/docs/api/payments-apps/2024-07/unions/PaymentSessionStates.txt) - The possible values that can be used to describe the state of a payment transaction. - [PaymentSessionThreeDSecureAuthentication](https://shopify.dev/docs/api/payments-apps/2024-07/input-objects/PaymentSessionThreeDSecureAuthentication.txt) - The 3D Secure authentication data from the partner. One and only one of authentication_data and partner_error must be present. - [PaymentSessionThreeDSecureAuthenticationData](https://shopify.dev/docs/api/payments-apps/2024-07/input-objects/PaymentSessionThreeDSecureAuthenticationData.txt) - The input fields for the 3D Secure authentication data from the partner. - [PaymentSessionThreeDSecureAuthenticationFlow](https://shopify.dev/docs/api/payments-apps/2024-07/enums/PaymentSessionThreeDSecureAuthenticationFlow.txt) - The 3D Secure Authentication Flow. - [PaymentSessionThreeDSecureChargebackLiability](https://shopify.dev/docs/api/payments-apps/2024-07/enums/PaymentSessionThreeDSecureChargebackLiability.txt) - Indicates if the liability for chargebacks has shifted away from the merchant. - [PaymentSessionThreeDSecurePartnerError](https://shopify.dev/docs/api/payments-apps/2024-07/enums/PaymentSessionThreeDSecurePartnerError.txt) - The error that occurred in the partner environment while requesting the 3D Secure authentication or processing its result. - [PaymentSessionThreeDSecureTransStatus](https://shopify.dev/docs/api/payments-apps/2024-07/enums/PaymentSessionThreeDSecureTransStatus.txt) - Indicates whether a transaction qualifies as an authenticated transaction. For 3DS version 2, the EMV 3D Secure transaction status from the last of the Authentication Response (ARes) or Results Request (RReq) messages. For 3DS version 1, the 3D Secure PARes Status. - [PaymentSessionThreeDSecureVersion](https://shopify.dev/docs/api/payments-apps/2024-07/enums/PaymentSessionThreeDSecureVersion.txt) - The 3D Secure version. - [PaymentsAppConfiguration](https://shopify.dev/docs/api/payments-apps/2024-07/objects/PaymentsAppConfiguration.txt) - The [production configuration](https://shopify.dev/apps/payments/onboarding-a-merchant-payments-apps) of the payments app. - [PaymentsAppConfigurePayload](https://shopify.dev/docs/api/payments-apps/2024-07/payloads/PaymentsAppConfigurePayload.txt) - Return type for `paymentsAppConfigure` mutation. - [QueryRoot](https://shopify.dev/docs/api/payments-apps/2024-07/objects/QueryRoot.txt) - The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. - [publicApiVersions](https://shopify.dev/docs/api/payments-apps/2024-07/queries/publicApiVersions.txt) - The list of public Payments Apps API versions, including supported, release candidate and unstable versions. - [RefundSession](https://shopify.dev/docs/api/payments-apps/2024-07/objects/RefundSession.txt) - A unique refund transaction. - [RefundSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2024-07/payloads/RefundSessionRejectPayload.txt) - Return type for `refundSessionReject` mutation. - [RefundSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2024-07/objects/RefundSessionRejectUserError.txt) - An error that occurs during the execution of `RefundSessionReject`. - [RefundSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/RefundSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `RefundSessionRejectUserError`. - [RefundSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2024-07/input-objects/RefundSessionRejectionReasonInput.txt) - The input fields for the reason why the refund was rejected. - [RefundSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2024-07/payloads/RefundSessionResolvePayload.txt) - Return type for `refundSessionResolve` mutation. - [RefundSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2024-07/objects/RefundSessionResolveUserError.txt) - An error that occurs during the execution of `RefundSessionResolve`. - [RefundSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/RefundSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `RefundSessionResolveUserError`. - [RefundSessionState](https://shopify.dev/docs/api/payments-apps/2024-07/interfaces/RefundSessionState.txt) - The State of a finalized refund transaction. - [RefundSessionStateCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/RefundSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized refund transaction. - [RefundSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2024-07/objects/RefundSessionStateRejected.txt) - Additional details about a refund's rejected state. - [RefundSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2024-07/enums/RefundSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why the refund is rejected. - [RefundSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2024-07/objects/RefundSessionStateResolved.txt) - Additional details about a refund's resolved state. - [RefundSessionStates](https://shopify.dev/docs/api/payments-apps/2024-07/unions/RefundSessionStates.txt) - The possible values that can be used to describe the state of a finalized refund transaction. - [RefundSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/RefundSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a refund transaction was rejected. - [String](https://shopify.dev/docs/api/payments-apps/2024-07/scalars/String.txt) - Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. - [URL](https://shopify.dev/docs/api/payments-apps/2024-07/scalars/URL.txt) - Represents an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string. For example, `"https://example.myshopify.com"` is a valid URL. It includes a scheme (`https`) and a host (`example.myshopify.com`). - [UserError](https://shopify.dev/docs/api/payments-apps/2024-07/objects/UserError.txt) - Represents an error in the input of a mutation. - [VerificationSession](https://shopify.dev/docs/api/payments-apps/2024-07/objects/VerificationSession.txt) - A unique verification transaction. - [VerificationSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2024-07/payloads/VerificationSessionRejectPayload.txt) - Return type for `verificationSessionReject` mutation. - [VerificationSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2024-07/input-objects/VerificationSessionRejectionReasonInput.txt) - The input fields for the reason why the verification was rejected. - [VerificationSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2024-07/payloads/VerificationSessionResolvePayload.txt) - Return type for `verificationSessionResolve` mutation. - [VerificationSessionState](https://shopify.dev/docs/api/payments-apps/2024-07/interfaces/VerificationSessionState.txt) - The state of a verification transaction. - [VerificationSessionStateCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/VerificationSessionStateCode.txt) - The possible values that can be used to describe the state of a verification transaction. - [VerificationSessionStateReason](https://shopify.dev/docs/api/payments-apps/2024-07/enums/VerificationSessionStateReason.txt) - The possible values that can be used to describe the reasons why a verification is rejected. - [VerificationSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2024-07/objects/VerificationSessionStateRejected.txt) - Additional details about a verification's rejected state. - [VerificationSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2024-07/objects/VerificationSessionStateResolved.txt) - Additional details about a verification's resolved state. - [VerificationSessionStates](https://shopify.dev/docs/api/payments-apps/2024-07/unions/VerificationSessionStates.txt) - The possible values that can be used to describe the state of a verification transaction. - [VerificationSessionUserError](https://shopify.dev/docs/api/payments-apps/2024-07/objects/VerificationSessionUserError.txt) - Represents a verification session custom error. - [VerificationSessionUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/VerificationSessionUserErrorCode.txt) - Possible error codes that can be returned by `VerificationSessionUserError`. - [VoidSession](https://shopify.dev/docs/api/payments-apps/2024-07/objects/VoidSession.txt) - A unique void transaction. - [VoidSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2024-07/payloads/VoidSessionRejectPayload.txt) - Return type for `voidSessionReject` mutation. - [VoidSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2024-07/objects/VoidSessionRejectUserError.txt) - An error that occurs during the execution of `VoidSessionReject`. - [VoidSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/VoidSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `VoidSessionRejectUserError`. - [VoidSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2024-07/input-objects/VoidSessionRejectionReasonInput.txt) - The input fields for the reason why the void transaction was rejected. - [VoidSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2024-07/payloads/VoidSessionResolvePayload.txt) - Return type for `voidSessionResolve` mutation. - [VoidSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2024-07/objects/VoidSessionResolveUserError.txt) - An error that occurs during the execution of `VoidSessionResolve`. - [VoidSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/VoidSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `VoidSessionResolveUserError`. - [VoidSessionState](https://shopify.dev/docs/api/payments-apps/2024-07/interfaces/VoidSessionState.txt) - The state of a finalized void transaction. - [VoidSessionStateCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/VoidSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized void transaction. - [VoidSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2024-07/objects/VoidSessionStateRejected.txt) - Additional details about a void's rejected state. - [VoidSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2024-07/enums/VoidSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why a void transaction is rejected. - [VoidSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2024-07/objects/VoidSessionStateResolved.txt) - Additional details about a void's resolved state. - [VoidSessionStates](https://shopify.dev/docs/api/payments-apps/2024-07/unions/VoidSessionStates.txt) - The possible values that can be used to describe the state of a finalized void transaction. - [VoidSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2024-07/enums/VoidSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a void transaction is rejected. - [__Directive](https://shopify.dev/docs/api/payments-apps/2024-07/objects/__Directive.txt) - A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor. - [__DirectiveLocation](https://shopify.dev/docs/api/payments-apps/2024-07/enums/__DirectiveLocation.txt) - A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies. - [__EnumValue](https://shopify.dev/docs/api/payments-apps/2024-07/objects/__EnumValue.txt) - One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string. - [__Field](https://shopify.dev/docs/api/payments-apps/2024-07/objects/__Field.txt) - Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type. - [__InputValue](https://shopify.dev/docs/api/payments-apps/2024-07/objects/__InputValue.txt) - Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value. - [__Schema](https://shopify.dev/docs/api/payments-apps/2024-07/objects/__Schema.txt) - A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations. - [__Type](https://shopify.dev/docs/api/payments-apps/2024-07/objects/__Type.txt) - The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types. - [__TypeKind](https://shopify.dev/docs/api/payments-apps/2024-07/enums/__TypeKind.txt) - An enum describing what kind of type a given `__Type` is. ## **2025-01** API Reference - [ApiVersion](https://shopify.dev/docs/api/payments-apps/2025-01/objects/ApiVersion.txt) - A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). Versions are commonly referred to by their handle (for example, `2021-10`). - [Boolean](https://shopify.dev/docs/api/payments-apps/2025-01/scalars/Boolean.txt) - Represents `true` or `false` values. - [CaptureSession](https://shopify.dev/docs/api/payments-apps/2025-01/objects/CaptureSession.txt) - Represents a unique capture transaction. - [CaptureSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/CaptureSessionRejectPayload.txt) - Return type for `captureSessionReject` mutation. - [CaptureSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/CaptureSessionRejectUserError.txt) - An error that occurs during the execution of `CaptureSessionReject`. - [CaptureSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/CaptureSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `CaptureSessionRejectUserError`. - [CaptureSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/CaptureSessionRejectionReasonInput.txt) - The input fields to use for the reason why the capture was rejected. - [CaptureSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/CaptureSessionResolvePayload.txt) - Return type for `captureSessionResolve` mutation. - [CaptureSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/CaptureSessionResolveUserError.txt) - An error that occurs during the execution of `CaptureSessionResolve`. - [CaptureSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/CaptureSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `CaptureSessionResolveUserError`. - [CaptureSessionState](https://shopify.dev/docs/api/payments-apps/2025-01/interfaces/CaptureSessionState.txt) - The state of a finalized capture transaction. - [CaptureSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/CaptureSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized capture transaction. - [CaptureSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-01/objects/CaptureSessionStateRejected.txt) - Additional details about a capture's rejected state. - [CaptureSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2025-01/enums/CaptureSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why the capture transaction is rejected. - [CaptureSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-01/objects/CaptureSessionStateResolved.txt) - Additional details about a capture's resolved state. - [CaptureSessionStates](https://shopify.dev/docs/api/payments-apps/2025-01/unions/CaptureSessionStates.txt) - The possible values that can be used to describe the state of a finalized capture transaction. - [CaptureSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/CaptureSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a capture transaction is rejected. - [DateTime](https://shopify.dev/docs/api/payments-apps/2025-01/scalars/DateTime.txt) - Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date and time string. For example, 3:50 pm on September 7, 2019 in the time zone of UTC (Coordinated Universal Time) is represented as `"2019-09-07T15:50:00Z`". - [DigitalWallet](https://shopify.dev/docs/api/payments-apps/2025-01/enums/DigitalWallet.txt) - Digital wallet, such as Apple Pay, which can be used for accelerated checkouts. - [DisplayableError](https://shopify.dev/docs/api/payments-apps/2025-01/interfaces/DisplayableError.txt) - Represents an error in the input of a mutation. - [ID](https://shopify.dev/docs/api/payments-apps/2025-01/scalars/ID.txt) - Represents a unique identifier, often used to refetch an object. The ID type appears in a JSON response as a String, but it is not intended to be human-readable. Example value: `"gid://shopify/Product/10079785100"` - [captureSessionReject](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/captureSessionReject.txt) - Rejects an open capture session. After the `captureSessionReject` mutation completes on a given capture session, any `captureSessionResolve` mutation attempts will fail. Subsequent `captureSessionReject` mutation attempts will succeed, but the `reason` argument will be ignored. - [captureSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/captureSessionResolve.txt) - Resolves an open capture session. After the `captureSessionResolve` mutation completes on a given capture session, any `captureSessionReject` mutation attempts will fail. Subsequent `captureSessionResolve` mutation attempts will succeed. - [paymentSessionConfirm](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/paymentSessionConfirm.txt) - Initiates the confirmation process of the given payment_session. Shopify will start confirming the payment. According to its business logic, Shopify determines if the payment can be authorized and sends a POST request to the payments app, delivering the confirmation result. - [paymentSessionPending](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/paymentSessionPending.txt) - 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. - [paymentSessionRedirect](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/paymentSessionRedirect.txt) - Redirects the buyer to the given URL for the payment session. For example, Shopify will redirect the buyer to the URL where the 3DS authentication will take place for onsite payment with `credit_card` payment method. - [paymentSessionReject](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/paymentSessionReject.txt) - 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. - [paymentSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/paymentSessionResolve.txt) - 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. - [paymentsAppConfigure](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/paymentsAppConfigure.txt) - Configures the partner-managed payments gateway to work on the merchant's store. For an example of how to use the `paymentsAppConfigure` mutation, refer to the tutorial for [onboarding merchants to payments extensions](https://shopify.dev/docs/apps/build/payments/onboard-a-merchant-payments-extension). - [refundSessionReject](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/refundSessionReject.txt) - Rejects an open refund session. After the `refundSessionReject` mutation completes on a given refund session, any `refundSessionResolve` mutation attempts will fail. Subsequent `refundSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [refundSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/refundSessionResolve.txt) - Resolves an open refund session. After the `refundSessionResolve` mutation completes on a given refund session, any `refundSessionReject` mutation attempts will fail. Subsequent `refundSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [verificationSessionRedirect](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/verificationSessionRedirect.txt) - Redirects the buyer to the given URL for the verification session. Shopify will redirect the buyer to the URL where the 3DS authentication will take place when verifying the buyer's credit_card. - [verificationSessionReject](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/verificationSessionReject.txt) - Rejects an open verification session. After the `verificationSessionReject` mutation completes on a given verification session, any `verificationSessionResolve` mutation attempts will fail. Subsequent `verificationSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [verificationSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/verificationSessionResolve.txt) - Resolves an open verification session. After the `verificationSessionResolve` mutation completes on a given verification session, any `verificationSessionReject` mutation attempts will fail. Subsequent `verificationSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [voidSessionReject](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/voidSessionReject.txt) - Rejects an open void session. After the `voidSessionReject` mutation completes on a given void session, any `voidSessionResolve` mutation attempts will fail. Subsequent `voidSessionReject` mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. - [voidSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/voidSessionResolve.txt) - Resolves an open void session. After the `voidSessionResolve` mutation completes on a given void session, any `voidSessionReject` mutation attempts will fail. Subsequent `voidSessionResolve` mutation attempts will succeed, but the `Details` argument will be ignored. - [PaymentSession](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSession.txt) - A unique payment transaction. - [PaymentSessionActionsRedirect](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSessionActionsRedirect.txt) - The payload required to redirect the customer to the shop after payment is finalized. - [PaymentSessionConfirmPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/PaymentSessionConfirmPayload.txt) - Return type for `paymentSessionConfirm` mutation. - [PaymentSessionConfirmUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSessionConfirmUserError.txt) - An error that occurs during the execution of `PaymentSessionConfirm`. - [PaymentSessionConfirmUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionConfirmUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionConfirmUserError`. - [PaymentSessionNextAction](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSessionNextAction.txt) - The next action that is expected of the Partner after the payment is finalized. - [PaymentSessionNextActionAction](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionNextActionAction.txt) - The possible values that can be used to describe the next action that a Partner should do after a payment is finalized. - [PaymentSessionNextActionContext](https://shopify.dev/docs/api/payments-apps/2025-01/unions/PaymentSessionNextActionContext.txt) - The context required to perform an action. - [PaymentSessionPendingPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/PaymentSessionPendingPayload.txt) - Return type for `paymentSessionPending` mutation. - [PaymentSessionPendingUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSessionPendingUserError.txt) - Represents a payment session custom error. - [PaymentSessionPendingUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionPendingUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionPendingUserError`. - [PaymentSessionRedirectPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/PaymentSessionRedirectPayload.txt) - Return type for `paymentSessionRedirect` mutation. - [PaymentSessionRedirectUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSessionRedirectUserError.txt) - An error that occurs during the execution of `PaymentSessionRedirect`. - [PaymentSessionRedirectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionRedirectUserErrorCode.txt) - Possible error codes that can be returned by `PaymentSessionRedirectUserError`. - [PaymentSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/PaymentSessionRejectPayload.txt) - Return type for `paymentSessionReject` mutation. - [PaymentSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/PaymentSessionRejectionReasonInput.txt) - The input fields for the reason why the payment was rejected. - [PaymentSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/PaymentSessionResolvePayload.txt) - Return type for `paymentSessionResolve` mutation. - [PaymentSessionState](https://shopify.dev/docs/api/payments-apps/2025-01/interfaces/PaymentSessionState.txt) - The state of a payment transaction. - [PaymentSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionStateCode.txt) - The possible values that can be used to describe the state of a payment transaction. - [PaymentSessionStateConfirming](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSessionStateConfirming.txt) - Additional details about a payment's confirming state. - [PaymentSessionStatePending](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSessionStatePending.txt) - Additional details about a payment's pending state. - [PaymentSessionStatePendingReason](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionStatePendingReason.txt) - Reasons the finalization of the payment is pending. - [PaymentSessionStateRedirecting](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSessionStateRedirecting.txt) - Additional details about a payment's redirecting state. - [PaymentSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSessionStateRejected.txt) - Additional details about a payment's rejected state. - [PaymentSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionStateRejectedReason.txt) - The possible values that can be used to describe the reasons why a payment is rejected. - [PaymentSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSessionStateResolved.txt) - Additional details about a payment's resolved state. - [PaymentSessionStates](https://shopify.dev/docs/api/payments-apps/2025-01/unions/PaymentSessionStates.txt) - The possible values that can be used to describe the state of a payment transaction. - [PaymentSessionThreeDSecureAuthentication](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/PaymentSessionThreeDSecureAuthentication.txt) - The 3D Secure authentication data from the partner. One and only one of authentication_data and partner_error must be present. - [PaymentSessionThreeDSecureAuthenticationData](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/PaymentSessionThreeDSecureAuthenticationData.txt) - The input fields for the 3D Secure authentication data from the partner. - [PaymentSessionThreeDSecureAuthenticationFlow](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionThreeDSecureAuthenticationFlow.txt) - The 3D Secure Authentication Flow. - [PaymentSessionThreeDSecureChargebackLiability](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionThreeDSecureChargebackLiability.txt) - Indicates if the liability for chargebacks has shifted away from the merchant. - [PaymentSessionThreeDSecurePartnerError](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionThreeDSecurePartnerError.txt) - The error that occurred in the partner environment while requesting the 3D Secure authentication or processing its result. - [PaymentSessionThreeDSecureTransStatus](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionThreeDSecureTransStatus.txt) - Indicates whether a transaction qualifies as an authenticated transaction. For 3DS version 2, the EMV 3D Secure transaction status from the last of the Authentication Response (ARes) or Results Request (RReq) messages. For 3DS version 1, the 3D Secure PARes Status. - [PaymentSessionThreeDSecureVersion](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionThreeDSecureVersion.txt) - The 3D Secure version. - [PaymentsAppConfiguration](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentsAppConfiguration.txt) - The [production configuration](https://shopify.dev/apps/payments/onboarding-a-merchant-payments-apps) of the payments app. - [PaymentsAppConfigurePayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/PaymentsAppConfigurePayload.txt) - Return type for `paymentsAppConfigure` mutation. - [QueryRoot](https://shopify.dev/docs/api/payments-apps/2025-01/objects/QueryRoot.txt) - The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. - [publicApiVersions](https://shopify.dev/docs/api/payments-apps/2025-01/queries/publicApiVersions.txt) - The list of public Payments Apps API versions, including supported, release candidate and unstable versions. - [RefundSession](https://shopify.dev/docs/api/payments-apps/2025-01/objects/RefundSession.txt) - A unique refund transaction. - [RefundSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/RefundSessionRejectPayload.txt) - Return type for `refundSessionReject` mutation. - [RefundSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/RefundSessionRejectUserError.txt) - An error that occurs during the execution of `RefundSessionReject`. - [RefundSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/RefundSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `RefundSessionRejectUserError`. - [RefundSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/RefundSessionRejectionReasonInput.txt) - The input fields for the reason why the refund was rejected. - [RefundSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/RefundSessionResolvePayload.txt) - Return type for `refundSessionResolve` mutation. - [RefundSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/RefundSessionResolveUserError.txt) - An error that occurs during the execution of `RefundSessionResolve`. - [RefundSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/RefundSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `RefundSessionResolveUserError`. - [RefundSessionState](https://shopify.dev/docs/api/payments-apps/2025-01/interfaces/RefundSessionState.txt) - The State of a finalized refund transaction. - [RefundSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/RefundSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized refund transaction. - [RefundSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-01/objects/RefundSessionStateRejected.txt) - Additional details about a refund's rejected state. - [RefundSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2025-01/enums/RefundSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why the refund is rejected. - [RefundSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-01/objects/RefundSessionStateResolved.txt) - Additional details about a refund's resolved state. - [RefundSessionStates](https://shopify.dev/docs/api/payments-apps/2025-01/unions/RefundSessionStates.txt) - The possible values that can be used to describe the state of a finalized refund transaction. - [RefundSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/RefundSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a refund transaction was rejected. - [String](https://shopify.dev/docs/api/payments-apps/2025-01/scalars/String.txt) - Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. - [URL](https://shopify.dev/docs/api/payments-apps/2025-01/scalars/URL.txt) - Represents an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string. For example, `"https://example.myshopify.com"` is a valid URL. It includes a scheme (`https`) and a host (`example.myshopify.com`). - [UserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/UserError.txt) - Represents an error in the input of a mutation. - [VerificationSession](https://shopify.dev/docs/api/payments-apps/2025-01/objects/VerificationSession.txt) - A unique verification transaction. - [VerificationSessionActionsRedirect](https://shopify.dev/docs/api/payments-apps/2025-01/objects/VerificationSessionActionsRedirect.txt) - The payload required to redirect the customer to the shop after verification is finalized. - [VerificationSessionAddressInput](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/VerificationSessionAddressInput.txt) - The input fields for the address. - [VerificationSessionCardBrandInput](https://shopify.dev/docs/api/payments-apps/2025-01/enums/VerificationSessionCardBrandInput.txt) - Card brand, such as Visa or Mastercard, which can be used for payments. - [VerificationSessionCardInput](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/VerificationSessionCardInput.txt) - The input fields for the credit card. - [VerificationSessionNextAction](https://shopify.dev/docs/api/payments-apps/2025-01/objects/VerificationSessionNextAction.txt) - The next action that is expected of the Partner after the verification is finalized. - [VerificationSessionNextActionAction](https://shopify.dev/docs/api/payments-apps/2025-01/enums/VerificationSessionNextActionAction.txt) - The possible values that can be used to describe the next action that a Partner should do after a verification is finalized. - [VerificationSessionNextActionContext](https://shopify.dev/docs/api/payments-apps/2025-01/unions/VerificationSessionNextActionContext.txt) - The context required to perform an action. - [VerificationSessionPaymentDetailsInput](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/VerificationSessionPaymentDetailsInput.txt) - The input fields for the payment details. - [VerificationSessionRedirectPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/VerificationSessionRedirectPayload.txt) - Return type for `verificationSessionRedirect` mutation. - [VerificationSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/VerificationSessionRejectPayload.txt) - Return type for `verificationSessionReject` mutation. - [VerificationSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/VerificationSessionRejectionReasonInput.txt) - The input fields for the reason why the verification was rejected. - [VerificationSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/VerificationSessionResolvePayload.txt) - Return type for `verificationSessionResolve` mutation. - [VerificationSessionState](https://shopify.dev/docs/api/payments-apps/2025-01/interfaces/VerificationSessionState.txt) - The state of a verification transaction. - [VerificationSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/VerificationSessionStateCode.txt) - The possible values that can be used to describe the state of a verification transaction. - [VerificationSessionStateReason](https://shopify.dev/docs/api/payments-apps/2025-01/enums/VerificationSessionStateReason.txt) - The possible values that can be used to describe the reasons why a verification is rejected. - [VerificationSessionStateRedirecting](https://shopify.dev/docs/api/payments-apps/2025-01/objects/VerificationSessionStateRedirecting.txt) - Additional details about a verification's redirecting state. - [VerificationSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-01/objects/VerificationSessionStateRejected.txt) - Additional details about a verification's rejected state. - [VerificationSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-01/objects/VerificationSessionStateResolved.txt) - Additional details about a verification's resolved state. - [VerificationSessionStates](https://shopify.dev/docs/api/payments-apps/2025-01/unions/VerificationSessionStates.txt) - The possible values that can be used to describe the state of a verification transaction. - [VerificationSessionThreeDSecureAuthentication](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/VerificationSessionThreeDSecureAuthentication.txt) - The 3D Secure authentication data from the partner. One and only one of authentication_data and partner_error must be present. - [VerificationSessionThreeDSecureAuthenticationData](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/VerificationSessionThreeDSecureAuthenticationData.txt) - The input fields for the 3D Secure authentication data from the partner. - [VerificationSessionThreeDSecureAuthenticationFlow](https://shopify.dev/docs/api/payments-apps/2025-01/enums/VerificationSessionThreeDSecureAuthenticationFlow.txt) - The 3D Secure Authentication Flow. - [VerificationSessionThreeDSecureChargebackLiability](https://shopify.dev/docs/api/payments-apps/2025-01/enums/VerificationSessionThreeDSecureChargebackLiability.txt) - Indicates if the liability for chargebacks has shifted away from the merchant. - [VerificationSessionThreeDSecurePartnerError](https://shopify.dev/docs/api/payments-apps/2025-01/enums/VerificationSessionThreeDSecurePartnerError.txt) - The error that occurred in the partner environment while requesting the 3D Secure authentication or processing its result. - [VerificationSessionThreeDSecureTransStatus](https://shopify.dev/docs/api/payments-apps/2025-01/enums/VerificationSessionThreeDSecureTransStatus.txt) - Indicates whether a transaction qualifies as an authenticated transaction. For 3DS version 2, the EMV 3D Secure transaction status from the last of the Authentication Response (ARes) or Results Request (RReq) messages. For 3DS version 1, the 3D Secure PARes Status. - [VerificationSessionThreeDSecureVersion](https://shopify.dev/docs/api/payments-apps/2025-01/enums/VerificationSessionThreeDSecureVersion.txt) - The 3D Secure version. - [VerificationSessionUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/VerificationSessionUserError.txt) - Represents a verification session custom error. - [VerificationSessionUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/VerificationSessionUserErrorCode.txt) - Possible error codes that can be returned by `VerificationSessionUserError`. - [VoidSession](https://shopify.dev/docs/api/payments-apps/2025-01/objects/VoidSession.txt) - A unique void transaction. - [VoidSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/VoidSessionRejectPayload.txt) - Return type for `voidSessionReject` mutation. - [VoidSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/VoidSessionRejectUserError.txt) - An error that occurs during the execution of `VoidSessionReject`. - [VoidSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/VoidSessionRejectUserErrorCode.txt) - Possible error codes that can be returned by `VoidSessionRejectUserError`. - [VoidSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/VoidSessionRejectionReasonInput.txt) - The input fields for the reason why the void transaction was rejected. - [VoidSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/VoidSessionResolvePayload.txt) - Return type for `voidSessionResolve` mutation. - [VoidSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/VoidSessionResolveUserError.txt) - An error that occurs during the execution of `VoidSessionResolve`. - [VoidSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/VoidSessionResolveUserErrorCode.txt) - Possible error codes that can be returned by `VoidSessionResolveUserError`. - [VoidSessionState](https://shopify.dev/docs/api/payments-apps/2025-01/interfaces/VoidSessionState.txt) - The state of a finalized void transaction. - [VoidSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/VoidSessionStateCode.txt) - The possible values that can be used to describe the state of a finalized void transaction. - [VoidSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-01/objects/VoidSessionStateRejected.txt) - Additional details about a void's rejected state. - [VoidSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2025-01/enums/VoidSessionStateRejectedReason.txt) - The possible values that can be used to describe the reason why a void transaction is rejected. - [VoidSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-01/objects/VoidSessionStateResolved.txt) - Additional details about a void's resolved state. - [VoidSessionStates](https://shopify.dev/docs/api/payments-apps/2025-01/unions/VoidSessionStates.txt) - The possible values that can be used to describe the state of a finalized void transaction. - [VoidSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/VoidSessionStatusReasonRejectionCode.txt) - The possible values that can be used to describe the reason why a void transaction is rejected. - [__Directive](https://shopify.dev/docs/api/payments-apps/2025-01/objects/__Directive.txt) - A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor. - [__DirectiveLocation](https://shopify.dev/docs/api/payments-apps/2025-01/enums/__DirectiveLocation.txt) - A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies. - [__EnumValue](https://shopify.dev/docs/api/payments-apps/2025-01/objects/__EnumValue.txt) - One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string. - [__Field](https://shopify.dev/docs/api/payments-apps/2025-01/objects/__Field.txt) - Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type. - [__InputValue](https://shopify.dev/docs/api/payments-apps/2025-01/objects/__InputValue.txt) - Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value. - [__Schema](https://shopify.dev/docs/api/payments-apps/2025-01/objects/__Schema.txt) - A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations. - [__Type](https://shopify.dev/docs/api/payments-apps/2025-01/objects/__Type.txt) - The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types. - [__TypeKind](https://shopify.dev/docs/api/payments-apps/2025-01/enums/__TypeKind.txt) - An enum describing what kind of type a given `__Type` is.