--- title: Payments Apps API reference description: Provides access to the Payments Apps over GraphQL. api_name: payments-apps source_url: html: https://shopify.dev/docs/api/payments-apps/2025-10/full-index md: https://shopify.dev/docs/api/payments-apps/2025-10/full-index.md --- Congratulations! You've found the page we use to help dumb crawlers find all our API pages. * Payment Processing * Mutations * [captureSessionReject](https://shopify.dev/docs/api/payments-apps/2025-10/mutations/captureSessionReject) * [captureSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-10/mutations/captureSessionResolve) * [paymentsAppConfigure](https://shopify.dev/docs/api/payments-apps/2025-10/mutations/paymentsAppConfigure) * [paymentSessionConfirm](https://shopify.dev/docs/api/payments-apps/2025-10/mutations/paymentSessionConfirm) * [paymentSessionModal](https://shopify.dev/docs/api/payments-apps/2025-10/mutations/paymentSessionModal) * [paymentSessionPending](https://shopify.dev/docs/api/payments-apps/2025-10/mutations/paymentSessionPending) * [paymentSessionRedirect](https://shopify.dev/docs/api/payments-apps/2025-10/mutations/paymentSessionRedirect) * [paymentSessionReject](https://shopify.dev/docs/api/payments-apps/2025-10/mutations/paymentSessionReject) * [paymentSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-10/mutations/paymentSessionResolve) * [refundSessionReject](https://shopify.dev/docs/api/payments-apps/2025-10/mutations/refundSessionReject) * [refundSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-10/mutations/refundSessionResolve) * [verificationSessionRedirect](https://shopify.dev/docs/api/payments-apps/2025-10/mutations/verificationSessionRedirect) * [verificationSessionReject](https://shopify.dev/docs/api/payments-apps/2025-10/mutations/verificationSessionReject) * [verificationSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-10/mutations/verificationSessionResolve) * [voidSessionReject](https://shopify.dev/docs/api/payments-apps/2025-10/mutations/voidSessionReject) * [voidSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-10/mutations/voidSessionResolve) * Objects * [CaptureSession](https://shopify.dev/docs/api/payments-apps/2025-10/objects/CaptureSession) * [CaptureSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-10/objects/CaptureSessionStateRejected) * [CaptureSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-10/objects/CaptureSessionStateResolved) * [MutationRoot](https://shopify.dev/docs/api/payments-apps/2025-10/objects/MutationRoot) * [PaymentsAppConfiguration](https://shopify.dev/docs/api/payments-apps/2025-10/objects/PaymentsAppConfiguration) * [PaymentSession](https://shopify.dev/docs/api/payments-apps/2025-10/objects/PaymentSession) * [PaymentSessionActionsRedirect](https://shopify.dev/docs/api/payments-apps/2025-10/objects/PaymentSessionActionsRedirect) * [PaymentSessionNextAction](https://shopify.dev/docs/api/payments-apps/2025-10/objects/PaymentSessionNextAction) * [PaymentSessionStateBuyerActionRequired](https://shopify.dev/docs/api/payments-apps/2025-10/objects/PaymentSessionStateBuyerActionRequired) * [PaymentSessionStateConfirming](https://shopify.dev/docs/api/payments-apps/2025-10/objects/PaymentSessionStateConfirming) * [PaymentSessionStatePending](https://shopify.dev/docs/api/payments-apps/2025-10/objects/PaymentSessionStatePending) * [PaymentSessionStateRedirecting](https://shopify.dev/docs/api/payments-apps/2025-10/objects/PaymentSessionStateRedirecting) * [PaymentSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-10/objects/PaymentSessionStateRejected) * [PaymentSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-10/objects/PaymentSessionStateResolved) * [QueryRoot](https://shopify.dev/docs/api/payments-apps/2025-10/objects/QueryRoot) * [RefundSession](https://shopify.dev/docs/api/payments-apps/2025-10/objects/RefundSession) * [RefundSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-10/objects/RefundSessionStateRejected) * [RefundSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-10/objects/RefundSessionStateResolved) * [VerificationSession](https://shopify.dev/docs/api/payments-apps/2025-10/objects/VerificationSession) * [VerificationSessionActionsRedirect](https://shopify.dev/docs/api/payments-apps/2025-10/objects/VerificationSessionActionsRedirect) * [VerificationSessionNextAction](https://shopify.dev/docs/api/payments-apps/2025-10/objects/VerificationSessionNextAction) * [VerificationSessionStateRedirecting](https://shopify.dev/docs/api/payments-apps/2025-10/objects/VerificationSessionStateRedirecting) * [VerificationSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-10/objects/VerificationSessionStateRejected) * [VerificationSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-10/objects/VerificationSessionStateResolved) * [VoidSession](https://shopify.dev/docs/api/payments-apps/2025-10/objects/VoidSession) * [VoidSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-10/objects/VoidSessionStateRejected) * [VoidSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-10/objects/VoidSessionStateResolved) * Platform * Queries * [publicApiVersions](https://shopify.dev/docs/api/payments-apps/2025-10/queries/publicApiVersions) * Objects * [ApiVersion](https://shopify.dev/docs/api/payments-apps/2025-10/objects/ApiVersion) * GraphQL Types * Enums * [CaptureSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/CaptureSessionRejectUserErrorCode) * [CaptureSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/CaptureSessionResolveUserErrorCode) * [CaptureSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/CaptureSessionStateCode) * [CaptureSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2025-10/enums/CaptureSessionStateRejectedReason) * [CaptureSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/CaptureSessionStatusReasonRejectionCode) * [DigitalWallet](https://shopify.dev/docs/api/payments-apps/2025-10/enums/DigitalWallet) * [PaymentSessionCardNotPresentAvsResultCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/PaymentSessionCardNotPresentAvsResultCode) * [PaymentSessionCardNotPresentCvvResultCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/PaymentSessionCardNotPresentCvvResultCode) * [PaymentSessionConfirmUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/PaymentSessionConfirmUserErrorCode) * [PaymentSessionModalUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/PaymentSessionModalUserErrorCode) * [PaymentSessionNextActionAction](https://shopify.dev/docs/api/payments-apps/2025-10/enums/PaymentSessionNextActionAction) * [PaymentSessionPendingUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/PaymentSessionPendingUserErrorCode) * [PaymentSessionRedirectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/PaymentSessionRedirectUserErrorCode) * [PaymentSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/PaymentSessionStateCode) * [PaymentSessionStatePendingReason](https://shopify.dev/docs/api/payments-apps/2025-10/enums/PaymentSessionStatePendingReason) * [PaymentSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2025-10/enums/PaymentSessionStateRejectedReason) * [PaymentSessionThreeDSecureAuthenticationFlow](https://shopify.dev/docs/api/payments-apps/2025-10/enums/PaymentSessionThreeDSecureAuthenticationFlow) * [PaymentSessionThreeDSecureChargebackLiability](https://shopify.dev/docs/api/payments-apps/2025-10/enums/PaymentSessionThreeDSecureChargebackLiability) * [PaymentSessionThreeDSecurePartnerError](https://shopify.dev/docs/api/payments-apps/2025-10/enums/PaymentSessionThreeDSecurePartnerError) * [PaymentSessionThreeDSecureTransStatus](https://shopify.dev/docs/api/payments-apps/2025-10/enums/PaymentSessionThreeDSecureTransStatus) * [PaymentSessionThreeDSecureVersion](https://shopify.dev/docs/api/payments-apps/2025-10/enums/PaymentSessionThreeDSecureVersion) * [RefundSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/RefundSessionRejectUserErrorCode) * [RefundSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/RefundSessionResolveUserErrorCode) * [RefundSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/RefundSessionStateCode) * [RefundSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2025-10/enums/RefundSessionStateRejectedReason) * [RefundSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/RefundSessionStatusReasonRejectionCode) * [VerificationSessionCardBrandInput](https://shopify.dev/docs/api/payments-apps/2025-10/enums/VerificationSessionCardBrandInput) * [VerificationSessionNextActionAction](https://shopify.dev/docs/api/payments-apps/2025-10/enums/VerificationSessionNextActionAction) * [VerificationSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/VerificationSessionStateCode) * [VerificationSessionStateReason](https://shopify.dev/docs/api/payments-apps/2025-10/enums/VerificationSessionStateReason) * [VerificationSessionThreeDSecureAuthenticationFlow](https://shopify.dev/docs/api/payments-apps/2025-10/enums/VerificationSessionThreeDSecureAuthenticationFlow) * [VerificationSessionThreeDSecureChargebackLiability](https://shopify.dev/docs/api/payments-apps/2025-10/enums/VerificationSessionThreeDSecureChargebackLiability) * [VerificationSessionThreeDSecurePartnerError](https://shopify.dev/docs/api/payments-apps/2025-10/enums/VerificationSessionThreeDSecurePartnerError) * [VerificationSessionThreeDSecureTransStatus](https://shopify.dev/docs/api/payments-apps/2025-10/enums/VerificationSessionThreeDSecureTransStatus) * [VerificationSessionThreeDSecureVersion](https://shopify.dev/docs/api/payments-apps/2025-10/enums/VerificationSessionThreeDSecureVersion) * [VerificationSessionUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/VerificationSessionUserErrorCode) * [VoidSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/VoidSessionRejectUserErrorCode) * [VoidSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/VoidSessionResolveUserErrorCode) * [VoidSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/VoidSessionStateCode) * [VoidSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2025-10/enums/VoidSessionStateRejectedReason) * [VoidSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2025-10/enums/VoidSessionStatusReasonRejectionCode) * Input objects * [CaptureSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/CaptureSessionRejectionReasonInput) * [External](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/External) * [ModalAction](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/ModalAction) * [PaymentSessionCardNotPresentInput](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/PaymentSessionCardNotPresentInput) * [PaymentSessionPaymentDetails](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/PaymentSessionPaymentDetails) * [PaymentSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/PaymentSessionRejectionReasonInput) * [PaymentSessionThreeDSecureAuthentication](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/PaymentSessionThreeDSecureAuthentication) * [PaymentSessionThreeDSecureAuthenticationData](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/PaymentSessionThreeDSecureAuthenticationData) * [QrCode](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/QrCode) * [RefundSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/RefundSessionRejectionReasonInput) * [VerificationSessionAddressInput](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/VerificationSessionAddressInput) * [VerificationSessionCardInput](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/VerificationSessionCardInput) * [VerificationSessionPaymentDetailsInput](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/VerificationSessionPaymentDetailsInput) * [VerificationSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/VerificationSessionRejectionReasonInput) * [VerificationSessionThreeDSecureAuthentication](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/VerificationSessionThreeDSecureAuthentication) * [VerificationSessionThreeDSecureAuthenticationData](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/VerificationSessionThreeDSecureAuthenticationData) * [VoidSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-10/input-objects/VoidSessionRejectionReasonInput) * Interfaces * [CaptureSessionState](https://shopify.dev/docs/api/payments-apps/2025-10/interfaces/CaptureSessionState) * [DisplayableError](https://shopify.dev/docs/api/payments-apps/2025-10/interfaces/DisplayableError) * [PaymentSessionState](https://shopify.dev/docs/api/payments-apps/2025-10/interfaces/PaymentSessionState) * [RefundSessionState](https://shopify.dev/docs/api/payments-apps/2025-10/interfaces/RefundSessionState) * [VerificationSessionState](https://shopify.dev/docs/api/payments-apps/2025-10/interfaces/VerificationSessionState) * [VoidSessionState](https://shopify.dev/docs/api/payments-apps/2025-10/interfaces/VoidSessionState) * Objects * [CaptureSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2025-10/objects/CaptureSessionRejectUserError) * [CaptureSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2025-10/objects/CaptureSessionResolveUserError) * [PaymentSessionConfirmUserError](https://shopify.dev/docs/api/payments-apps/2025-10/objects/PaymentSessionConfirmUserError) * [PaymentSessionModalUserError](https://shopify.dev/docs/api/payments-apps/2025-10/objects/PaymentSessionModalUserError) * [PaymentSessionPendingUserError](https://shopify.dev/docs/api/payments-apps/2025-10/objects/PaymentSessionPendingUserError) * [PaymentSessionRedirectUserError](https://shopify.dev/docs/api/payments-apps/2025-10/objects/PaymentSessionRedirectUserError) * [RefundSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2025-10/objects/RefundSessionRejectUserError) * [RefundSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2025-10/objects/RefundSessionResolveUserError) * [UserError](https://shopify.dev/docs/api/payments-apps/2025-10/objects/UserError) * [VerificationSessionUserError](https://shopify.dev/docs/api/payments-apps/2025-10/objects/VerificationSessionUserError) * [VoidSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2025-10/objects/VoidSessionRejectUserError) * [VoidSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2025-10/objects/VoidSessionResolveUserError) * Payloads * [CaptureSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-10/payloads/CaptureSessionRejectPayload) * [CaptureSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-10/payloads/CaptureSessionResolvePayload) * [PaymentsAppConfigurePayload](https://shopify.dev/docs/api/payments-apps/2025-10/payloads/PaymentsAppConfigurePayload) * [PaymentSessionConfirmPayload](https://shopify.dev/docs/api/payments-apps/2025-10/payloads/PaymentSessionConfirmPayload) * [PaymentSessionModalPayload](https://shopify.dev/docs/api/payments-apps/2025-10/payloads/PaymentSessionModalPayload) * [PaymentSessionPendingPayload](https://shopify.dev/docs/api/payments-apps/2025-10/payloads/PaymentSessionPendingPayload) * [PaymentSessionRedirectPayload](https://shopify.dev/docs/api/payments-apps/2025-10/payloads/PaymentSessionRedirectPayload) * [PaymentSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-10/payloads/PaymentSessionRejectPayload) * [PaymentSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-10/payloads/PaymentSessionResolvePayload) * [RefundSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-10/payloads/RefundSessionRejectPayload) * [RefundSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-10/payloads/RefundSessionResolvePayload) * [VerificationSessionRedirectPayload](https://shopify.dev/docs/api/payments-apps/2025-10/payloads/VerificationSessionRedirectPayload) * [VerificationSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-10/payloads/VerificationSessionRejectPayload) * [VerificationSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-10/payloads/VerificationSessionResolvePayload) * [VoidSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-10/payloads/VoidSessionRejectPayload) * [VoidSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-10/payloads/VoidSessionResolvePayload) * Scalars * [Boolean](https://shopify.dev/docs/api/payments-apps/2025-10/scalars/Boolean) * [DateTime](https://shopify.dev/docs/api/payments-apps/2025-10/scalars/DateTime) * [ID](https://shopify.dev/docs/api/payments-apps/2025-10/scalars/ID) * [JSON](https://shopify.dev/docs/api/payments-apps/2025-10/scalars/JSON) * [String](https://shopify.dev/docs/api/payments-apps/2025-10/scalars/String) * [URL](https://shopify.dev/docs/api/payments-apps/2025-10/scalars/URL) * Unions * [CaptureSessionStates](https://shopify.dev/docs/api/payments-apps/2025-10/unions/CaptureSessionStates) * [PaymentSessionNextActionContext](https://shopify.dev/docs/api/payments-apps/2025-10/unions/PaymentSessionNextActionContext) * [PaymentSessionStates](https://shopify.dev/docs/api/payments-apps/2025-10/unions/PaymentSessionStates) * [RefundSessionStates](https://shopify.dev/docs/api/payments-apps/2025-10/unions/RefundSessionStates) * [VerificationSessionNextActionContext](https://shopify.dev/docs/api/payments-apps/2025-10/unions/VerificationSessionNextActionContext) * [VerificationSessionStates](https://shopify.dev/docs/api/payments-apps/2025-10/unions/VerificationSessionStates) * [VoidSessionStates](https://shopify.dev/docs/api/payments-apps/2025-10/unions/VoidSessionStates)