Payment

Represents a single event when a shopper makes a payment. For credit cards, this event is a payment capture or payment sale, but it doesn’t appear on the shopper’s credit card statement.

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: reference

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

  • Description:

    The account of the customer who made the payment.

    This field is a relationship field.

  • Relationship name: Account

  • Relationship type: relationship

  • Refers to: Account

  • Type: currency
  • Properties: Create, Filter, Sort, Update
  • Description: The amount to be debited or captured.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: The total amount – the net applied amount.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date that the payment was voided.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date when the cancellation of this payment takes effect.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The gateway provides this date following a successful cancellation request.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: System-provided unique transaction ID from 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: A Salesforce result code that can be mapped to one or more gateway result codes. We recommend that the payment gateway adapter layer maps gateway-specific codes to the Salesforce result code.
  • Type: textarea
  • Properties: Nillable
  • Introduced: API version 49.0
  • Description: Contains caller context for payment APIs. Useful for re-establishing context during an asynchronous payment transaction.
  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Users can provide additional details about the payment record. Supports a maximum of 1000 characters.
  • Type: double
  • Properties: Filter, Nillable, Sort, Update
  • Introduced: API version 64.0
  • Type: date
  • Properties: Filter, Group, Nillable, Sort, Update
  • Introduced: API version 64.0
  • Description: The date on which the invoiceʼs total amount with tax was converted to the corporate currency.
  • Type: double
  • Properties: Filter, Nillable, Sort, Update
  • Introduced: API version 64.0
  • Description: The exchange rate thatʼs used to convert the invoiceʼs total amount with tax to the corporate currency. Available in version 63.0 and later.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort, Update
  • Introduced: API version 64.0
  • Description: The currency ISO code of the corporate currency. Available in version 63.0 and later.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date when this payment record was created.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date that this payment takes effect.
  • Type: email
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Email address of the user who initiated the payment.
  • Type: double
  • Properties: Filter, Nillable, Sort, Update
  • Introduced: API version 66.0
  • Type: date
  • Properties: Filter, Group, Nillable, Sort, Update
  • Introduced: API version 66.0
  • Type: double
  • Properties: Filter, Nillable, Sort, Update
  • Introduced: API version 66.0
  • Type: string
  • Properties: Filter, Group, Nillable, Sort, Update
  • Introduced: API version 66.0
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The gateway provides this date for reference following a successful gateway communication.
  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Additional data that can’t be stored in other fields on the payment record. You can use this field for transactions following the initial transaction that creates the payment record. You can use any data that isn’t normalized in financial entities. This field has a maximum length of 1000 characters and can store data as JSON or XML.
  • 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 that must map to a Salesforce-specific result code. One Salesforce result code can map to multiple gateway result codes.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Description of the gateway’s result code.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Shows the payment’s financial impact against the customer’s accounts receivable. If the payment is valid, this value is the negative of the payment amount. If the payment is voided, this value is 0.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The IP address of the user who initiated the payment.

  • Type: reference

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

  • Introduced: API version 62.0

  • Relationship name: LegalEntityAccountingPeriod

  • Relationship type: relationship

  • Refers to: LegalEntyAccountingPeriod

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 62.0
  • Description: The legal entity used in this invoice. This field is a relationship field.
  • Relationship name: LegalEntity
  • Relationship type: relationship
  • Refers to: LegalEntity
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The MAC address of the person who initiated the payment.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Total payment amount that has been applied, including adjustments.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 65.0
  • Description: Total payment amount that has been credited. This amount is equal to TotalPaymentCreditApplied - TotalPaymentCreditUnapplied. This field is a calculated field.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Total refund amount that has been applied to the payment, including adjustments.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Order payment summaries show the balances of each authorization, capture, and refund made against an order.
  • Relationship name: OrderPaymentSummary
  • Relationship type: relationship
  • Refers to: OrderPaymentSummary

  • Type: reference

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

  • Description:

    The authorization record for this payment. If there’s a delayed capture (when the capture occurs after the authorization), all captures must be made against a previously successful authorization transaction.

    This field is a relationship field.

  • Relationship name: PaymentAuthorization

  • Relationship type: relationship

  • Refers to: PaymentAuthorization

  • Type: reference

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

  • Description:

    ID of the payment gateway that processed the payment. If there’s a delayed payment, the field is populated from the authorization record.

    This field is a relationship field.

  • Relationship name: PaymentGateway

  • Relationship type: relationship

  • Refers to: PaymentGateway

  • Type: reference

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

  • Description:

    Payment groups organize all the payment transactions that have been made against a record such as an account or contract. If there’s a delayed payment, the field is populated from the authorization record.

    This field is a relationship field.

  • Relationship name: PaymentGroup

  • Relationship type: relationship

  • Refers to: PaymentGroup

  • Type: reference

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

  • Introduced: API version 63.0

  • Relationship name: PaymentInitiationSource

  • Relationship type: relationship

  • Refers to: PaymentInitiationSource

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Nillable, Sort
  • Introduced: API version 58.0
  • Description: Unique ID of the payment sent to Stripe or PayPal. Links the Payments Merchant Account record with the payment at the payment provider.

  • Type: reference

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

  • Introduced: API version 56.0

  • Relationship name: PaymentIntent

  • Relationship type: relationship

  • Refers to: PaymentIntent

  • Type: reference

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

  • Description:

    The payment method that the customer used to provide this payment information.

    This field is a relationship field.

  • Relationship name: PaymentMethod

  • Relationship type: polymorphic

  • Refers to: AlternativePaymentMethod, CardPaymentMethod, DigitalWallet, PaymentMethod

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: System-created unique ID for this payment record.
  • Type: phone
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Phone number of the customer who initiated the payment.
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort
  • Description: Defines whether the payment has been made outside of the payment platform.
  • Possible values:
    • External — External
    • Salesforce — Salesforce
  • 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

  • Type: picklist

  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update

  • Description:

    Defines the state of this payment.

    Users can manually change the Status field’s values as follows:

    • Draft to Processed
    • Processed to Canceled
    • Draft to Canceled

  • Possible values:

    • Canceled — Canceled
    • Draft — Draft
    • Processed — Processed
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: The total amount of this payment’s balance that has been applied against an invoice.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 65.0
  • Description: The total amount of all credit types that have been applied against this payment. This field is a calculated field.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 65.0
  • Description: The total amount of all credit types that haven’t been applied against this payment. This field is a calculated field.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: The total amount of a refund that has been applied against this payment.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: The total amount of a previously applied refund that has since been unapplied from this payment.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: The total amount of this payment that was previously applied and then unapplied.
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Defines how the customer used this payment.
  • Possible values:
    • Capture — Capture
    • Sale — Sale

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.