Storefront.PaymentQuery (buy3 9.0.1 API)

java.lang.Object
- <any>
- - com.shopify.buy3.Storefront.PaymentQuery

Enclosing class:: Storefront

public static class Storefront.PaymentQuery
extends <any>

A payment applied to a checkout.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Storefront.PaymentQuery`	`amount()` Deprecated. Use `amountV2` instead
`Storefront.PaymentQuery`	`amountV2(Storefront.MoneyV2QueryDefinition queryDef)` The amount of the payment.
`Storefront.PaymentQuery`	`billingAddress(Storefront.MailingAddressQueryDefinition queryDef)` The billing address for the payment.
`Storefront.PaymentQuery`	`checkout(Storefront.CheckoutQueryDefinition queryDef)` The checkout to which the payment belongs.
`Storefront.PaymentQuery`	`creditCard(Storefront.CreditCardQueryDefinition queryDef)` The credit card used for the payment in the case of direct payments.
`Storefront.PaymentQuery`	`errorMessage()` A message describing a processing error during asynchronous processing.
`Storefront.PaymentQuery`	`idempotencyKey()` A client-side generated token to identify a payment and perform idempotent operations.
`Storefront.PaymentQuery`	`nextActionUrl()` The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.
`Storefront.PaymentQuery`	`ready()` Whether or not the payment is still processing asynchronously.
`Storefront.PaymentQuery`	`test()` A flag to indicate if the payment is to be done in test mode for gateways that support it.
`Storefront.PaymentQuery`	`transaction(Storefront.TransactionQueryDefinition queryDef)` The actual transaction recorded by Shopify after having processed the payment with the gateway.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - amount
```
@Deprecated
public Storefront.PaymentQuery amount()
```
    Deprecated. Use `amountV2` instead
    
    The amount of the payment.
  - amountV2
```
public Storefront.PaymentQuery amountV2(Storefront.MoneyV2QueryDefinition queryDef)
```
    The amount of the payment.
  - billingAddress
```
public Storefront.PaymentQuery billingAddress(Storefront.MailingAddressQueryDefinition queryDef)
```
    The billing address for the payment.
  - checkout
```
public Storefront.PaymentQuery checkout(Storefront.CheckoutQueryDefinition queryDef)
```
    The checkout to which the payment belongs.
  - creditCard
```
public Storefront.PaymentQuery creditCard(Storefront.CreditCardQueryDefinition queryDef)
```
    The credit card used for the payment in the case of direct payments.
  - errorMessage
```
public Storefront.PaymentQuery errorMessage()
```
    A message describing a processing error during asynchronous processing.
  - idempotencyKey
```
public Storefront.PaymentQuery idempotencyKey()
```
    A client-side generated token to identify a payment and perform idempotent operations. For more information, refer to [Idempotent requests](https://shopify.dev/concepts/about-apis/idempotent-requests).
  - nextActionUrl
```
public Storefront.PaymentQuery nextActionUrl()
```
    The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.
  - ready
```
public Storefront.PaymentQuery ready()
```
    Whether or not the payment is still processing asynchronously.
  - test
```
public Storefront.PaymentQuery test()
```
    A flag to indicate if the payment is to be done in test mode for gateways that support it.
  - transaction
```
public Storefront.PaymentQuery transaction(Storefront.TransactionQueryDefinition queryDef)
```
    The actual transaction recorded by Shopify after having processed the payment with the gateway.

Class Storefront.PaymentQuery

Method Summary

Methods inherited from class java.lang.Object

Method Detail

amount

amountV2

billingAddress

checkout

creditCard

errorMessage

idempotencyKey

nextActionUrl

ready

test

transaction