--- 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-01/full-index md: https://shopify.dev/docs/api/payments-apps/2025-01/full-index.md --- Congratulations! You've found the page we use to help dumb crawlers find all our API pages. * Common objects * Objects * [MutationRoot](https://shopify.dev/docs/api/payments-apps/2025-01/objects/mutationroot) * Payment Processing * Mutations * [captureSessionReject](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/capturesessionreject) * [captureSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/capturesessionresolve) * [paymentsAppConfigure](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/paymentsappconfigure) * [paymentSessionConfirm](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/paymentsessionconfirm) * [paymentSessionPending](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/paymentsessionpending) * [paymentSessionRedirect](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/paymentsessionredirect) * [paymentSessionReject](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/paymentsessionreject) * [paymentSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/paymentsessionresolve) * [refundSessionReject](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/refundsessionreject) * [refundSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/refundsessionresolve) * [verificationSessionRedirect](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/verificationsessionredirect) * [verificationSessionReject](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/verificationsessionreject) * [verificationSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/verificationsessionresolve) * [voidSessionReject](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/voidsessionreject) * [voidSessionResolve](https://shopify.dev/docs/api/payments-apps/2025-01/mutations/voidsessionresolve) * Objects * [CaptureSession](https://shopify.dev/docs/api/payments-apps/2025-01/objects/capturesession) * [CaptureSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-01/objects/capturesessionstaterejected) * [CaptureSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-01/objects/capturesessionstateresolved) * [PaymentsAppConfiguration](https://shopify.dev/docs/api/payments-apps/2025-01/objects/paymentsappconfiguration) * [PaymentSession](https://shopify.dev/docs/api/payments-apps/2025-01/objects/paymentsession) * [PaymentSessionActionsRedirect](https://shopify.dev/docs/api/payments-apps/2025-01/objects/paymentsessionactionsredirect) * [PaymentSessionNextAction](https://shopify.dev/docs/api/payments-apps/2025-01/objects/paymentsessionnextaction) * [PaymentSessionStateConfirming](https://shopify.dev/docs/api/payments-apps/2025-01/objects/paymentsessionstateconfirming) * [PaymentSessionStatePending](https://shopify.dev/docs/api/payments-apps/2025-01/objects/paymentsessionstatepending) * [PaymentSessionStateRedirecting](https://shopify.dev/docs/api/payments-apps/2025-01/objects/paymentsessionstateredirecting) * [PaymentSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-01/objects/paymentsessionstaterejected) * [PaymentSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-01/objects/paymentsessionstateresolved) * [QueryRoot](https://shopify.dev/docs/api/payments-apps/2025-01/objects/queryroot) * [RefundSession](https://shopify.dev/docs/api/payments-apps/2025-01/objects/refundsession) * [RefundSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-01/objects/refundsessionstaterejected) * [RefundSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-01/objects/refundsessionstateresolved) * [VerificationSession](https://shopify.dev/docs/api/payments-apps/2025-01/objects/verificationsession) * [VerificationSessionActionsRedirect](https://shopify.dev/docs/api/payments-apps/2025-01/objects/verificationsessionactionsredirect) * [VerificationSessionNextAction](https://shopify.dev/docs/api/payments-apps/2025-01/objects/verificationsessionnextaction) * [VerificationSessionStateRedirecting](https://shopify.dev/docs/api/payments-apps/2025-01/objects/verificationsessionstateredirecting) * [VerificationSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-01/objects/verificationsessionstaterejected) * [VerificationSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-01/objects/verificationsessionstateresolved) * [VoidSession](https://shopify.dev/docs/api/payments-apps/2025-01/objects/voidsession) * [VoidSessionStateRejected](https://shopify.dev/docs/api/payments-apps/2025-01/objects/voidsessionstaterejected) * [VoidSessionStateResolved](https://shopify.dev/docs/api/payments-apps/2025-01/objects/voidsessionstateresolved) * Platform * Queries * [publicApiVersions](https://shopify.dev/docs/api/payments-apps/2025-01/queries/publicapiversions) * Objects * [ApiVersion](https://shopify.dev/docs/api/payments-apps/2025-01/objects/apiversion) * GraphQL Types * Enums * [CaptureSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/capturesessionrejectusererrorcode) * [CaptureSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/capturesessionresolveusererrorcode) * [CaptureSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/capturesessionstatecode) * [CaptureSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2025-01/enums/capturesessionstaterejectedreason) * [CaptureSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/capturesessionstatusreasonrejectioncode) * [DigitalWallet](https://shopify.dev/docs/api/payments-apps/2025-01/enums/digitalwallet) * [PaymentSessionConfirmUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/paymentsessionconfirmusererrorcode) * [PaymentSessionNextActionAction](https://shopify.dev/docs/api/payments-apps/2025-01/enums/paymentsessionnextactionaction) * [PaymentSessionPendingUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/paymentsessionpendingusererrorcode) * [PaymentSessionRedirectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/paymentsessionredirectusererrorcode) * [PaymentSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/paymentsessionstatecode) * [PaymentSessionStatePendingReason](https://shopify.dev/docs/api/payments-apps/2025-01/enums/paymentsessionstatependingreason) * [PaymentSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2025-01/enums/paymentsessionstaterejectedreason) * [PaymentSessionThreeDSecureAuthenticationFlow](https://shopify.dev/docs/api/payments-apps/2025-01/enums/paymentsessionthreedsecureauthenticationflow) * [PaymentSessionThreeDSecureChargebackLiability](https://shopify.dev/docs/api/payments-apps/2025-01/enums/paymentsessionthreedsecurechargebackliability) * [PaymentSessionThreeDSecurePartnerError](https://shopify.dev/docs/api/payments-apps/2025-01/enums/paymentsessionthreedsecurepartnererror) * [PaymentSessionThreeDSecureTransStatus](https://shopify.dev/docs/api/payments-apps/2025-01/enums/paymentsessionthreedsecuretransstatus) * [PaymentSessionThreeDSecureVersion](https://shopify.dev/docs/api/payments-apps/2025-01/enums/paymentsessionthreedsecureversion) * [RefundSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/refundsessionrejectusererrorcode) * [RefundSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/refundsessionresolveusererrorcode) * [RefundSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/refundsessionstatecode) * [RefundSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2025-01/enums/refundsessionstaterejectedreason) * [RefundSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/refundsessionstatusreasonrejectioncode) * [VerificationSessionCardBrandInput](https://shopify.dev/docs/api/payments-apps/2025-01/enums/verificationsessioncardbrandinput) * [VerificationSessionNextActionAction](https://shopify.dev/docs/api/payments-apps/2025-01/enums/verificationsessionnextactionaction) * [VerificationSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/verificationsessionstatecode) * [VerificationSessionStateReason](https://shopify.dev/docs/api/payments-apps/2025-01/enums/verificationsessionstatereason) * [VerificationSessionThreeDSecureAuthenticationFlow](https://shopify.dev/docs/api/payments-apps/2025-01/enums/verificationsessionthreedsecureauthenticationflow) * [VerificationSessionThreeDSecureChargebackLiability](https://shopify.dev/docs/api/payments-apps/2025-01/enums/verificationsessionthreedsecurechargebackliability) * [VerificationSessionThreeDSecurePartnerError](https://shopify.dev/docs/api/payments-apps/2025-01/enums/verificationsessionthreedsecurepartnererror) * [VerificationSessionThreeDSecureTransStatus](https://shopify.dev/docs/api/payments-apps/2025-01/enums/verificationsessionthreedsecuretransstatus) * [VerificationSessionThreeDSecureVersion](https://shopify.dev/docs/api/payments-apps/2025-01/enums/verificationsessionthreedsecureversion) * [VerificationSessionUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/verificationsessionusererrorcode) * [VoidSessionRejectUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/voidsessionrejectusererrorcode) * [VoidSessionResolveUserErrorCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/voidsessionresolveusererrorcode) * [VoidSessionStateCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/voidsessionstatecode) * [VoidSessionStateRejectedReason](https://shopify.dev/docs/api/payments-apps/2025-01/enums/voidsessionstaterejectedreason) * [VoidSessionStatusReasonRejectionCode](https://shopify.dev/docs/api/payments-apps/2025-01/enums/voidsessionstatusreasonrejectioncode) * Input objects * [CaptureSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/capturesessionrejectionreasoninput) * [PaymentSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/paymentsessionrejectionreasoninput) * [PaymentSessionThreeDSecureAuthentication](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/paymentsessionthreedsecureauthentication) * [PaymentSessionThreeDSecureAuthenticationData](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/paymentsessionthreedsecureauthenticationdata) * [RefundSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/refundsessionrejectionreasoninput) * [VerificationSessionAddressInput](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/verificationsessionaddressinput) * [VerificationSessionCardInput](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/verificationsessioncardinput) * [VerificationSessionPaymentDetailsInput](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/verificationsessionpaymentdetailsinput) * [VerificationSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/verificationsessionrejectionreasoninput) * [VerificationSessionThreeDSecureAuthentication](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/verificationsessionthreedsecureauthentication) * [VerificationSessionThreeDSecureAuthenticationData](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/verificationsessionthreedsecureauthenticationdata) * [VoidSessionRejectionReasonInput](https://shopify.dev/docs/api/payments-apps/2025-01/input-objects/voidsessionrejectionreasoninput) * Interfaces * [CaptureSessionState](https://shopify.dev/docs/api/payments-apps/2025-01/interfaces/capturesessionstate) * [DisplayableError](https://shopify.dev/docs/api/payments-apps/2025-01/interfaces/displayableerror) * [PaymentSessionState](https://shopify.dev/docs/api/payments-apps/2025-01/interfaces/paymentsessionstate) * [RefundSessionState](https://shopify.dev/docs/api/payments-apps/2025-01/interfaces/refundsessionstate) * [VerificationSessionState](https://shopify.dev/docs/api/payments-apps/2025-01/interfaces/verificationsessionstate) * [VoidSessionState](https://shopify.dev/docs/api/payments-apps/2025-01/interfaces/voidsessionstate) * Objects * [CaptureSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/capturesessionrejectusererror) * [CaptureSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/capturesessionresolveusererror) * [PaymentSessionConfirmUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/paymentsessionconfirmusererror) * [PaymentSessionPendingUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/paymentsessionpendingusererror) * [PaymentSessionRedirectUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/paymentsessionredirectusererror) * [RefundSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/refundsessionrejectusererror) * [RefundSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/refundsessionresolveusererror) * [UserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/usererror) * [VerificationSessionUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/verificationsessionusererror) * [VoidSessionRejectUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/voidsessionrejectusererror) * [VoidSessionResolveUserError](https://shopify.dev/docs/api/payments-apps/2025-01/objects/voidsessionresolveusererror) * Payloads * [CaptureSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/capturesessionrejectpayload) * [CaptureSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/capturesessionresolvepayload) * [PaymentsAppConfigurePayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/paymentsappconfigurepayload) * [PaymentSessionConfirmPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/paymentsessionconfirmpayload) * [PaymentSessionPendingPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/paymentsessionpendingpayload) * [PaymentSessionRedirectPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/paymentsessionredirectpayload) * [PaymentSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/paymentsessionrejectpayload) * [PaymentSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/paymentsessionresolvepayload) * [RefundSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/refundsessionrejectpayload) * [RefundSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/refundsessionresolvepayload) * [VerificationSessionRedirectPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/verificationsessionredirectpayload) * [VerificationSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/verificationsessionrejectpayload) * [VerificationSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/verificationsessionresolvepayload) * [VoidSessionRejectPayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/voidsessionrejectpayload) * [VoidSessionResolvePayload](https://shopify.dev/docs/api/payments-apps/2025-01/payloads/voidsessionresolvepayload) * Scalars * [Boolean](https://shopify.dev/docs/api/payments-apps/2025-01/scalars/boolean) * [DateTime](https://shopify.dev/docs/api/payments-apps/2025-01/scalars/datetime) * [ID](https://shopify.dev/docs/api/payments-apps/2025-01/scalars/id) * [String](https://shopify.dev/docs/api/payments-apps/2025-01/scalars/string) * [URL](https://shopify.dev/docs/api/payments-apps/2025-01/scalars/url) * Unions * [CaptureSessionStates](https://shopify.dev/docs/api/payments-apps/2025-01/unions/capturesessionstates) * [PaymentSessionNextActionContext](https://shopify.dev/docs/api/payments-apps/2025-01/unions/paymentsessionnextactioncontext) * [PaymentSessionStates](https://shopify.dev/docs/api/payments-apps/2025-01/unions/paymentsessionstates) * [RefundSessionStates](https://shopify.dev/docs/api/payments-apps/2025-01/unions/refundsessionstates) * [VerificationSessionNextActionContext](https://shopify.dev/docs/api/payments-apps/2025-01/unions/verificationsessionnextactioncontext) * [VerificationSessionStates](https://shopify.dev/docs/api/payments-apps/2025-01/unions/verificationsessionstates) * [VoidSessionStates](https://shopify.dev/docs/api/payments-apps/2025-01/unions/voidsessionstates)