Finalize authorization

The Finalize Authorization service is used to finalize all or part of an authorization.

📘
Depending on the payment method this service will have different results. See the following table for information about different payment method types.

Payment method	Result	Comments
Invoice/installments	The order will be activated and the first invoice will be sent out.	Currently, only finalization of the full order amount is supported.
Credit/Debit Cards	The authorization will be captured.	You may finalize an authorization only once. The capture amount must be equal to or less than the original authorized amount.
Internet Banks	This method is not used because internet banks are automatically finalized.

HTTP Request

POST /orders/{orderId}/transactions/{transactionId}/finalize/{totalAmount}

POST /transactions/{transactionId}/finalize/{totalAmount}

📘
Note: When using the REST endpoints, the values supplied in the REST paths do not need to be supplied in the request body/object and will be used instead of values provided in the request body/object.

Request Parameters

Property	Type	Description
`orderId` *conditional*	`guid`	The unique ID you received from Paynova to identify the order. Conditions: > Required if finalizing using order ID. Example: `"1bee7570-76c0-495b-bc0a-a43300d0410c"`
`transactionId` required	`string(18)`	The unique ID of the authorization transaction that you received from Paynova. Example: `"201412161427444300"`
`totalAmount` required	`decimal`	The total amount to finalize. Constraints: Please be sure to use a decimal point as the decimal separator. Commas are not supported. Only two digits may be specified after the decimal point. This must be equal to or less than the original order amount, and less than the original order amount minus any payments which have been already made on the order. For Japanese Yuan (JPY), only whole numbers are allowed. Example: `125.00`
`lineItems` *conditional*	`lineitem`	Line items included in this authorization. Conditions > Line items are only required for detailed orders and when authorizing an amount less than the corresponding payment amount. > Line items are only allowed when the original order was a detailed order. See Orders for more information on detailed vs. simple orders.

Response parameters


`status` required	`status`	API operation status. Example: `{ "isSuccess":true, "errorNumber":0, "statusKey":"SUCCESS", "statusMessage":"The operation was successful." }`
`canFinalizeAgain` required	`boolean`	Indicates whether or not the authorization can accept more finalizations. Example: `true`, `false`
`amountRemainingForFinalize` required	`decimal`	Indicates the amount remaining to be finalized for the authorization. Constraints > If `"canFinalizeAgain"` is `false`, the value for this property will be `0.00`. Example: `0.00`
`transactionId` *conditional*	`string(18)`	Paynova's transaction id for the finalization. Conditions > This parameter will not be returned in error situations. Example: `"201502090957016672"`
`batchId` *conditional*	`string`	Settlement batch ID. Conditions: > Only returned for payment methods which are batched nightly (for example, credit cards). Example: `"268030203046"`
`acquirerId` *conditional*	`string`	Paynova's ID for the acquirer of the transaction. Conditions > This parameter will not be returned in error situations. Example: `"1010"`
`totalAmountFinalized` required	`decimal`	The total amount that has been finalized. Example: `100.0`
`totalAmountPendingFinalization` required	`decimal`	Indicates the amount pending to be finalized for the authorization. Example: `0.00`
`riskAssessment` *conditional*	`string`	Returns the configured mode of the risk assessment and the result. See the RiskAssessment page for possible scenarios. Example: `{ "mode": "Active", "result":"Approved" }`