PaymentGatewayLog

Stores information exchanged between the Salesforce payments platform and external payment gateways. Gateway logs can also record payloads from external payment entities.

Deleting or archiving a payment gateway log doesn’t impact financial data on other payment entities.

Introduced in API version 48.0.

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

  • To access Salesforce Payments objects with the API, your org must have one or more of these licenses: Salesforce Payments, Salesforce Order Management, B2B Commerce, or D2C Commerce. Salesforce Payments objects are available only in Lightning Experience.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Authorization approval code from the gateway.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Code sent by gateways that use an address verification system.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time that of the gateway communication that leads to the creation of this gateway log.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Information or error messages sent from the gateway.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Unique transaction ID created by the payment gateway.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Gateway-specific result code. Must be mapped to a Salesforce-specific result code.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Description of the gateway’s result code. This field is useful for providing more information around why the gateway returned a certain result code.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Describes the result of communication between the payments platform and a payment gateway.
  • Possible values:
    • Failed — Failed
    • Initiated — Initiated
    • NoOp — NoOp
    • Success — Success
    • Timeout — Timeout
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort
  • Description: Describes the type of interaction with the gateway. This field is required for logs created in Salesforce.
  • Possible values:
    • Authorization — Authorization
    • AuthorizationReversal — AuthorizationReversal
    • Avs — Avs
    • Capture — Capture
    • CheckGiftCardBalance — CheckGiftCardBalance
    • PostAuth — PostAuth
    • ReferencedRefund — ReferencedRefund
    • Sale — Sale
    • Tokenize — Tokenize
    • Void — Void
  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 50.0
  • Description: For asynchronous transactions, shows whether the gateway log belongs to the notification (yes) or the initial transaction (no).
  • Possible values:
    • No — No
    • Yes — Yes
  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Relationship name: OrderPaymentSummary

  • Relationship type: relationship

  • Refers to: OrderPaymentSummary

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    The Payments Platform payment gateway record used for communication with the external payment gateway.

    This field is a relationship field.

  • Relationship name: PaymentGateway

  • Relationship type: relationship

  • Refers to: PaymentGateway

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: System-generated unique ID for this payment gateway log record.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Raw payload. No sensitive attributes are stored.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Raw payload.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 66.0
  • Description: The retry category returned by the payment gateway for the failed payment.
  • Possible values:
    • CardLimit — CardLimit — Insufficient funds, exceeded spending limits, or other restrictions on the card.
    • GatewayConnection — GatewayConnection — Connectivity or communication errors between systems, including upstream gateway errors.
    • PaymentInformation — PaymentInformation — Missing or incorrect data such as incorrect card numbers, addresses, or currencies.
    • PaymentProcessing — PaymentProcessing — Payment account is invalid, closed, restricted, or the transaction was declined for reasons other than insufficient funds.
    • Security — Security — Security violations or issues such as fraud, risk, authentication, verification, and authorization.
    • Unknown — Unknown — Payment gateway error code isn’t recognized or isn’t mapped to a specific category.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 66.0
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: If an IdempotencyKey was passed in the API request, its value is stored here in text format.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Salesforce-specific result code that can map to one or more gateway result codes. We recommend configuring the payment gateway adapter layer to map gateway result codes to the appropriate Salesforce result code.
  • Possible values:
    • Decline — Decline
    • Indeterminate — Indeterminate
    • PermanentFail — PermanentFail
    • RequiresReview — RequiresReview
    • Success — Success
    • SystemError — SystemError
    • ValidationError — ValidationError