sdk/com.processout.sdk.api.model.request/POInvoiceAuthorizationRequest

POInvoiceAuthorizationRequest

data class POInvoiceAuthorizationRequest(val invoiceId: String, val source: String, val saveSource: Boolean = false, val incremental: Boolean = false, val enableThreeDS2: Boolean = true, val preferredScheme: String? = null, val thirdPartySdkVersion: String? = null, val invoiceDetailsIds: List<String>? = null, val overrideMacBlocking: Boolean = false, val initialSchemeTransactionId: String? = null, val autoCaptureAt: Date? = null, val captureAmount: String? = null, val authorizeOnly: Boolean = true, val allowFallbackToSale: Boolean = false, val clientSecret: String? = null, val metadata: Map<String, String>? = null)

Request parameters used for invoice authorization.

Parameters

invoiceId

Invoice identifier to authorize.

source

Payment source to use for authorization.

saveSource

If you want us to save the payment source by creating a customer token during the authorization. Only supported with card payment source.

incremental

Boolean value indicating if authorization is incremental. Default value is false.

enableThreeDS2

Boolean value indicating whether 3DS2 is enabled. Default value is true.

preferredScheme

Card scheme or co-scheme that should get priority if it is available.

thirdPartySdkVersion

Can be used for a 3DS2 request to indicate which third party SDK is used for the call.

invoiceDetailsIds

Can be used to to provide specific ids to indicate which of items provided in invoice details list are subject to capture.

overrideMacBlocking

Allows to specify if transaction blocking due to MasterCard Merchant Advice Code should be applied or not. Default value is false.

initialSchemeTransactionId

Allows to specify which scheme ID to use for subsequent CIT/MITs if applicable.

autoCaptureAt

You can set this property to arrange for the payment to be captured automatically after a time delay.

captureAmount

Amount of money to capture when partial captures are available. Note that this only applies if you are also using the autoCaptureAt option.

authorizeOnly

Boolean value indicating whether should only authorize the invoice or also capture it. Default value is true.

allowFallbackToSale

Boolean value indicating whether should fallback to sale if the gateway does not support separation between authorization and capture. Default value is false.

clientSecret

Client secret is a value of x-processout-client-secret header of the invoice.

metadata

Additional metadata.

Constructors

POInvoiceAuthorizationRequest

constructor(invoiceId: String, source: String, saveSource: Boolean = false, incremental: Boolean = false, enableThreeDS2: Boolean = true, preferredScheme: String? = null, thirdPartySdkVersion: String? = null, invoiceDetailsIds: List<String>? = null, overrideMacBlocking: Boolean = false, initialSchemeTransactionId: String? = null, autoCaptureAt: Date? = null, captureAmount: String? = null, authorizeOnly: Boolean = true, allowFallbackToSale: Boolean = false, clientSecret: String? = null, metadata: Map<String, String>? = null)