The Authorization transaction enables you to confirm that a customer has submitted a valid payment method with their order and has sufficient funds to purchase the goods or services they ordered. Setting the < allowPartialAuth > element to true in the Authorization request enables the system to return authorizations for a portion of the order amount for cases where the card does not have an adequate credit limit or balance available for the full amount.
An approved Authorization reduces the customer's credit limit (or bank balance, in the case of a debit card) by the amount of the approval by placing the amount on hold. If you have the Prepaid Indicator feature enabled, the Authorization response also includes an element that indicates if the card is Prepaid, as well as an element indicating the available balance on the card.
| Ruby Example | PHP Example | Java Example |.NET Example |
The primary use of Authorization Reversal transactions is to eliminate any unused amount on an unexpired Authorization. Issuing an Authorization Reversal has the benefit of freeing any remaining held amount that reduces the buying power of your customer. Potentially, this both increases customer satisfaction and can allow them to proceed with additional purchases that may otherwise be blocked by credit limits. It also helps you avoid any misuse of Auth fees imposed by the card associations.
Note: For American Express transactions, the reversal amount must match the authorization amount. Partial reversals and reversals against remaining amount after a partial capture are not allowed. Attempts to perform these types of reversals result in a Response Code of 336 - Reversal amount does not match Authorization amount.
| Ruby Example | PHP Example | Java Example |.NET Example |
An AVS Only transaction is a variation of an Authorization transaction that uses the Address Verification System to enable you to verify that a customer supplied address matches the billing address associated with the card. To submit an AVS Only transaction, submit an Authorization transaction with the <amount> element set to 000 and the optional billToAddress element with appropriate child values.
| Ruby Example | PHP Example | Java Example |.NET Example |
Similar to a Capture transaction, you use a Capture Given Auth transaction to transfer previously authorized funds from the customer to you after fulfillment. However, you typically use a Capture Given Auth transaction if the associated Authorization occurred outside of the our system (for example, if you received a telephone Authorization). Another possible use for a Capture Given Auth transaction is if the Authorization transaction occurred within our system, but the litletxnId is unknown by the submitting party (for example, if the Auth was submitted by a merchant, but a fulfiller submits a Capture Given Auth).
You use a Capture transaction to transfer previously authorized funds from the customer to you after order fulfillment. You can submit a Capture transaction for the full amount of the Authorization, or for a lesser amount by setting the partial attribute to true.
| Ruby Example | PHP Example | Java Example |.NET Example |
You use a Credit transaction to refund money to a customer, even if the original transaction occurred outside of our system. You can submit refunds against any of the following payment transactions:
| Ruby Example | PHP Example | Java Example |.NET Example |
A Force Capture transaction is a Capture transaction used when you do not have a valid Authorization for the order, but have fulfilled the order and wish to transfer funds.
Caution: Merchants must be authorized by us before processing this transaction. In some instances, using a Force Capture transaction can lead to chargebacks and fines.
| Ruby Example | PHP Example | Java Example |.NET Example |
The Sale transaction enables you to both authorize fund availability and deposit those funds by means of a single transaction. The Sale transaction is also known as a conditional deposit, because the deposit takes place only if the authorization succeeds. If the authorization is declined, the deposit will not be processed.
| Ruby Example | PHP Example | Java Example |.NET Example |
Note: If the authorization succeeds, the deposit will be processed automatically, regardless of the AVS or CVV2 response.
The Void transaction enables you to cancel any settlement transaction as long as the transaction has not yet settled. Voids require a reference to a litleTxnId. Example transactions that can be referenced by a Void include Sale, Capture and Refund.
| Ruby Example | PHP Example | Java Example |.NET Example |
Note: Do not use Void transactions to void an Authorization. To remove an Authorization send an Authorization reversal transaction (see Authorization Reversal Transaction above)
You can find detailed information about our API in our integration guide
