Skip to main content
Aria Knowledge Central

Stripe

Stripe is a financial infrastructure platform and a payment processing company that helps businesses accept payments online and in person, as well as manage various financial operations. Stripe allows businesses to build financial technology solutions and launch commercial card programs. Stripe also enables businesses to embed banking services into their platform, handling banking regulations, compliance, and regulatory requirements.

Features

  • Tokenization
  • Credit Card Processing (Authorization, Capture, Cancel, Reversal)
  • Debit Card Processing (Authorization, Capture, Cancel, Reversal)
  • 3DS Secure 1.0/2.0
  • Refunds (Full and Partial)
  • Recurring Transaction Indicators (CIT/MIT)
  • Fraud Scoring
  • Webhook/Event Notifications (Asynchronous Events and Chargeback)
  • Account Updater (Batch or Real Time)
  • Soft Descriptor

UI Configuration

► Merchant Account Details
The Merchant Account Details tab appears as shown:

Stripe_MAD_111126.png

This screen contains the following fields:

Field Description
API URL This is the Stripe endpoint URL used to make API calls. It is required at either the Payment Gateway or Collection Group level. The Collection Group value supersedes the Payment Gateway level value. 
API Secret Key This password is used to make an API call for your account (such as creating changes or performing refunds). New keys are only visible the first time you access them in live mode. If this key is lost, it cannot be recovered and a new key must be created. The API keys are available in the Stripe portal Dashboard.
Account Updater Webhook Key This secret key is used for account updater notifications.
Payment Events Webhook Key

This secret key is used for payment event notifications and is required for authentication.

Note: This field accepts the same alphanumeric values as the Account Updater Webhook Key.

More information on Webhook notifications is here.

► Processing Options
The Processing Options tab appears as shown:

Stripe_PO_111126.png

This screen contains the following fields:

Field Description
Fraud Scoring Options (Payment Gateway and Collection Group levels)
Send Fraud Scoring Request

This parameter governs the behavior to send a request to Stripe to return fraud scoring information. If the Fraud Score response is Failed or Review, Aria will modify the status based on the "Change Status on Fraud Scoring Failure" and "Change Status on Fraud Scoring Review" settings.

API Note

Once the Send Fraud Scoring Request option is enabled, the fraud score and result are returned in the <proc_fraud_score> and <proc_fraud_score_result> output of the validate_acct_fraud_scoring_m API. The possible values in the <proc_fraud_score_result> are:

  • Authorized: Successful (normal or no fraud risk transaction)
  • Manual_Review: Review (elevated risk transaction - increased chance of being fraudulent)
  • Blocked: Failure (transaction getting blocked or failing due to high risk, fraudulent transaction)
Change Status on Fraud Scoring Failure This parameter will change the status on the Master Plan Instance(s) to "Status on Fraud Scoring Failure" if set to True and the Fraud Scoring parameter is enabled and the resultant Fraud Score response is Not Successful.
Status on Fraud Scoring Failure This parameter governs the behavior for changing the status when Fraud Scoring is enabled and Change Status on Fraud Scoring Failure is set to True.
Change Statulorems on Fraud Scoring Review This parameter will change the status on the Master Plan Instance(s) to "Status on Fraud Scoring Review" if set to True and the Fraud Scoring parameter is enabled and the resultant Fraud Score response is "Review."
Status on Fraud Scoring Review This parameter governs the behavior for changing the status when Fraud Scoring is enabled and Change Status on Fraud Scoring Review is set to True.
Recurring Options
Flag Initial Request as Merchant Initiated Transaction This parameter controls whether the initial and subsequent transactions are flagged as Merchant Initiated Transactions (MIT) with off_session. When set to True, all transactions, including the first one, will be processed as an off_session. When set to False, the system will automatically determine the off_session status based on the success count and recurring transaction model mapping.
3DS Authentication Settings
3DS Termination URL

This is the URL the customer will be redirected to after completing the payer authentication.

More information on 3DS is here.

API Note

For the authorize_electronic_payment_m API, the “pa_3ds_termination_url” value in the input parameter <proc_field_override> now overrides the 3DS Termination URL field value at this screen.

Validate card on Token creation
Requires card validation The option to validate a card during token creation using a minimal authorization amount. The default is 'No.' Please note that we will immediately reverse the minimal amount used for verification.
Level2/Level3 Data Options
Send Level2/Level3 Data in the payment request This parameter indicates if Level2/Level3 data will be sent in the payment request. The default is 'No.' By default, Aria will not send the Level2/Level3 fields.
Mandate Collection
Mandate Collection Method

