See also the Transaction response object.

If you do not use the options.submitForSettlement option with Transaction: Sale, then you will have to explicitly submit the transaction for settlement. If you only want to settle a portion of the total authorization amount, you can specify the amount to settle.

PHP
$result = $gateway->transaction()->submitForPartialSettlement('parent_auth_transaction_id', '35.00');

This method allows you to submit multiple settlements against the same authorization, which is helpful if you send physical goods to customers in multiple shipments. You can create a parent authorization for an entire order amount, and when you’re ready to send each portion of the order, you can charge the customer for that portion in a separate child transaction.

Arguments

authorizedTransaction

Required, string

The transaction ID of the parent authorization. You can only submit transactions that have a status of authorized or settlement_pending for partial settlement.

amount

Required, BigDecimal

An amount to submit for partial settlement against the parent authorization transaction. This amount to be partially settled must be greater than 0. You can make multiple partial settlement calls as long as the cumulative amount to be partially settled is less than or equal to the amount authorized by the parent transaction. You can't settle more than the authorized amount unless your industry and processor support settlement adjustment (settling a certain percentage over the authorized amount); contact us for details.

Transaction settlement

Each partial settlement will create a new child transaction in the gateway with the same details as the original transaction, but with the amount specified in the submitForPartialSettlement call. Once a child transaction is created, the parent will move to a settlement_pending status, whereas the child will move from authorized > submitted_for_settlement > settling > settled.

The parent transaction will move to settled when either of the following is true:

  • All child transactions are settled and the cumulative amount submitted for settlement across all child transactions is equal to the amount authorized on the parent transaction.
  • The original authorization is expired and there are one or more settled child transactions associated with the parent transaction.

Once the parent moves to the settled status, no further settlements can be created on that transaction.

Refunds

  • Once you've submitted a transaction for partial settlement, you can only issue a refund against the child transaction(s).
  • A refund on a child transaction can be up to the amount settled on the child.
  • A refund can be issued only when the corresponding transaction has fully settled and is in a settled state.

Control Panel visibility

The parent and child transactions will appear linked in the Control Panel as Authorized Transaction ID and Settlement Transaction ID, respectively. The parent transaction will show the child transaction(s) under the Settlement Information section on the transaction search in the Control Panel. Similarly, the child transactions will show the parent for authorization information.

See also