If you have successfully authorized a payment, you can now
fully capture, or partially capture funds from the authorized payment, depending
on whether your selected payment processor supports it. The payment will
be updated to SETTLED
or SETTLING
, depending on the payment method type.
The payload sent in this capture request is completely optional. If you don’t send a payload with the capture request, the full amount that was authorized will be sent for capture. Below are the available payload attributes, which give you more granular control when capturing funds, if you require it.
The amount you would like to capture, in minor units. The currency used on authorization is assumed.
If no amount is specified it defaults to the full amount.
Indicates whether the capture request is the final capture request.
After a final capture, no subsequent captures are allowed.
Additional payment metadata. This only takes effect if the payment was created via the New Workflows (read more here). A dictionary of key-value pairs where the values can only be strings or integers. Keys which already exist in the payment metadata will be overwritten.
The unique payment ID.
You can use this ID to retrieve the payment details, or perform downstream operations.
The type of card token used for the payment.
Only applies for card payments.
Check this field for more information regarding the payment’s status. This is especially useful when the status is DECLINED
or FAILED
.
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.