The Preauthorization object

Description

The Preauthorization object enables you to reserve funds on a card so they can be captured later. A preauthorization thus has two parts:

  • Authorization of the transaction, handled by the Preauthorization object
  • Capture of the funds, handled by the Preauthorized PayIn object

The preauthorized funds can be captured within 6.5 days of a successful authorization.

If you require a hold period of longer than 6.5 days, see the Deposit Preauthorization object.

Note that preauthorizations may not be permitted by some issuers and for some card types.

Note – Multi-capture available with Visa, Mastercard, CB, and AMEX

Multiple partial captures of the preauthorized amount is possible on the card types:

  • CB_VISA_MASTERCARD
  • AMEX

Further captures of the RemainingFunds can be made if the PaymentStatus is WAITING.

There is no limit to the number of captures that can be made if each is valid.

Attributes

IdstringOptional
TagstringOptional
CreationDateintegerOptional
AuthorIdstringOptional
The unique identifier of the user at the source of the transaction.
FlowDescriptorobjectOptional
DebitedFundsobjectOptional
Information about the preauthorized funds.
RemainingFundsobjectOptional
Information about the remaining preauthorized funds.
AuthorizationDateintegerOptional
StatusstringOptional
PaymentStatusstringOptional
ExpirationDateintegerOptional
PayInIdstringOptional
ResultCodestringOptional
ResultMessagestringOptional
The explanation of the result code.
SecureModestringOptional
CardIdstringOptional
The unique identifier of the Card object, obtained during the card registration process.
SecureModeReturnURLstringOptional
SecureModeRedirectURLstringOptional
SecureModeNeededbooleanOptional
PaymentTypestringOptional
ExecutionTypestringOptional
StatementDescriptorstringOptional
CulturestringOptional
SecurityInfoobjectOptional
MultiCapturebooleanOptional
BrowserInfoobjectOptional
IpAddressstringOptional
The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.
BillingobjectOptional
ShippingobjectOptional
Requested3DSVersionstringOptional
Applied3DSVersionstringOptional
PreferredCardNetworkstringOptional
PaymentCategorystringOptional
CardInfoobjectOptional
AuthenticationResultobjectOptional