Guides

Payment Gateway Customer

Suggest Edits

The Payment Gateway Customer object connects your Salesforce customers (Accounts and/or Contacts) with your Customer accounts in Stripe. Stripe maintains a single entity by which cards, payments, and all other Stripe records relate to (something like a Person Account in Salesforce). All Stripe related data ultimately relates back to a Payment Gateway Customer record (except with Stripe Connect).

This object works mainly in the background and requires no user setup. For example, a new Payment Method will either trigger the creation of a new Payment Gateway Customer record or relate to an existing one based on the Payment Method's email and related Payment Gateway.

🚧

Note on Account, Contact, and Lead matching

In Payments version 4.163 and above, we no longer use hard-coded logic (Email and First Name) to match Payment Gateway Customers to Accounts, Contacts, or Leads when these lookup fields are blank. The matching will now use your active standard or custom Salesforce Duplicate Rules and their associated Matching Rules.

Click here to learn more about the criteria evaluated in the Salesforce Standard Matching rules.

Click here to learn more about creating custom matching rules and click here to learn how to use those matching rules in custom Duplicate Rules.

Payment Gateway Customer

  • Navigate to the Payment Gateway Customer Object.

Lightning: Click on the App Launcher | Under "All Items" | Click on Payment Gateway Customers.

Classic: Click on "All Tabs" ("+" icon in the top right) | Click on Payment Gateway Customers.

  • Click on the Name of any Payment Gateway Customer.
    If you don't see any Payment Gateway Customer records, that means you have not created any Payment Methods or synced any data from Stripe.

  • Email and Description are the only two fields on the record that will update between Stripe and Salesforce when Webhooks is configured.

  • The "Related To" fields Account and Contact are lookup type fields to the standard Account and Contact objects.
    They are automatically filled in from the related Payment Method's Contact and/or Account values.

  • Account Balance - The customer's current balance.

  • Stripe Coupon - When defined, the customer will have a discount applied on all recurring charges.

  • Invoice Prefix - The prefix for the customer used to generate unique invoice numbers.

  • Postal code

Note

Place the Payment Gateway Customer object on your Account and Contact Page Layouts as a Related List if you have multiple Payment Gateways. Since there can only be one Payment Gateway Customer to one Payment Gateway, you will be able to tell which Accounts and/or Contacts are on more than one Payment Gateway.

Creating a Payment Gateway Customer

Option 1

  1. Navigate to the Payment Gateway Customer Object.

Lightning: Click on the App Launcher | Under "All Items" | Click on Payment Gateway Customers.

Classic: Click on "All Tabs" ("+" icon in the top right) | Click on Payment Gateway Customers.

  1. Click "New".

  2. Populate: Name, Payment Gateway, Email, and Description fields.

If you want to relate this Payment Gateway Customer to an existing Account and/or Contact add the existing record(s) under the "Related To" section.

  1. Once you click "Save", this record will sync with your Payment Gateway and the Customer ID and Created in Stripe fields will auto-populate.

Option 2

  1. Add the Account’s Billing and Shipping address
  1. Create and set a Contact to be the Primary Stripe Contact
  1. On the Account click the Create Stripe Customer button
  1. Confirm that a Payment Gateway Customer was created and related to the Account

Option 3

  1. Add the Push To Gateway button to your Payment Gateway Customer page layout.

  2. Navigate to Custom Settings -> Blackthorn Pay - Trigger Settings -> Manage -> Edit -> Enable Disable Creating a Stripe Customer.

  3. Navigate to the Payment Gateway Customer Object.

  4. Click "New".

  5. Populate: Name, Payment Gateway, Email, and Description fields.

  6. Click "Save".

  7. Click Push To Gateway button.

  8. Click Push button on the Visualforce page.

  9. After the success message displays and you return to the Payment Gateway Customer record the Customer ID and Created in Stripe fields will auto-populate.

📘

Updating a Payment Gateway Customer record

Using option 3 without performing step 2 will also work if the initial trigger action never happened or if you are updating the Payment Gateway Customer record and you notice that the update did not make it to the Payment Gateway.

Removing a Payment Gateway Customer

Once a Payment Gateway Customer record in Salesforce has synced to the Stripe Payment Gateway, you are unable to delete the record. If you need to remove a Payment Gateway Customer for any reason, that can be done by clicking the "Remove from Gateway" button or checking the "Remove from Gateway" checkbox. This functionality was created so historical information can be kept while ceasing all ways to capture transactions.

  • Navigate to the Payment Gateway Customers Object.

Lightning: Click on the app launcher | Under "All Items" | Click on Payment Gateway Customers.

Classic: Click on "All Tabs" ("+" icon in the top right) | Click on Payment Gateway Customers.

Related List on your Account or Contact Layout.

  • Click on the record you want to remove from Stripe.

  • Click Remove From Gateway button or check the Remove From Gateway field
    Clicking this button will invalidate any related Payment Method's on file.

  • The Deleted From Gateway field will be checked, letting you know this Stripe Customer is no longer valid.

Notes

If this customer had any related transactions that were captured, those records will still be in the Stripe Payment Gateway and the customer account will show an alert, "This customer account has been permanently closed".

If you have any "Open" Transactions that are set to Auto-Process and related to this Payment Gateway Customer record, they will fail. Verify all related "Open" Transactions have been deleted once you click the "Remove From Gateway" button.

Troubleshooting/FAQ

If you have received an error with your Stripe Customer or have a question, please view our Troubleshooting and Frequently Asked Questions.

Updated 3 months ago

What’s Next
Did this page help you?