- Payment Methods
- Tokenized credit card expiry notifications
- Cardholder Initiated Transactions (CIT) and Merchant Initiated Transactions (MIT) for Visa, MasterCard, and Discover
- Soft descriptor support
- 3D Secure (3DS) authentication
- Recurring Flag
- Transaction Reference IDs
- Card Verification Value (CVV)/ Address Verification Service (AVS) Configuration
- $0 Authorizations / Authorization reversals
- Merchant Account ID for Multiple Currency Support
- Tokenized ACH Payments
The following pay methods and card types are supported by Braintree:
|Tokenized Credit Card||MasterCard|
Tokenized Credit Card Expiration Notifications
Aria will store the last four digits of a credit card along with the card’s expiration dates (month and year) from the tokenized credit card being used for a transaction. These details need to be received as inputs along with the < bill_agreement_id> from the following parameters:
If these details are not received as inputs, then Aria will collect this info from the payment gateways using the <bill_agreement_id>. The credit card expiry notification emails will be sent for accounts where <pay_method_type> is 13.
Aria now sends the recurring flag indicators to Braintree to identify transactions that are associated with subscription-based billing. This is required to comply with Visa and Mastercard’s rules that apply to Braintree. The recurring flag values are the following:
- 0: do not return
- 1: return
Cardholder Initiated Transactions (CIT) and Merchant Initiated Transactions Support for Visa, MasterCard, and Discover
This feature sends flags distinguishing CIT and MIT within the <recurring_processing_model_ind> parameter of the following API calls:
The input values for the <recurring_processing_model_ind> are the following:
- 0: Cardholder-Initiated Transaction—Credentials on File: a credit card transaction initiated by the cardholder for a new order or a plan upgrade that uses a credit card that is currently stored in Aria. (Default)
- 1: Cardholder-Initiated Transaction—a credit card transaction initiated by the cardholder for a new account or creating an order that uses an alternate credit card that is not currently stored in Aria.
- 2: Merchant-Initiated Transaction—Standing Instruction – Recurring: a credit card transaction initiated by Aria’s clients for a recurring charge that uses a credit card that is currently stored in Aria.
- 3: Merchant-Initiated Transaction—Unscheduled Credentials on File: a credit card transaction initiated by Aria’s clients for a non-recurring charge (one-time order or plan upgrade) that uses a credit card that is currently stored in Aria.
The output field is <proc_initial_auth_txn_id>. This feature is available for Visa, MasterCard, and Discover.
This is the transaction description appearing on the buyer's credit card statement that displays a Merchant Name or Item Description.
To configure, navigate to the dialog below as follows: Configuration > Payments > Payment Gateways > Field Options:
3D Secure Authentication
Aria supports 3D Secure authentication for payment transactions processed through the Braintree Payment Gateway. When using the authorize_electronic_payment_m or update_payment_method_m call for tokenized cards or credit cards the following are the steps to take:
Step 1: Invoke the authorize_electronic_payment_m API with the credit card details, billing information and <attempt_3D_secure> as true.
Step 2: The API will return the client_auth_token and cc_single_use_token within the <proc_3dsecure_data> output.
Step 3: Use the client_auth_token, cc_single_use_token, and transaction amount to invoke the 3D Secure authentication page. Once the information is entered, press Submit.
Step 4: The 3D Secure authentication page will pop up, prompting for the password associated with the card. Please note, the merchant, amount, date, card number and username will populate on this screen. Once the password is entered, press Submit.
Step 5: The 3DS Nonce will display on the HTML page along with the 3DS Status as “authenticate_successful”.
Step 6: Call authorize_3dsecure_m and enter the 3DS Nonce in the <proc_field_name> field and verify authentication.
Step 7: Call collect_from_account_m and verify the collection amount is the same as the amount authorized.
3D Secure – Direct Post
Step 1: Within the direct post page, enter the collection amount, billing details, credit card details and <attempt_3d_secure> as true and press Submit.
Step 2: You will be redirected to the 3D Secure authentication page provided by the issuing bank to enter the password. Once the password is entered, press Submit.
Step 3: The response of this transaction will display “authenticate_successful”. Now that the transaction is authenticated, you will be able to use your direct post configuration settings to collection the payment by credit card or tokenized credit card.
Transaction Reference IDs (Failed Transactions)
Aria will parse unique transaction reference IDs returned from Braintree in the <proc_payment_id> parameter for declined transactions. Transactions include but are not limited to the following:
- Balance Inquires
If no reference ID is returned from Braintree, Aria returns a NULL value for <proc_payment_id>. The following API calls include the <proc_payment_id> output parameter:
Card Verification Value (CVV)/ Address Verification Service (AVS) Configuration
With the Braintree integration, error codes can be returned by Aria for a specific CVV response. This configuration lies within the Collection Groups and Payment Gateways tabs in the UI (Configuration > Payments). See image below for possible configuration options:
The integration with Braintree also offers Address Verification Service responses. This configuration is also within the Collection Groups and Payment Gateways tabs in the UI (Configuration > Payments). See image below for possible configuration options:
$0 Authorizations / Authorization Reversals
When authorizing a card, Aria provides the option to authorize a $0 or $1 transaction on the card to ensure the card is in good standing prior to offering a service to the account. The system override settings listed in the image below are to reverse the authorizations on the card after the verifications. The settings can be enabled for all or specific card types accepted with this integration. This configuration in the UI is at the Collection Group level (Configuration > Payments > Collection Groups).
Merchant Account ID for Multiple Currency Support
The Merchant Account ID field has been added as part of the Braintree integration for Payment Gateways and Collection Groups within Aria. This allows Braintree clients with international accounts and multiple currencies to be billed using FreshBooks® accounting software. This also allows Braintree to transfer tokens associated with the Merchant ID field. A maximum of 32 alphanumeric characters is allowed at this field.
The Merchant Account ID field is used to identify the currency type of the merchant as part of the Payment Gateway/Collection Group. If no Merchant Account ID is entered, the transaction will process with the default currency configured for the merchant (existing Braintree integration behavior). For example, if USD is the default currency configured for the merchant but GBP is configured at the Merchant Account ID field, Braintree will process the payment with the GBP currency.
This field appears in the Braintree Payment Gateway (Configuration > Payments > Payment Gateways and Configuration > Payments > Collection Groups) as shown below:
Note: The Collection Group configuration takes precedence over the Payment Gateway configuration.
Tokenized ACH Payments
Aria’s integration with the Braintree payment gateway also includes support for Tokenized Automated Clearing House (ACH) payments. ACH payment tokenization adds another level of data security in that sensitive account and number routing data is replaced by a random string of alphanumeric data stored in a reference token. The ACH processor has the full account and routing number securely stored and, using the matching token, processes the ACH transaction.
This payment method can be accessed from the following locations within the Aria application:
- Account Payment Methods (Accounts > [search for an account] > Payment Methods > New Payment Method > Payment Type)
- Billing Groups (Accounts > [search for an account] > Plans > Billing Groups > New Billing Group > Payment Method/Secondary Payment Method)
- Payment Methods (Configuration > Payments > Payment Gateways > Braintree > Field Options)
- Collection Groups (Configuration > Payments > Collection Groups > Braintree > Advanced Options)
Note: To complete the Tokenized ACH payment, configuring notification settings is mandatory in the Braintree Portal. If a client is opting to use the Tokenized ACH payment method for making payments, for the initial online transaction, they will receive the status as “Pending Settlement.“ After 3 to 5 business days, Braintree will move the payment status to “Settled “or “Settlement Declined.“ Aria will be notified only when the following notification URL is configured in the Braintree portal.
The Tokenized ACH payment method is supported by the following APIs:
- Merchant ID: The unique identifier for your Braintree Gateway Account, which is different than your merchant account ID.
- Public Key: A user-specific public identifier.
- Private Key: A user-specific secure identifier that must not be shared, even with Braintree.
Note: These credentials can be found in the Braintree Production Control Panel.
- CVV not provided: To authorize tokenized credit cards, select Ignore Error Code to avoid errors when you call an API to add a token that was previously created outside of Aria.
Regarding Processor/Gateway Integration Certifications
If you previously implemented a custom payment processor/gateway integration, you likely completed a certification process with that processor/gateway. Aria maintains certifications with each of the processors with which it integrates. Though you may wish to certify your Aria-related processor/gateway integration before going live on Aria, this is not necessary and could add significant time and Services costs to your Aria implementation process. Please consult your Aria Implementation representative for more detailed information.
Regarding Processor- and Gateway-specific Information
All Processor- and Gateway-specific information provided on Developer Central exists as publicly accessible information from the respective companies, and is presented here for your convenience. We update this information from time to time as necessary.