The payment object is the means by which you request and record the outcome of a payment. Every time you need to collect a payment, you must create a payment record first. This is the only way you can capture and record a payment.

Payments are created in Salesforce either manually by a user, or by an automated process. Ultimately they can be collected by one of three methods:

  1. By the customer via a secure URL;

  2. By a Salesforce user by taking details over the phone;

  3. Automatically if you already have a saved payment method (an "In Force" authorisation).

Payment records are exactly that, a request for a payments. They can be a card payment, direct debit payment, ACH/eCheck payment or a Paypal payment - we treat them all the same.

Payment records contain all of the information needed to control the payee experience via the paypage; this includes currencies, payment routes available, amounts, languages and more, as well as directing the user to different pages depending on if the payment was successful or failed.

Payment records can be pre-populated with as much or as little information as you choose.

Once a Payment record has been processed, all the relevant information from the PSP is populated on to this record alongside a status update. Details such as the payee name, time and date of payments, any error codes, transaction references etc. are all visible on the payment record.

Key fields include:

Payment Route Options
Allows you to choose which payment routes are available to your customer to use. E.g. Card, Direct Debit or ACH
This is the link you provide to your customer to enable them to process the payment.
Tells you if the payment is awaiting submission, if it's successfully processed, or if it failed for some reason.
Status description
A descriptive text showing the reason related to the current status. Might contain the reason for cancellation or failure for example.