---
title: String - Payments Apps API
description: Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.
api_version: 2025-10
api_name: payments-apps
type: scalar
api_type: graphql
source_url:
  html: https://shopify.dev/docs/api/payments-apps/latest/scalars/String
  md: https://shopify.dev/docs/api/payments-apps/latest/scalars/String.md
---

# String

scalar

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

## Map

### Fields with this scalar

* <-|[Api​Version.displayName](https://shopify.dev/docs/api/payments-apps/latest/objects/ApiVersion#field-ApiVersion.fields.displayName)
* <-|[Api​Version.handle](https://shopify.dev/docs/api/payments-apps/latest/objects/ApiVersion#field-ApiVersion.fields.handle)
* <-|[Capture​Session​Reject​User​Error.field](https://shopify.dev/docs/api/payments-apps/latest/objects/CaptureSessionRejectUserError#field-CaptureSessionRejectUserError.fields.field)
* <-|[Capture​Session​Reject​User​Error.message](https://shopify.dev/docs/api/payments-apps/latest/objects/CaptureSessionRejectUserError#field-CaptureSessionRejectUserError.fields.message)
* <-|[Capture​Session​Resolve​User​Error.field](https://shopify.dev/docs/api/payments-apps/latest/objects/CaptureSessionResolveUserError#field-CaptureSessionResolveUserError.fields.field)
* <-|[Capture​Session​Resolve​User​Error.message](https://shopify.dev/docs/api/payments-apps/latest/objects/CaptureSessionResolveUserError#field-CaptureSessionResolveUserError.fields.message)
* <-|[Capture​Session​State​Rejected.merchantMessage](https://shopify.dev/docs/api/payments-apps/latest/objects/CaptureSessionStateRejected#field-CaptureSessionStateRejected.fields.merchantMessage)
* <-|[Payment​Session​Confirm​User​Error.field](https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentSessionConfirmUserError#field-PaymentSessionConfirmUserError.fields.field)
* <-|[Payment​Session​Confirm​User​Error.message](https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentSessionConfirmUserError#field-PaymentSessionConfirmUserError.fields.message)
* <-|[Payment​Session​Modal​User​Error.field](https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentSessionModalUserError#field-PaymentSessionModalUserError.fields.field)
* <-|[Payment​Session​Modal​User​Error.message](https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentSessionModalUserError#field-PaymentSessionModalUserError.fields.message)
* <-|[Payment​Session​Pending​User​Error.field](https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentSessionPendingUserError#field-PaymentSessionPendingUserError.fields.field)
* <-|[Payment​Session​Pending​User​Error.message](https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentSessionPendingUserError#field-PaymentSessionPendingUserError.fields.message)
* <-|[Payment​Session​Redirect​User​Error.field](https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentSessionRedirectUserError#field-PaymentSessionRedirectUserError.fields.field)
* <-|[Payment​Session​Redirect​User​Error.message](https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentSessionRedirectUserError#field-PaymentSessionRedirectUserError.fields.message)
* <-|[Payment​Session​State​Rejected.merchantMessage](https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentSessionStateRejected#field-PaymentSessionStateRejected.fields.merchantMessage)
* <-|[Payments​App​Configuration.externalHandle](https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentsAppConfiguration#field-PaymentsAppConfiguration.fields.externalHandle)
* <-|[Refund​Session​Reject​User​Error.field](https://shopify.dev/docs/api/payments-apps/latest/objects/RefundSessionRejectUserError#field-RefundSessionRejectUserError.fields.field)
* <-|[Refund​Session​Reject​User​Error.message](https://shopify.dev/docs/api/payments-apps/latest/objects/RefundSessionRejectUserError#field-RefundSessionRejectUserError.fields.message)
* <-|[Refund​Session​Resolve​User​Error.field](https://shopify.dev/docs/api/payments-apps/latest/objects/RefundSessionResolveUserError#field-RefundSessionResolveUserError.fields.field)
* <-|[Refund​Session​Resolve​User​Error.message](https://shopify.dev/docs/api/payments-apps/latest/objects/RefundSessionResolveUserError#field-RefundSessionResolveUserError.fields.message)
* <-|[Refund​Session​State​Rejected.merchantMessage](https://shopify.dev/docs/api/payments-apps/latest/objects/RefundSessionStateRejected#field-RefundSessionStateRejected.fields.merchantMessage)
* <-|[User​Error.field](https://shopify.dev/docs/api/payments-apps/latest/objects/UserError#field-UserError.fields.field)
* <-|[User​Error.message](https://shopify.dev/docs/api/payments-apps/latest/objects/UserError#field-UserError.fields.message)
* <-|[Verification​Session​User​Error.field](https://shopify.dev/docs/api/payments-apps/latest/objects/VerificationSessionUserError#field-VerificationSessionUserError.fields.field)
* <-|[Verification​Session​User​Error.message](https://shopify.dev/docs/api/payments-apps/latest/objects/VerificationSessionUserError#field-VerificationSessionUserError.fields.message)
* <-|[Void​Session​Reject​User​Error.field](https://shopify.dev/docs/api/payments-apps/latest/objects/VoidSessionRejectUserError#field-VoidSessionRejectUserError.fields.field)
* <-|[Void​Session​Reject​User​Error.message](https://shopify.dev/docs/api/payments-apps/latest/objects/VoidSessionRejectUserError#field-VoidSessionRejectUserError.fields.message)
* <-|[Void​Session​Resolve​User​Error.field](https://shopify.dev/docs/api/payments-apps/latest/objects/VoidSessionResolveUserError#field-VoidSessionResolveUserError.fields.field)
* <-|[Void​Session​Resolve​User​Error.message](https://shopify.dev/docs/api/payments-apps/latest/objects/VoidSessionResolveUserError#field-VoidSessionResolveUserError.fields.message)

### Inputs with this scalar

* [Capture​Session​Rejection​Reason​Input.merchantMessage](https://shopify.dev/docs/api/payments-apps/latest/input-objects/CaptureSessionRejectionReasonInput#fields-merchantMessage)
* [Payment​Session​Rejection​Reason​Input.merchantMessage](https://shopify.dev/docs/api/payments-apps/latest/input-objects/PaymentSessionRejectionReasonInput#fields-merchantMessage)
* [Payment​Session​Three​DSecure​Authentication​Data.transStatusReason](https://shopify.dev/docs/api/payments-apps/latest/input-objects/PaymentSessionThreeDSecureAuthenticationData#fields-transStatusReason)
* [Payment​Session​Three​DSecure​Authentication​Data.dsTransactionId](https://shopify.dev/docs/api/payments-apps/latest/input-objects/PaymentSessionThreeDSecureAuthenticationData#fields-dsTransactionId)
* [Qr​Code.code](https://shopify.dev/docs/api/payments-apps/latest/input-objects/QrCode#fields-code)
* [Refund​Session​Rejection​Reason​Input.merchantMessage](https://shopify.dev/docs/api/payments-apps/latest/input-objects/RefundSessionRejectionReasonInput#fields-merchantMessage)
* [Verification​Session​Address​Input.givenName](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionAddressInput#fields-givenName)
* [Verification​Session​Address​Input.familyName](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionAddressInput#fields-familyName)
* [Verification​Session​Address​Input.line1](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionAddressInput#fields-line1)
* [Verification​Session​Address​Input.line2](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionAddressInput#fields-line2)
* [Verification​Session​Address​Input.city](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionAddressInput#fields-city)
* [Verification​Session​Address​Input.postalCode](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionAddressInput#fields-postalCode)
* [Verification​Session​Address​Input.province](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionAddressInput#fields-province)
* [Verification​Session​Address​Input.countryCode](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionAddressInput#fields-countryCode)
* [Verification​Session​Address​Input.phoneNumber](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionAddressInput#fields-phoneNumber)
* [Verification​Session​Address​Input.company](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionAddressInput#fields-company)
* [Verification​Session​Card​Input.descriptor](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionCardInput#fields-descriptor)
* [Verification​Session​Card​Input.bin](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionCardInput#fields-bin)
* [Verification​Session​Card​Input.last4](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionCardInput#fields-last4)
* [Verification​Session​Card​Input.dynamicLast4](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionCardInput#fields-dynamicLast4)
* [Verification​Session​Card​Input.expirationMonth](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionCardInput#fields-expirationMonth)
* [Verification​Session​Card​Input.expirationYear](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionCardInput#fields-expirationYear)
* [Verification​Session​Card​Input.cardHolderName](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionCardInput#fields-cardHolderName)
* [Verification​Session​Card​Input.issuerName](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionCardInput#fields-issuerName)
* [Verification​Session​Card​Input.networkTransactionId](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionCardInput#fields-networkTransactionId)
* [Verification​Session​Three​DSecure​Authentication​Data.transStatusReason](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VerificationSessionThreeDSecureAuthenticationData#fields-transStatusReason)
* [Void​Session​Rejection​Reason​Input.merchantMessage](https://shopify.dev/docs/api/payments-apps/latest/input-objects/VoidSessionRejectionReasonInput#fields-merchantMessage)

### Arguments with this scalar

* <-|[payment​Session​Resolve.networkTransactionId](https://shopify.dev/docs/api/payments-apps/latest/mutations/paymentSessionResolve#arguments-networkTransactionId)
* <-|[payments​App​Configure.externalHandle](https://shopify.dev/docs/api/payments-apps/latest/mutations/paymentsAppConfigure#arguments-externalHandle)