Use this field to specify how the customer will authorize the mandate for direct debit collection. This is required for ACH, SEPA and BACS. If the madate is collected online, the customer IP address and useragent must be collected and passed in the collection API. If offline, you must collect and maintain the authorization for your records.

Additionally SEPA direct debit in Stripe requires this field to be passed in the initial payment request with IBAN.

If the mandate is collected online, the following must be collected and passed in the collection API:

Value Description
IP Address The IP Address from which the Mandate was accepted by the customer.
User Agent The user agent of the browser from which the Mandate was accepted by the customer.

These fields can be sent in the array for API overrides, as shown:

Value Description
mandate_collection_method

By default it will be set to offline.

1 - Online
0 - Offline

end_user_ip_address IP address
end_user_browser_agent Browser user agent

Chargeback Support: Aria will handle the chargeback using a Stripe event received when a SEPA payment is disputed.

Refund Support: Aria supports both partial and full refund functionality for SEPA Direct Debit payments.

► Field Options
The Field Options tab appears as shown:

Stripe_FO_111226.png

This screen contains the following fields:

Field Description
soft_descriptor

Enter the suffix part of the Statement descriptors. Statement descriptors explain charges or payments on customer bank statements, which can be used by merchants to provide more detailed transaction information. Stripe's statement descriptor includes a prefix and suffix separated by an asterisk () and a space to form the descriptor. The total length of the descriptor should not be more than 22 characters, including spaces (for example, "RUNCLUB 9-22-19 10K" or "RUNCLUB*OCT MARATHON".) If the received soft descriptor value is more than 22 characters long, it is truncated to 22 characters before it is sent to the payment processor.

Soft descriptor support is provided at various levels within Aria. The priority is as follows:

  • API
  • Collection Group
  • Payment Gateway

When a transaction occurs using a credit/debit card, the description is displayed under the statement_descriptor_suffix in the Payment Intent of the specific transaction.

Note: The Stripe statement descriptor needs to be 5-22 characters including the *symbol and the space, and cannot contain the characters <, >, \, ', ", or *.

► Accepted Payment Methods
The Accepted Payment Methods tab appears as shown (for Tokenized payments):

Stripe_APM_111126.png
► Smart Payments
The Smart Payments tab appears as shown:

Stripe_SP_111126.png

If the legacy radio button is highlighted in blue at this tab, select the Smart Payments radio button to upgrade from your legacy configuration. If your payment gateway is already configured for Smart Payments, that radio button will be grayed out along with all applicable pay methods for your Smart Payments configuration.

Note: Selecting the radio button to upgrade to Smart Payments is an irreversible, "one and done" step.

Supported Functionality

Additional details on available features

Tokenized Credit Card Support for Smart Payments

The Stripe payment processor is now integrated as part of Aria’s smart payments with this release for the Tokenized Credit Card payment method (pay method 13). The following transactions are supported with this integration: capture, payment, and create/query token.

The following card types are supported:

  • American Express*
  • Diners Club International
  • Discover*
  • Japan Credit Bureau (JCB)*
  • Mastercard*
  • UnionPay
  • Visa*

*-Authorization and Capture/Refunds

For tokens created in Aria, the token/agreement_id is stored in the format “payment_method_id:customer_id” in Aria. For tokens created outside of Aria, you should create both the payment method ID and customer ID and combine them (payment_method_id:customer_id) in the “bill_agreement_id” field. If either the ID is missing or the token is not in a valid format when attempting to process a payment, Aria will generate an error saying "Invalid token. The valid token format is payment_method_id:customer_id."

Limitations:

Since Stripe allows only the token based integration, Aria uses the “payment_method_id” and “customer_id” for making initial/recurring payments; card information is not used for payments. For this reason, we have implemented Tokenized credit card support for Stripe integration. For the token created by Aria, we are creating and storing the token/agreement_id in a format of "payment_method_id:customer_id" in Aria.

Refunds are also supported for the listed card types. At this time, Stripe only supports tokenized credit card refunds.

Cancel/Reverse Authorizations

Stripe supports cancelling/reversing transactions via the UI or APIs using the <auth_no> of the authorized transaction. This applies to any amount greater than 0.

3DS Support

