Skip to main content
Anchor to ShopPayPaymentRequestReceipt

ShopPayPaymentRequestReceipt

object

The receipt of Shop Pay payment request session submission.

Anchor to FieldsFields

Anchor to createdAtcreatedAt
•DateTime!
non-null

The date and time when the payment request receipt was created.

Anchor to orderorder
•Order

The order that's associated with the payment request receipt.

Anchor to paymentRequestpaymentRequest
•ShopPayPaymentRequest!
non-null

The shop pay payment request object.

Anchor to processingStatusprocessingStatus
•ShopPayPaymentRequestReceiptProcessingStatus!
non-null

The status of the payment request session submission.

Anchor to sourceIdentifiersourceIdentifier
•String!
non-null

The source identifier provided in the ShopPayPaymentRequestSessionCreate mutation.

Anchor to tokentoken
•String!
non-null

The token of the receipt, initially returned by an ShopPayPaymentRequestSessionSubmit mutation.

Was this section helpful?

Anchor to QueriesQueries

Anchor to shopPayPaymentRequestReceiptshopPayPaymentRequestReceipt
•query

Returns a single Shop Pay payment request receipt by its ID. Payment request receipts document completed Shop Pay transactions, including the amount, customer details, and payment status. Use this to look up a specific Shop Pay transaction for order reconciliation or customer support.

Arguments

Anchor to tokentoken
•String!
required

Unique identifier of the payment request receipt.

Anchor to shopPayPaymentRequestReceiptsshopPayPaymentRequestReceipts
•query

Returns a paginated list of Shop Pay payment request receipts for the shop. Each receipt documents a completed Shop Pay transaction. Use this to review Shop Pay transaction history, generate reports, or audit Shop Pay payment activity.

Arguments

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at
•time

Filter by the creation date of the payment request receipt.

Example:

  • created_at:2021-01-01
  • created_at:2021-01-01..2021-01-02
  • created_at:<now
  • created_at:<2024-01-01
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to source_identifier
•string

Filter by the source identifier of the payment request receipt.

Example:

  • source_identifier:1282823
Anchor to state
•string

Filter by the state of the payment request receipt. Options include: - COMPLETED - FAILED - PENDING - PROCESSING

Example:

  • state:COMPLETED
Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•ShopPayPaymentRequestReceiptsSortKeys
Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Was this section helpful?