Payment Authorization

Overview

A payment authorization results in a hold on funds on future payment. Authorizations are for payment methods with credit card type only.

Prerequisite Resources

There are multiple prerequisite resources depending on the call method that must be created before requesting a payment authorization.

Object	Definition
Account	Salesforce standard Account object.
Chargent Order	Chargent Orders are central objects to payments lifecycle management.
Payment Method	Payment Methods are instruments that may be used to make or take payment.
Payment Gateway	Payment Gateways track all the configuration settings that Chargent will use to proccess the payments and send requests to the gateway.

Create Payment Authorization

Flow Action

Action Name	Label	Category
apex-ChargentBase_FlowPaymentsAuthorizations	Chargent Payments Authorizations	Chargent Payments

Flow Method

Method Name	Input	Input Type	Output	Output Type
authorize()	AuthorizationInput	List<AuthorizationInput>	AuthorizationOutput	List<AuthorizationOutput>

AuthorizationInput Properties

Property	Type	Description
chargentOrderId	String	Object ID for the Chargent Order.
chargentPaymentMethodId	String	Object ID for the Chargent Payment Method.
amount	String	The amount of the Authorization.
nickName	String	The customer facing alternate name for the payment method.
companyName	String	The billing company name.
city	String	The billing address city.
country	String	The billing address country.
postalcode	String	The billing address postal code.
state	String	The billing address state.
street	String	The billing address street.
phone	String	The billing contact phone.
email	String	The billing contact email.
paymentMethod	String	The type of payment method Credit Card or Bank Account.
paymentGatewayId	String	Object ID for the payment gateway record.
multipleTokenization	Boolean	Tokenize across one or more than one gateways.
paymentGatewayIds	String	Comma separated list of payment gateway IDs.
cardHolderFirstName	String	The credit card holder first name.
cardHolderLastName	String	The credit card holder last name.
cardNumber	String	The credit card number.
cardType	String	The credit card type: Visa, Mastercard, Discover, American Express, MC Eurocard, UK Maestro, JCB Card, or Diners Card.
cvv	String	The card security code.
expiryMonth	String	The card expiration month.
expiryYear	String	The card expiration year.
bankAccountHolderFirstName	String	The bank account holder first name.
bankAccountHolderLastName	String	The bank account holder last name.
bankInstitutionName	String	The bank institution name.
routingNumber	String	The bank account routing number.
bankAccountNumber	String	The bank account number.
bankAccountType	String	The type of the bank account: Checking, Savings, or Business Checking.
headless	Boolean	Send the request to the payment gateway and do not store the results in Salesforce.

AuthorizationOutput Properties

Property	Type	Description
status	Boolean	Success or failure status for the payment method tokenization action.
message	String	The detailed message for the result of the payment method tokenization action.
transactionId	String	The transaction ID associated with refund to the Chargent Order.
token	String	The token used for the authorization.
authorizationCode	String	The authorization code returned from the gateway.

Learn More

Learn more about Payment Authorizations.