Stripe

How to enable Stripe Credit Card on a merchant.

Stripe provides a suite of payment processing solutions and a powerful API to manage transactions online. It supports direct payouts and offers features like one-time payments, recurring billing, and subscription management. Stripe offers the option of using a Restricted API Key,for which specific permissions must be enabled to ensure seamless processing of transactions and reversals. The restricted key limits access to only the permissions necessary for Authvia’s functionality, helping maintain security and compliance. You cam create the restricted API key from your Stripe Dashboard.

Required Permissions:

Write Access

  • Customers - Allows Authvia to create and manage customer profiles within Stripe.
  • Payment Intents - Enables Authvia to initiate, authorize, capture, and reverse transactions.
  • Payment Methods - Allows the creation and management of payment methods used for processing transactions. Read Access
  • Events - Required for reading webhook events and monitoring transaction updates.
  • Reporting - Allows retrieval of reporting data related to transaction activity and reconciliation.

Note: These permissions represent the minimum access necessary for Authvia to perform core payment operations (authorization, capture, refund, and reversal) through Stripe. Restricting additional permissions beyond this list may prevent certain transaction workflows from functioning correctly.

Features

Refund A creditcard payment processed with can be / according to its status. ✅ Payment Authorization Payments can be authorized by customers using Credit Card. ✅ Payment Capture Payment authorizations made using Credit Card payment methods can be captured. This step happens automatically with CHARGE transactions.

Resources

Configuration

To start accepting payments with Stripe, sign up for an account at Stripe's dashboard. Once registered, navigate to the API section to obtain your API keys. Integrate these keys into your payment setup by following the detailed guidance provided in the Stripe API documentation.

This table describes the required or possible attributes needed to configure a merchant product for this type.

NameTypeDescriptionRules
authTokenstringAuth token for authenticating requests to Stripe. Examples: abcd1234.
connectedAccountIdstringStripe Connect account ID for handling transactions on behalf of a connected account. Examples: efgh4321.

Enabling this Product

Using create-merchant-product API you can add a new product to your merchant record. Below is an example configuration for the payload of that request.

{
  "line": "payments",
  "product": "creditcard",
  "provider": "stripe",
  "config": {
    "authToken": "abcd1234",
    "connectedAccountId": "efgh4321"
},
  
}

Data Mapping

The following bullet points outline the mapping of data fields between the Authvia platform and the system, detailing the correspondence of specific attributes for seamless data integration.

  • Authvia transaction.reference.external maps to description
  • Authvia transaction.id maps to metadata.transactionId
  • Authvia transaction.description maps to UNMAPPED
  • Authvia merchant.id maps to UNMAPPED