com.shopify.buy3

Class Storefront.Payment

java.lang.Object

<any>

com.shopify.buy3.Storefront.Payment

All Implemented Interfaces:

Storefront.Node

Enclosing class:

Storefront

public static class Storefront.Payment
extends <any>
implements Storefront.Node

A payment applied to a checkout.

Constructor Summary

Constructors

Constructor and Description
Payment()
Payment(ID id)
Payment(JsonObject fields)

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	getAmount() Deprecated. Use `amountV2` instead
Storefront.MoneyV2	getAmountV2() The amount of the payment.
Storefront.MailingAddress	getBillingAddress() The billing address for the payment.
Storefront.Checkout	getCheckout() The checkout to which the payment belongs.
Storefront.CreditCard	getCreditCard() The credit card used for the payment in the case of direct payments.
java.lang.String	getErrorMessage() A message describing a processing error during asynchronous processing.
java.lang.String	getGraphQlTypeName()
ID	getId() Globally unique identifier.
java.lang.String	getIdempotencyKey() A client-side generated token to identify a payment and perform idempotent operations.
java.lang.String	getNextActionUrl() The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.
java.lang.Boolean	getReady() Whether or not the payment is still processing asynchronously.
java.lang.Boolean	getTest() A flag to indicate if the payment is to be done in test mode for gateways that support it.
Storefront.Transaction	getTransaction() The actual transaction recorded by Shopify after having processed the payment with the gateway.
Storefront.Payment	setAmount(java.math.BigDecimal arg)
Storefront.Payment	setAmountV2(Storefront.MoneyV2 arg)
Storefront.Payment	setBillingAddress(Storefront.MailingAddress arg)
Storefront.Payment	setCheckout(Storefront.Checkout arg)
Storefront.Payment	setCreditCard(Storefront.CreditCard arg)
Storefront.Payment	setErrorMessage(java.lang.String arg)
Storefront.Payment	setIdempotencyKey(java.lang.String arg)
Storefront.Payment	setNextActionUrl(java.lang.String arg)
Storefront.Payment	setReady(java.lang.Boolean arg)
Storefront.Payment	setTest(java.lang.Boolean arg)
Storefront.Payment	setTransaction(Storefront.Transaction arg)
boolean	unwrapsToObject(java.lang.String key)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Payment

public Payment()

Payment

public Payment(JsonObject fields)
        throws SchemaViolationError

Throws:

SchemaViolationError

Payment

public Payment(ID id)

Method Detail

getGraphQlTypeName

public java.lang.String getGraphQlTypeName()

Specified by:

getGraphQlTypeName in interface Storefront.Node

getAmount

public java.math.BigDecimal getAmount()

Deprecated. Use `amountV2` instead

The amount of the payment.

setAmount

public Storefront.Payment setAmount(java.math.BigDecimal arg)

getAmountV2

public Storefront.MoneyV2 getAmountV2()

The amount of the payment.

setAmountV2

public Storefront.Payment setAmountV2(Storefront.MoneyV2 arg)

getBillingAddress

public Storefront.MailingAddress getBillingAddress()

The billing address for the payment.

setBillingAddress

public Storefront.Payment setBillingAddress(Storefront.MailingAddress arg)

getCheckout

public Storefront.Checkout getCheckout()

The checkout to which the payment belongs.

setCheckout

public Storefront.Payment setCheckout(Storefront.Checkout arg)

getCreditCard

public Storefront.CreditCard getCreditCard()

The credit card used for the payment in the case of direct payments.

setCreditCard

public Storefront.Payment setCreditCard(Storefront.CreditCard arg)

getErrorMessage

public java.lang.String getErrorMessage()

A message describing a processing error during asynchronous processing.

setErrorMessage

public Storefront.Payment setErrorMessage(java.lang.String arg)

getId

public ID getId()

Globally unique identifier.

Specified by:

getId in interface Storefront.Node

getIdempotencyKey

public java.lang.String getIdempotencyKey()

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).

setIdempotencyKey

public Storefront.Payment setIdempotencyKey(java.lang.String arg)

getNextActionUrl

public java.lang.String getNextActionUrl()

The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.

setNextActionUrl

public Storefront.Payment setNextActionUrl(java.lang.String arg)

getReady

public java.lang.Boolean getReady()

Whether or not the payment is still processing asynchronously.

setReady

public Storefront.Payment setReady(java.lang.Boolean arg)

getTest

public java.lang.Boolean getTest()

A flag to indicate if the payment is to be done in test mode for gateways that support it.

setTest

public Storefront.Payment setTest(java.lang.Boolean arg)

getTransaction

public Storefront.Transaction getTransaction()

The actual transaction recorded by Shopify after having processed the payment with the gateway.

setTransaction

public Storefront.Payment setTransaction(Storefront.Transaction arg)

unwrapsToObject

public boolean unwrapsToObject(java.lang.String key)