PaymentMethod

Describes a payment method.

Type Definition


type PaymentMethod {
  title: String
  shortDescription: String
  description: String
  logo: String
}

Fields

Field	Type	Nullable	Description	Relationships
`title`	String	Yes	Returns the title.	None
`shortDescription`	String	Yes	Returns the short description.	None
`description`	String	Yes	Returns the description.	None
`logo`	String	Yes	Returns the logo. Typically a URL or base64 string representing the payment method’s logo.	None

Relationships

The PaymentMethod type does not have explicit relationships to other object types. It serves as a standalone object describing payment method details.

Usage Examples

Basic Query


{
  paymentMethods {
    title
    shortDescription
    description
    logo
  }
}

Field Selection


{
  paymentMethods {
    title
    logo
  }
}

Nested Queries

The PaymentMethod type contains only scalar fields and does not include nested object fields.

Filtering and Sorting

Filtering and sorting are not directly applicable on the PaymentMethod fields as defined. These operations should be applied on the parent query or connection returning PaymentMethod objects, if supported.

Implements

The PaymentMethod type does not implement any interfaces.

Connections

No connections are defined for PaymentMethod.

No related types are explicitly linked to PaymentMethod in the schema.

Best Practices

When querying for payment methods, select only the fields you need to optimize response size and improve performance.
Use the logo field to display payment method icons in your UI for better user experience.
Since all fields are optional, always implement null checks in your client code to avoid runtime errors.
If your application supports multiple payment methods, consider caching the payment methods list to reduce repeated API calls.

Notes

All fields in PaymentMethod are optional and may return null if data is unavailable.
The API currently requires no authentication, but this may change in future versions. Design your integrations to handle authentication gracefully when it is introduced.
The logo field typically contains a URL string pointing to the payment method’s icon image; ensure your client handles image loading errors.
No computed or derived fields are defined on this type.
No field arguments are available for PaymentMethod fields.