Skip to main content

payment

Retrieve detailed information about a specific payment.

Returns comprehensive payment data including transaction details, payment status, and processing information. Used for payment tracking, order management, and financial reporting. Automatically includes transaction details for complete financial context.

Possible errors:

  • GET_PAYMENT_ERROR: Failed to retrieve payment information due to system error
  • PAYMENT_NOT_FOUND_ERROR: Payment with the specified search criteria does not exist
  • FORBIDDEN: Insufficient permissions to access payment data

AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER]

payment(
  searchBy: SearchByInput!
): Payment

Arguments​

payment.searchBy ● SearchByInput! non-null input​

Search criteria for finding the payment.

Specifies how to identify the payment (by ID, payment ID, or order ID) for retrieval.

Type​

Payment object​

Payment record representing a financial transaction for order processing.

Manages payment lifecycle from creation through completion, including amount tracking, currency handling, and payment method processing. Supports multiple payment states and transaction history for comprehensive financial management.