ℹ️Read this First!

Usage Fundamentals

Paytram is used exclusively with Salesforce Screen Flows, so you must have Salesforce Flow skills in order to use Paytram. There are no preconfigured components provided to create payment forms. Instead, you will create payments by creating your own Screen Flows, with your own fields, which can be launched from a record, a Lightning page, or as a scheduled flow.This ensures that Paytram can work with all versions of Salesforce and with your desired workflow.

Paytram Components include:

  • Custom components for use in Screen Flows, consisting of:

    • A secure credit card field component.

    • A Paytram Process Card button to be used in Screen Flows instead of the default Flow ‘Next’’ button.

    • Flows (utilized as Subflows) that perform the actual process of making payments, saving cards, voiding payments, and issuing refunds.

Planning your Screen Flows

When creating your own Screen Flows to use with Paytram, you will always need to include some key data to pass to the Payram Subflow Components. The following table summarizes the most important data points to be mindful of as you set out to design a Screen Flow.

Desired Action:
Data Needed to map to Paytram Components:
Most Likely Next Steps in your Screen Flow:

Charge a new card

Or Authorize a new Charge

  • The Amount to charge/authorize

  • Tokenized credit card number

  • Named Credential

  • External Credential

  • Paytram External Credential

Create a record in Salesforce that represents the charge/authorization that was made (e.g., a Payment record)

Void a charge

  • Transaction ID of the charge you want to void

  • Named Credential

Update the Payment record to indicate that it was voided.

Refund a charge

  • Transaction ID of the charge you want to refund

  • Amount to refund

  • Named Credential

Create a new record that represents the refunded amount (e.g., a negative payment record).

Save a card securely

  • Tokenized credit card number

  • Named Credential

  • External Credential

  • Paytram External Credential

Create a record in Salesforce that represents the saved card (eg a Payment Method record).

Charge a saved card

  • Named Credential

  • Customer Profile ID of the customer you’d like to charge

  • Payment Profile ID of the card you’d like to charge

Create a record in Salesforce that represents the charge/authorization that was made (e.g., a Payment record)

Creating recurring payments

  • Past dated records to reflect the date to charge, OR

  • A record with a day of month to charge

  • A related payment method to use for the charge

This documentation explains the principals

The following instructions demonstrate how to perform each type of process (e.g., Charge, Void, Refund etc) separately. You can choose to follow these instructions or to use them as inspiration to create your own Screen Flows and then combine them into a single Flow. Depending on your use case, you can create a Flow to process a payment and another Flow to save a card for future use. Or you may want to give the user options to do both within a single Flow. Apply the illustrated techniques to build your Flows to suit your unique needs and workflows. Similarly for voids and refunds, you can design a single Screen Flow that has the option to void or refund, with a decision that sets the parameters correctly depending on the user's choice at runtime.

Last updated