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

POInvoiceAuthorizationRequest

data class POInvoiceAuthorizationRequest constructor(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 for invoice authorization.

Parameters

invoiceId

Identifier of invoice to authorize.

source

Payment source to use for authorization.

saveSource

Indicates whether we should save the payment source by creating a customer token during the authorization. Default value is false.

incremental

Indicates whether authorization is incremental. Default value is false.

enableThreeDS2

Indicates that request is coming directly from the frontend. It is used to understand if we can instantly step-up to 3DS. Value is always 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

Indicates whether transaction blocking should be applied due to MasterCard Merchant Advice Code. 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. Note: Preferably set auto capture date when creating the invoice.

captureAmount

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

authorizeOnly

Indicates that payment should be authorized without capturing. Note: You must capture the payment on the server if you use this option. Value is always true.

allowFallbackToSale

Indicates whether the payment 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

Operation metadata.

Constructors

POInvoiceAuthorizationRequest

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

Request parameters for invoice authorization.

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)