Split Capture

Background

Merchants need a way to authorize a transaction and, as portions of the order are filled, capture it incrementally. A single authorization would need to be used multiple times and remain open until the order is complete.


Transaction Flow

CC:AuthOnly Transaction

A standard authonly command is executed for the amount to be authorized with no additional flags.

  • For the best merchant experience, it is recommended that the transaction include xRequireSplitCapturable=1, which ensures that the transaction can be split captured. If the flag is sent in on the authorization and the account is not set up to support split capture, the transaction errors with, “Split capture not supported.“ This flag is only supported on cc:authonly transactions.

  • Routing_SplitCapture can be set to route authonly transactions to the split capture engine.
    The routing will only be used on a transaction when xRequireSplitCapturable flag is sent in.

  • If the authorization can be split captured (i.e. the engine and account setup support split captures), the authonly response includes IsSplitCapturable=1.

Transaction Incoming Fields (Specific to Authonly Transactions)

Field

Value

Field

Value

xCommand

cc:authonly

xRequireSplitCapturable

[Optional] flag to require that authorization will be able to be split captured before processing the authorization

xAmount

Amount to be authorized

CC:SplitCapture Transaction

For a single cc:authonly, many cc:splitcapture commands can be executed. Each cc:splitcapturemust specify the amount of the original authorized amount to be captured. The authorization is updated with the ClearedAmount (amount that was successfully captured) and the ClearedCount (count of successful split capture transactions).

Transaction Incoming Fields (Specific to Split Capture Transactions)

Field

Value

Field

Value

xCommand

cc:splitcapture

xRefnum

Reference number of the authonly transaction.

xAmount

Amount to be split captured


Follow Up Transactions

Closing an Authonly Transaction

The user has an option to close an authonly transaction, which will close/cancel the auth, not allowing new transactions to be run with this authorization.

Once the auth has been closed:

  • The status of the auth would be set to AuthCloseTransaction.

  • In the transaction details of the auth, canceled would be set to true.

  • An auth that was already closed would be blocked.

    • "Auth can no longer be closed"

  • A voided auth would be blocked.

    • "Cannot close voided auth"

  • Additional split captures would be blocked.

  • Voids and refunds on the auth would be blocked.

    • Void: "Authorization was closed and can no longer be voided."

    • Refund: "Refund not allowed. Issue refund on split capture transaction."

Field

Value

Field

Value

xCommand

cc:authclose

xRefnum

Reference number of the authonly transaction.

The close command should only be used to close an authorization that has already been split captured. If a merchant wants to close an authorization that has not been split captured yet, the authorization should be voided.

Voids

  • An auth can not be voided/voidrefunded if it was split captured or closed.

    • "Authorization was split captured. Issue refund on split capture transaction."

  • A split capture transaction can not be voided.

    • “Split capture cannot be voided. Issue refund."

Refunds

  • Refunding an authonly transaction:

    • If the authonly was not captured/split captured or closed, refund would be blocked.

      • “Refund not allowed on non-captured auth. Issue void.”

    • Once the authonly has been split captured, refund would be blocked.

      • “Refund not allowed. Issue refund on split capture transaction.”

  • Refunding a split capture transaction:

VoidRefund

  • AuthOnly Transaction

    • If transaction has not been split captured, it will be processed as a void.

    • If transaction has been split captured, this will be blocked.

  • Split Capture Transaction

    • Transaction will be processed as a refund.


Account and Engine Setup

  • See here for engines that support the split capture feature.

  • The dynamo setting, Routing_SplitCapture, can be set to route authonly transactions to the split capture engine when xRequireSplitCapturable flag is enabled on the transaction.

  • oos:validate returns the xSplitCaptureEnabled flag if the feature Routing_SplitCapture is set on the account.


 Reporting

The following fields can be requested on all standard report types. See here for more reportable fields.

Field

Value

Field

Value

xClearedCount

Count of cleared split capture transactions on original auth.

xClearedAmount

Amount that has been split captured on original auth.

xIsSplitCapturable

Specifies whether or not the auth can be split captured.

Report:auth will only display authorizations that have not been closed. It will display authorizations that have been split captured.