Stripe 3DS versions 1.0 and 2.0 support is now added for Stripe using Aria APIs and Direct Post. To use 3DS, the appropriate URL must be included in the Payer Authentication Settings field in the Payment Gateway and/or Collection Groups UI screens (Configuration > Payments > Payment Gateways/Collection Groups). Otherwise, the transaction will not complete, generating a validation error.

For the 3DS Termination URL, you must specify the Merchant website URL in the Payment Gateway/Collection Group UI Screens (which will be invoked when the shopper challenge is complete). For direct posts, the value should be 'https://secure.<environment>.ariasystems.net/api/auth_3ds2_notification_receiver.php,” where the environment will be different for QU, stage, and production.

Stripe 3DS is a three-step process as shown below:

Step 1: Execute the authorize_electronic_payment_m or update_payment_method_m API with credit card details, billing address details, and <attemt_3d_secure> as 'true' to perform client authentication, and then the API will return the <proc_payment_id> (as the outer level output field) and 'redirect_issuer_url' (value in the proc_3dsecure_data/proc_3dsecure_auth_data array) in the response.

Notes:

  • If the <attempt_3d_secure> input is passed as 'false', then the 3DS flow will be skipped and regular authorization will be invoked here. So, the below steps are not needed.
  • Also, if the supplied credit card is not enrolled with 3DS and if Aria passes the <attempt_3d_secure> input as 'true', then the 3DS flow will be skipped and regular authorization will be invoked; Steps 2 and 3 will be skipped.

Step 2: Use the 'redirect_issuer_url' directly in the browser and execute it. A challenge/redirect window pops up based on the 3DS 2.0 or 3DS 1.0 transaction details, and Aria submits the challenge/redirect form to end step 2.

Step 3: Execute authorize_3dsecure_m with the <proc_pymnt_id> value (from step 1), perform the authorization, and verify the API result to complete the 3ds authentication-based authorization.

Impacted APIs for this functionality include authorize_3dsecure_m, update_payment_method_m, and authorize_electronic_payment_m.

Webhook Notifications

As part of Aria’s Smart Payments integration with the Stripe payment processor, the chargeback Stripe IPN (Instant Payment Notification) charge.dispute.closed event is now supported; for this notification, Aria will update the failure status on the payment and void the transaction records. Additionally, the following five webhook notification event types have been added to track payment status. They are:

Event Description
charge.succeeded The payment succeeded event
charge.refund.updated Refund event
payment_intent.cancelled Authorization Reversal success case
charge.failed The payment failed event
charge.captured Successful payment capture

Additionally, a new REST API handles the following Webhook notifications triggered by the Stripe payment notification service:

  • charge.refunded.updated (for a successfully processed failed refund)
  • charge.succeeded
  • charge.captured
  • charge.failed
  • payment_intent.canceled

Note: When an unsupported event is triggered by Stripe, Aria acknowledges receipt but will not process the event.

Added Array for Micro Deposit Verification URL

Aria continues to enhance its Smart Payments integration with Stripe by adding the <proc_payment_response_field_list> array for all Aria regular and one-time collection APIs in order to return the micro deposit verification URL for ACH payments (at the <proc_payment_response_field_value> parameter of the array).

The array contains the following fields:

Field Value Description
<proc_payment_response_field_list> Payment response fields returned by the processor for further actions if any.

<proc_payment_response_field_name>

Field name of various response returned by the processor, example: micro_deposit_verify_url.

<proc_payment_response_field_value>

Field value for the corresponding payment response field, example: Actual URL to be used for the micro deposit verification.
</proc_payment_response_field_list> End of array

This output array has been added to the following APIs:

Account Updater

Aria also now supports the Stripe Account Updater for the following notification events (for credit cards requiring an update or reaching expiration):

Event Description
payment_method.updated Notifies you of updates to a card through an API call
payment_method.automatically_updated Notifies you of automatic card updates from the network
payment_method.detached Notifies you that the payment method should be disabled in Aria

Note: Aria needs to configure the endpoint URL in the Stripe dashboard for merchants; an example follows:

https://payment-notification-service-idaho-dev-dev0.devfarm.ariasystems.net/api/v1/webhook/account-updater/stripe/client/<client_no>/group/< group_no>

Field Description
client_no Client number is a mandatory input in the endpoint URL.
group_no Collection group number is an optional input; If a collection group number is configured on the endpoint URL in the Stripe Dashboard, then Aria will use the secret key of the respective collection group when verifying Stripe webhook notifications. If a collection group number is not configured on the endpoint URL, the secret key in the payment gateway settings will be used.

SEPA Direct Debit Payments

