Loading...
Was this page helpful?
Loading...
authorizePaymentSessionStep - Medusa Core Workflows Reference
This documentation provides a reference to the authorizePaymentSessionStep. It belongs to the @medusajs/medusa/core-flows package.
This step authorizes a payment session.
Example#
Input#
AuthorizePaymentSessionStepInputAuthorizePaymentSessionStepInputThe data to authorize the payment session.
AuthorizePaymentSessionStepInputAuthorizePaymentSessionStepInputidstringThe ID of the payment session to authorize.
idstringcontextRecord<string, unknown>OptionalThe context to authorize the payment session with.
This context is passed to the payment provider associated with the payment session.
contextRecord<string, unknown>OptionalOutput#
PaymentDTOPaymentDTO
PaymentDTOPaymentDTOidstringThe ID of the payment.
idstringamountBigNumberValueThe payment's total amount.
amountBigNumberValuecurrency_codestringThe ISO 3 character currency code of the payment.
currency_codestringprovider_idstringThe ID of the associated payment provider.
provider_idstringpayment_collection_idstringThe ID of the associated payment collection.
payment_collection_idstringThe raw amount of the payment.
The authorized amount of the payment.
The raw authorized amount of the payment.
dataRecord<string, unknown>OptionalThe data relevant for the payment provider to process the payment.
dataRecord<string, unknown>Optionalcreated_atstring | DateOptionalWhen the payment was created.
created_atstring | DateOptionalupdated_atstring | DateOptionalWhen the payment was updated.
updated_atstring | DateOptionalcaptured_atstring | DateOptionalWhen the payment was captured.
captured_atstring | DateOptionalcanceled_atstring | DateOptionalWhen the payment was canceled.
canceled_atstring | DateOptional