Authorize a payment
Manually authorize a payment using a provided processor. This is useful if you want to authorize a payment without a workflow action. The processor merchant ID must be provided which can be found on the Integrations page. The processor name is optional but it must be provided if your account has multiple processors configured which share the same merchant IDs.
The unique payment ID.
You can use this ID to retrieve the payment details, or perform downstream operations.
See the payment status table for more information.
The 3-letter currency code in ISO 4217 format.
USD for US dollars.
Additional data to be used throughout the payment lifecycle.
The payment method options provided in the request, as well as the token used to process the payment.
More information associated with the payment processor, including the processor name.
Required action to perform in order to resume the payment workflow. This can be requiring a 3DS check from the customer for instance.
Check this field for more information regarding the payment's status. This is especially useful when the status is
A list summarizing the transactions that occurred while processing the payment.
Note: a refund is a separate transaction and so will appear in this
transactions list if a refund was performed.