Transaction
Transaction: Submit For Settlement
If you do not use the Options.SubmitForSettlement option with
Transaction: Sale
, then you will have to explicitly submit the transaction for settlement.
Refer to the Transaction response object for more information.
- DOTNET
Result<Transaction> result = gateway.Transaction.SubmitForSettlement("the_transaction_id");
if (result.IsSuccess()) {
Transaction settledTransaction = result.Target;
} else {
Console.WriteLine(result.Errors);
}
Arguments
Amount
, DecimalAn amount to submit for settlement. Must be greater than 0. 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.
If you settle an amount that is less than what was authorized, the transaction object will return the amount settled.
TransactionId
required, stringauthorized
for settlement.Additional Parameters
Dynamic descriptors are not enabled on all accounts by default. If you receive a validation error of 92203
or if your dynamic descriptors are not displaying as expected, please contact us.
Dynamic descriptors are sent on a per-transaction basis and define what will appear on your customers' credit card statements for a specific purchase. The clearer the description of your product, the less likely customers will issue chargebacks due to confusion or non-recognition.
See the dynamic descriptor example for additional information.
DiscountAmount
DecimalA Level 3 field that specifies the discount amount that was included in the total transaction amount. It can't be negative, and it does not add to the total transaction amount. This Braintree line-item field is not used by PayPal.
The line items for this transaction. It can include up to 249 line items. If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf.
CommodityCode
stringDescription
stringDiscountAmount
DecimalKind
stringIndicates whether the line item is a debit (sale) or credit (refund) to the customer. Accepted values:
"debit"
"credit"
Name
stringProductCode
stringQuantity
DecimalTotalAmount
DecimalUnitAmount
DecimalUnitOfMeasure
stringUnitTaxAmount
DecimalUpcCode
stringUpcType
stringUPC type for the item. If specified, you must also provide the UPC code. Accepted values:
"UPC-A"
"UPC-B"
"UPC-C"
"UPC-D"
"UPC-E"
"UPC-2"
"UPC-5"
Url
stringOrderId
stringPurchaseOrderNumber
stringA Level 2 field that can be used to pass a purchase order identification value of up to 12 ASCII characters for AIB and 17 ASCII characters for all other processors.
Company
stringCountryCodeAlpha2
stringThe ISO 3166-1 alpha-2 country code specified in an address. The gateway only accepts specific alpha-2 values.
CountryCodeAlpha3
stringThe ISO 3166-1 alpha-3 country code specified in an address. The gateway only accepts specific alpha-3 values.
CountryCodeNumeric
stringThe ISO 3166-1 numeric country code specified in an address. The gateway only accepts specific numeric values.
CountryName
stringThe country name specified in an address. We only accept specific country names.
ExtendedAddress
stringFirstName
stringCountryCode
stringNationalNumber
stringLastName
stringLocality
stringPhoneNumber
stringDeprecated.
We recommend using international_phone
. This functionality still exists in the gateway but is no longer documented. This parameter will be removed in the future.
PostalCode
stringRegion
stringStreetAddress
stringShippingAddressId
stringShippingAmount
DecimalA Level 3 field that specifies the shipping cost on the entire transaction. It can't be negative, and it does not add to the total transaction amount.
ShippingTaxAmount
DecimalA Level 3 field that specifies the amount of tax that was charged on the . The value can't be negative, and in most cases, it must be greater than zero if the shipping amount is greater than zero. It does not add to the total transaction amount.
ShipsFromPostalCode
stringA Level 3 field that specifies the postal code of the shipping location.
TaxAmount
DecimalA Level 2 field that specifies the amount of tax that was included in the total transaction amount. The value can't be negative, and in most cases, it must be greater than zero in order to qualify for lower interchange rates. It does not add to the total transaction amount.
TaxExempt
boolA Level 2 field that indicates whether or not the transaction should be considered eligible for tax exemption. This does not affect the total transaction amount.
Examples
Specifying settlement amount
If you want to settle for an amount that is different from the total authorization amount, you can specify the amount to settle. If you do not specify, the entire amount will be settled.
You can only submit for settlement for an amount that is less than the total authorization amount one time. To submit more than once, you will need to use multiple partial settlements; this method is available for PayPal and Venmo transactions, and some credit card transactions for select merchants.
Authorization adjustments
For eligible merchants, authorization adjustments occur automatically when you submit for settlement for an amount greater or less than the original authorized amount.
Each adjustment attempt is recorded as an adjustment detail , which is returned on the transaction response object. Adjustment details allow you to determine decline responses and track the overall success rate of auth adjustments.
You can account for real-time decline responses in the form of validation errors.
If you have questions regarding auth adjustment eligibility or functionality, please contact us for details.
Availability
Authorization adjustments are available for select merchants and processors. See our support articles for details.
- C#
Result<Transaction> result = gateway.Transaction.SubmitForSettlement("the_transaction_id", Decimal.Parse("35.00"));
Specifying Level 2 and 3 data
In some cases, transaction amounts, and by extension Level 2 and 3 parameters, are not finalized until the transaction is ready to be submitted for settlement. This functionality allows you to apply Level 2 and 3 parameters when submitting a transaction for settlement instead of specifying them in the transaction sale call.
Level 2 and 3 data provided via submit for settlement will override all Level 2 and 3 data previously provided in a sale request. If you wish to pass Level 2 and 3 data, we recommend utilizing either transaction.sale or transaction.submit_for_settlement, but not both at the same time.
Availability
Level 2 and 3 processing via submit for settlement requires internal approval. Please contact us if you’re interested in this functionality. See our Level 2 and 3 processing overview for more details.
- C#
TransactionRequest submitForSettlementRequest = new TransactionRequest
{
PurchaseOrderNumber = "12345",
TaxAmount = 5.00M,
ShippingAmount = 1.00M,
DiscountAmount = 0.00M,
ShipsFromPostalCode = "60654",
LineItems = new TransactionLineItemRequest[]
{
new TransactionLineItemRequest
{
Name = "Product",
LineItemKind = TransactionLineItemKind.DEBIT,
Quantity = 10.0000M,
UnitAmount = 9.5000M,
UnitOfMeasure = "unit",
TotalAmount = 95.00M,
TaxAmount = 5.00M,
DiscountAmount = 0.00M,
ProductCode = "54321",
CommodityCode = "98765"
}
}
TaxAmount = "5.00"
};
Result<Transaction> result = gateway.Transaction.SubmitForSettlement("the_transaction_id", submitForSettlementRequest);
if (result.IsSuccess())
{
var transaction = result.Target;
} else {
System.Console.WriteLine(result.Message);
}
Shipping address information
In some cases, the shipping address information cannot be determined until the transaction is ready to be submitted for settlement. This functionality allows you to apply shipping address fields when submitting a transaction for settlement instead of specifying them in the transaction sale call. If shipping address parameters are applied via submit for settlement, they will override any corresponding shipping address parameters applied on the sale. We recommend using either transaction.sale or transaction.submit_for_settlement to send shipping address parameters, but not both at the same time.
Shipping address includes the Level 3 fields ShippingAddress.PostalCode and ShippingAddress.CountryCodeAlpha3.
Availability
Sending shipping address fields via submit for settlement requires internal approval. Please contact us if you're interested in this functionality.
Specifying order ID
You can pass additional information about a transaction by adding the OrderId when submitting the transaction for settlement.
- C#
TransactionRequest submitForSettlementRequest = new TransactionRequest
{
OrderId = "order_id"
};
Result<Transaction> result = gateway.Transaction.SubmitForSettlement("the_transaction_id", submitForSettlementRequest);
if (result.IsSuccess())
{
var transaction = result.Target;
} else {
System.Console.WriteLine(result.Message);
}