Stripe now supports SEPA Direct Debit payments, allowing your customers to make recurring payments by providing their SEPA bank account (IBAN) or token to make recurring payments with pay_method = 37 (for the create_acct_complete_m and update_payment_method_m APIs).

For outside tokens, you should set up both the payment method and customer for future usage off-session and combine them (payment_method_id:customer_id) in the  field. If either the ID is missing or the token is not in the valid format, the following error is generated: “Invalid token. The valid token format is payment_method_id:customer_id.

Stripe Support - Recurring Process Model (RPM)

Aria introduces Recurring Process Model (RPM) support for Stripe for the following card types (for pay_method 13 – Tokenized Credit Card):

  • American Express
  • Diners Club International
  • Discover
  • Japan Credit Bureau (JCB)
  • Mastercard
  • Union Pay
  • VISA

Field mapping for the <rpm_ind> input parameter appears below (for the authorize_electronic_payment_m API):

<rpm_ind> initial/subsequent create_payment_intent* field create_payment_intent* field **CIT/MIT
    <setup_future_usage> <off_session>  
0,1,2,3 Initial transaction (successful collection count = 0) off_session N/A Both CIT and MIT
2,3 Subsequent transactions (successful collection count > 0) N/A true MIT

*-create_payment_intent is an API specific to Stripe.

**-Cardholder-Initiated Transactions/Merchant-Initiated Transactions

BACS Direct Debit

Stripe integration now also includes BACS Direct Debit support (for pay method = 37 – Tokenized Direct Debit). BACS is responsible for the clearing and settlement of U.K. automated payment methods.

For this, Aria accepts the webhooks below to get payment status as BACS is an asynchronous payment method:

  • payment_intent.succeeded
  • payment_intent.payment_failed

Mandate:Customer mandate is required. This can be done via offline/online mode. If the mandate is done online, you need to pass the end_user_ip_address and end_user_browser_agent details.

Note: BACS is supported in the U.K. with the GBP currency type only.

ACH Direct Debit

Additionally, Aria’s Stripe integration now includes ACH Direct Debit support (for pay method = 48 – Tokenized ACH).

For this, Aria accepts the webhooks below to get payment status:

  • payment_intent.succeeded
  • payment_intent.payment_failed

Mandate:Customer mandate is required. This can be done via offline/online mode. If the mandate is done online, you need to pass the end_user_ip_address and end_user_browser_agent details.

After an initial payment and Aria receives the micro_deposit_url upon successful microdeposit verification, the payment will be successful.

Refund Support: Aria is supporting both partial and full refund functionality for ACH Direct Debit payments and the “charge.refunded.updated” event is received from Stripe.

Chargeback Support: Aria will handle the chargeback using the Stripe event “charge.dispute.closed” which Aria receives from Stripe when an ACH Payment is disputed.

Note: ACH is supported in the U.S. with the USD currency type only.

Enhanced Error Messaging Added (UI and Selected APIs)

Aria has updated its error messaging for the Stripe payment gateway as part of its Smart Payments integration. This applies to payment token generation errors and payment capture errors within the Aria UI for PCI-compliant payments as well as via Direct Post. The existing error message in the Aria UI will now include the processor error response (e.g., “Your card has insufficient funds.”) along with the notation “could not validate billing information.”

This applies to the following UI screens: 

  • Payment Methods 
  • Add/Edit Billing Group (Primary and Secondary payment method) 
  • Payments 
  • Add Plans (Primary and Secondary payment method) 

In addition to enhanced error messaging for token generation and payment capture errors added for Stripe Smart Payments in the Aria UI, error messaging has also been added for selected APIs. This includes the following: 

  • For the update_payment_method_m API, the existing <proc_status_code> and <proc_status_text> output fields in the collection_info array will now return processor errors for the create token action. 
  • The existing <proc_status_code> and <proc_status_text> fields will now return create token failures for the following APIs: 
  • A new <payment_method_proc_response> output array has been added to return processor errors during payment method creation failures, as follows:
Field Type Description
<payment_method_proc_response> Array The processor-returned response fields at the time of payment method creation failure
  • <payment_method_idx>
Long For non-persistent referencing of a payment method within the API request to be used as the primary or backup payment method on the billing group.
  • <client_payment_method_idx>
String Client-defined unique identifier for the payment method.
  • <proc_status_code>
String The processor status code (including error code).
  • <proc_status_text>
String The processor status description (including error response).

This applies to the following APIs:

TOP
  • Was this article helpful?