Charges
Last Updated:What's in this article?
Creates a new authorization / charge. For credit cards, by default, the authorization will be captured into the current batch.
A charge can be from one of the following types of sources:
- Credit Card: This requires passing fields with credit card data.
- DAF Card: This requires passing fields with DAF card data.
- Credit Card Magstripe: This requires passing magstripe data from a swiped credit card.
- Check / ACH
- Source: This includes charging based on a previous transaction, a stored payment method, a token, or a nonce.
- Digital Wallet: An encrypted token containing payment data from a digital wallet provider.
For check transactions, this request requires the Check Charge permission on the source key. For CC transactions, if capture is false, it requires the Auth Only permission, otherwise, it requires the Charge permission.
AUTHORIZATIONS:
REQUEST BODY SCHEMA: application/json
| amount required | Transaction amount in USD. If a mandatory surcharge is set by the ISO/MSP, the actual amount charged could be different than the amount submitted in this field. The revised amounts will be returned in the response. The |
| card required | Card number |
| expiry_month required | Card expiration month. If using a card token, send any valid month. |
| expiry_year required | Card expiration year. If using a card token, send any valid year. |
| amount_details | Breakdown of the amount. These fields do not affect the actual transaction amount and are for reporting and Level 3 only. |
| name | string <= 255 characters Name on payment method (credit card or check). |
| transaction_details | object Additional optional transaction details. |
| line_items | Line item details for Level 3 data. The data will not be checked for accuracy, e.g. if the totals add up correctly. |
| billing_info | object (Address) |
| shipping_info | object (Address) |
| custom_fields | object (CustomFields) |
| ignore_duplicates | Determines whether to override any duplicate transactions detection. |
| customer | object |
| transaction_flags | These flags provide more details about the transaction. Although they are optional, is recommended they be sent, to ensure optimal approval rates. |
| avs_address | Billing address for the card. |
| avs_zip | Billing zip code for the card. While not required, this field should be populated for fraud prevention and to obtain the best rate for E-commerce credit card transactions. |
| cvv2 | Security code, otherwise known as CVC or CID. For Amex, this is the 4 digit code on the front of the card. For other card brands, this is the 3 digit code on the back. While not required, this field should be populated for fraud prevention. |
| 3d_secure | object Data for 3D-Secure (Verified by Visa, MasterCard SecureCode, Amex SafeKey, Discover ProtectBuy). These values come from a 3rd party 3D-Secure provider. Note: 3D-Secure is only applicable for e-Commerce merchants. Only 3D-Secure version 2 is supported. |
| capture | Whether to capture the authorization into the current batch. |
| save_card | If set to true and the transaction has been approved, the system will issue a token for future use. |