Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

capturePaymentStep - Medusa Core Workflows Reference

This documentation provides a reference to the capturePaymentStep. It belongs to the @medusajs/medusa/core-flows package.

This step captures a payment.

src/workflows/my-workflow.ts
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { capturePaymentStep } from "@medusajs/medusa/core-flows"3
4const myWorkflow = createWorkflow(5  "my-workflow",6  () => {7    const data = capturePaymentStep({8      "payment_id": "{value}"9    })10  }11)

Input#

CapturePaymentStepInputCapturePaymentStepInput
payment_idstring
The ID of the payment to capture.
captured_bystringOptional
The ID of the user that captured the payment.
amountBigNumberInputOptional
The amount to capture. If not provided, the full payment amount will be captured.

Output#

PaymentDTOPaymentDTO
idstring
The ID of the payment.
amountBigNumberValue
The payment's total amount.
currency_codestring
The ISO 3 character currency code of the payment.
provider_idstring
The ID of the associated payment provider.
payment_collection_idstring
The ID of the associated payment collection.
raw_amountBigNumberValueOptional
The raw amount of the payment.
authorized_amountBigNumberValueOptional
The authorized amount of the payment.
raw_authorized_amountBigNumberValueOptional
The raw authorized amount of the payment.
dataRecord<string, unknown>Optional
The data relevant for the payment provider to process the payment.
created_atstring | DateOptional
When the payment was created.
updated_atstring | DateOptional
When the payment was updated.
captured_atstring | DateOptional
When the payment was captured.
canceled_atstring | DateOptional
When the payment was canceled.
captured_amountBigNumberValueOptional
The sum of the associated captures' amounts.
raw_captured_amountBigNumberValueOptional
The sum of the associated captures' raw amounts.
refunded_amountBigNumberValueOptional
The sum of the associated refunds' amounts.
raw_refunded_amountBigNumberValueOptional
The sum of the associated refunds' raw amounts.
capturesCaptureDTO[]Optional
The associated captures.
refundsRefundDTO[]Optional
The associated refunds.
payment_collectionPaymentCollectionDTOOptional
The associated payment collection.
payment_sessionPaymentSessionDTOOptional
The payment session from which the payment is created.
Was this page helpful?