--- schema_version: "1" id: 0c1f847c2b113b7c984755683a8f1a5c8b963cdee0313fd953c2a1bc13a94da1 title: Authorize Payment Action collection: admin version: current locale: en-us portal_url: https://docs.salesforce.com/admin/current/en-us/platform/264-0-0/flow_ref_elements_om_actions_authorize_payment.md canonical_url: https://help.salesforce.com/s/articleView?id=platform.flow_ref_elements_om_actions_authorize_payment.htm&release=264.0.0&type=5 source_site: help.salesforce.com content_type: documentation content_hash: f932030c7722783cb318625b63c687a39730f04beb386868cc70f49169c1d02b description: In Salesforce Order Management, authorize a payment on a credit card. You can include details for a new credit card or reference an existing payment method. products: - Flow Builder - Salesforce Platform release: "264" --- # Authorize Payment Action In Salesforce Order Management, authorize a payment on a credit card. You can include details for a new credit card or reference an existing payment method. ### Required Editions
Available in: Lightning Experience
View supported editions.
This feature requires the Salesforce Order Management add-on. To purchase, contact your Salesforce account executive.
In Flow Builder, add an Action element to your flow. Select the **Order Management** category, and search for **Authorize Payment**. To access this action from REST API, use the name `authorizePayment`. If you're using the Enterprise edition, we recommend disabling the RollbackOnErrApexIAp permission and the RollbackOnErrApexIA preference. If you keep them enabled, the entire authorization is rolled back if there are any errors. Contact Salesforce Customer Support to disable permissions or preferences. ![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-platform-platform_automation-264-0-0-production-enus/60568438-ec7e-4665-acd1-7c80dcbe60d5/images/icon_note.png) Note This action is available with the PaymentsAPIUser user permission. ## Set Input Values Use values from earlier in the flow to set the inputs.
Input Parameter Description
Payment Authorization Request

This input is an Apex-defined variable of class ConnectApi.AuthorizationRequest, which includes these fields:

  • accountId —ID of the account that contains the payment transaction being authorized.
  • amount —Authorization amount.
  • comments —(Optional) Comments for the payment authorization.
  • currencyIsoCode —Three-letter ISO 4217 currency code associated with the payment group record.
  • effectiveDate —Date that the authorization is applied to the transaction.
  • paymentGatewayId —Payment gateway that processes the authorization.
  • paymentGroup —(Optional) Payment group for the authorization. The payload must reference either a paymentGroup or a paymentGroupId, but not both. This field is an Apex-defined variable of class ConnectApi.PaymentGroupRequest, which includes these fields:
    • createPaymentGroup—(Optional) Specifies whether to create a payment group (true) or not (false).
    • currencyIsoCode—(Optional) Three-letter ISO 4217 currency code associated with the payment group record.
    • id—(Optional) ID of the payment group record.
    • sourceObjectId—(Optional) Source object ID of the payment group record. Supports only OrderId.
  • paymentMethod—Payment method for the authorization. The payload must either reference an existing payment method or include details for a new payment method, but not both. This field is an Apex-defined variable of class ConnectApi.AuthApiPaymentMethodRequest, which includes these fields:

    This input includes the fields from the parent class, ConnectApi.BaseApiPaymentMethodRequest.

    • address—Address for the payment method. This field is an Apex-defined variable of class ConnectApi.AddressRequest. It includes these fields, all of which are optional:
      • city
      • companyName
      • country
      • postalCode
      • state
      • street
    • cardPaymentMethod —(Optional) When using a new payment method, the details of that method. This field is an Apex-defined variable of class ConnectApi.CardPaymentMethodRequest, which includes these fields:
      • accountId—Salesforce account to which this payment method is linked.
      • cardCategory —Valid values are CreditCard and DebitCard.
      • cardHolderFirstName—First name of the card holder.
      • cardHolderLastName—Last name of the card holder.
      • cardHolderName—Full name of the card holder.
      • cardNumber—Card number.
      • cardType—Valid values are:
        • AmericanExpress
        • DinersClub
        • JCB
        • Maestro
        • MasterCard
        • Visa
      • comments —(Optional) Comments for the payment method.
      • cvv—CVV.
      • email—Email of the card holder.
      • expiryMonth—Card expiration month.
      • expiryYear—Card expiration year.
      • nickName—(Optional) Nickname for the payment method.
      • startMonth—(Optional) Start month of the card.
      • startYear—(Optional) Start year of the card.
    • id—(Optional) When using an existing payment method, the ID of that method.
    • saveForFuture—Whether to save the payment method for future use.
## Store Output Values Use output values later in the flow. The values are assigned when a response is received from the payment gateway.
Output Parameter Description
Payment Authorization Response

This output is an Apex-defined variable of class ConnectApi.AuthorizationResponse, which includes these fields:

  • error —If an error is returned, details about that error. This field is an Apex-defined variable of class ConnectApi.ErrorResponse, which includes these fields:
    • errorCode—Error code.
    • message—More detail, if available.
  • gatewayResponse —Response from the payment gateway. This field is an Apex-defined variable of class ConnectApi.AuthorizationGatewayResponse, which includes this field:
    • gatewayAuthorizationCode—Payment authorization code.
  • paymentAuthorization —Details about the payment authorization. This field is an Apex-defined variable of class ConnectApi.PaymentAuthorizationResponse, which includes these fields:
    • accountId —ID of the account that contains the payment transaction being authorized.
    • amount —Amount that the gateway authorized for the payment transaction.
    • currencyIsoCode —Three-letter ISO 4217 currency code associated with the payment group record.
    • effectiveDate—Date that the authorization becomes effective.
    • expirationDate—Date that the authorization expires.
    • id—ID of the payment authorization record.
    • paymentAuthorizationNumber—System-defined number for the payment authorization record.
    • requestDate—Date that the authorization occurred.
    • status—Status of the payment authorization as returned by the gateway.
  • paymentGatewayLogs —Payment gateway log information about the authorization transaction. This field is a list of Apex-defined variables of class ConnectApi.GatewayLogResponse, each of which includes these fields:
    • createdDate—Date when the gateway log was created.
    • gatewayResultCode—Result codes that show the status of a transaction as it is passed to the financial institution and then returned to the client.
    • id—ID of the gateway log record.
    • interactionStatus—Gateway interaction status. It can be SUCCESS, FAILED, or TIMEOUT.
  • paymentGroup —Details about the payment group. This field is an Apex-defined variable of class ConnectApi.PaymentGroupResponse, which includes these fields:
    • currencyIsoCode —Three-letter ISO 4217 currency code associated with the payment group record.
    • id—ID of the payment group record.
    • sourceObjectId—Source object ID of the payment group record.
  • paymentMethod —Details about the payment method. This field is an Apex-defined variable of class ConnectApi.PaymentMethodResponse, which includes these fields:
    • accountId —ID of the account for the payment method.
    • id—ID of the payment method.
    • status—Status of the payment method.
## Usage Use this action in custom flows that require payment authorization, such as adding an item to an order or an uneven exchange. Before using it, verify with your payment provider that it supports payment authorization calls from Salesforce Order Management.