afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/PaymentAuthorization.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "PaymentAuthorization - Data API",
  "description": "Represents a single payment authorization event where users can capture or reverse a payment against a reserve of funds. This object is available in API version 48.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "AccountId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Customer account. This is a relationship field.",
      "relationship_name": "Account",
      "relationship_type": "Lookup",
      "refers_to": "Account"
    },
    "Amount": {
      "type": "currency",
      "properties": "Create, Filter, Sort, Update",
      "description": "The amount authorized for the payment event."
    },
    "Balance": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "Authorized amount – total processed captured amount – total processed authorization reversal amount. Balance can be positive or negative."
    },
    "Comments": {
      "type": "textarea",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "Users can enter comments to provide additional details about the authorization."
    },
    "CurrencyIsoCode": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Three-letter ISO 4217 currency code associated with the payment authorization record."
    },
    "Date": {
      "type": "dateTime",
      "properties": "Create, Defaulted on create, Filter, Nillable, Sort, Update",
      "description": "By default, the day the authorization record was created. Users can also enter a different date. Editable only when the payment authorization’s status is Draft."
    },
    "EffectiveDate": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The date on which the authorization takes effect. Editable only when the payment authorization’s status is Draft."
    },
    "Email": {
      "type": "email",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Email address of the person who initiated the payment."
    },
    "ExpirationDate": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "Authorizations can’t be captured after their expiration dates."
    },
    "GatewayAuthCode": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Authorization approval code from the payment gateway."
    },
    "GatewayDate": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The date and time that of the gateway communication that leads to the successful payment authorization."
    },
    "GatewayRefDetails": {
      "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."
    },
    "GatewayRefNumber": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Unique transaction ID from the payment gateway."
    },
    "GatewayResultCode": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Gateway-specific result code. Must be mapped to a Salesforce-specific result code."
    },
    "GatewayResultCodeDescription": {
      "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."
    },
    "IpAddress": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The IP address of the user who initiated the payment authorization."
    },
    "LastReferencedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp for when the current user last viewed a record related to this record."
    },
    "LastViewedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed."
    },
    "MacAddress": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The MAC address of the person who initiated the payment."
    },
    "OrderPaymentSummaryId": {
      "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."
    },
    "PaymentAuthorizationNumber": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
      "description": "System-provided unique ID for a payment authorization record."
    },
    "PaymentGatewayId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The Salesforce payment gateway record that created this authorization. This gateway will be used for subsequent captures. This is a relationship field.",
      "relationship_name": "PaymentGateway",
      "relationship_type": "Lookup",
      "refers_to": "PaymentGateway"
    },
    "PaymentGroupId": {
      "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. Populated from the authorization record if there is delayed payment. This is a relationship field.",
      "relationship_name": "PaymentGroup",
      "relationship_type": "Lookup",
      "refers_to": "PaymentGroup"
    },
    "PaymentIntentGuid": {
      "type": "string",
      "properties": "Create, Filter, Group, idLookup, Nillable, Sort",
      "description": "Unique ID of the payment sent to Stripe or PayPal. Links the Payments Merchant Account record with the payment at the payment provider."
    },
    "PaymentMethodId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The customer payment method provided during this authorization. This is a relationship field.",
      "relationship_name": "PaymentMethod",
      "relationship_type": "Lookup",
      "refers_to": "PaymentMethod"
    },
    "Phone": {
      "type": "phone",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Phone number of the person who initiated the payment."
    },
    "ProcessingMode": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort",
      "description": "Defines whether the payment has been made outside of the payment platform. Possible values are: External—Transactions happened outside of the Salesforce payments platform. Salesforce—Salesforce made and recorded an external call to the payment gateway."
    },
    "SfResultCode": {
      "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 are: Decline—The gateway call failed, but it may still work if the transaction is attempted again. For example, the customer had insufficient funds or briefly lost their connection. Indeterminate—The gateway didn’t respond to the call. This response usually happens when Salesforce times out while waiting for a response from the gateway. PermanentFail—The gateway call failed and won’t work even if tried again. Gateway calls fail permanently for one of two reasons: Hard Decline: The customer’s payment account has been closed or terminated. Fraud: The gateway recognized the payment or payment method as known fraud. RequiresReview—The customer bank requires more information before completing the payment. Success—The gateway call succeeded. SystemError—Salesforce ended the payment request before receiving a response. For example, Salesforce lost credentials or access to its server. Salesforce ends payment calls if it doesn’t receive a response from the gateway within two minutes. ValidationError—Customer payment data was incorrect, such as a misspelling in the credit card address or an incorrect CVV."
    },
    "Status": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Defines the state of this payment. Possible values are: Canceled—This payment has been unapplied from its target and can to longer be allocated. Draft—The payment can be edited before posting it and allocating it to a target. Failed—Authorization for the payment failed. Pending— Processed—This payment has been finalized and can be allocated against a target. Users can manually change the Status field’s values as follows: Draft to Processed Processed to Canceled Draft to Canceled"
    },
    "TotalAuthReversalAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The sum of all processed authorization reversals against the payment authorization. This is a calculated field."
    },
    "TotalPaymentCaptureAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The sum of all authorization captures related to this payment authorization."
    }
  },
  "special_access_rules": "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.",
  "wsdl_segment": "```xml\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<complexType name=\"PaymentAuthorization\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"Account\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Account\"/>\n        <element name=\"AccountId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Amount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"Balance\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"Comments\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Date\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"EffectiveDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Email\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ExpirationDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"GatewayAuthCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"GatewayDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"GatewayRefDetails\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"GatewayRefNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"GatewayResultCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"GatewayResultCodeDescription\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IpAddress\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"MacAddress\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PaymentAuthAdjustments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"PaymentAuthorizationNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PaymentGateway\" nillable=\"true\" minOccurs=\"0\" type=\"ens:PaymentGateway\"/>\n        <element name=\"PaymentGatewayId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"PaymentGatewayLogs\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"PaymentGroup\" nillable=\"true\" minOccurs=\"0\" type=\"ens:PaymentGroup\"/>\n        <element name=\"PaymentGroupId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"PaymentIntentGuid\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PaymentMethod\" nillable=\"true\" minOccurs=\"0\" type=\"ens:PaymentMethod\"/>\n        <element name=\"PaymentMethodId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Payments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Phone\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ProcessExceptions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ProcessingMode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SfResultCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Status\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"TotalAuthReversalAmount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"TotalPaymentCaptureAmount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\n```",
  "field_reference": {
    "AccountId": {
      "field_label": "Account ID",
      "type": "reference",
      "length": "18"
    },
    "Amount": {
      "field_label": "Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "Balance": {
      "field_label": "Balance",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "Comments": {
      "field_label": "Comments",
      "type": "textarea",
      "length": "1000"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "Date": {
      "field_label": "Date",
      "type": "datetime"
    },
    "EffectiveDate": {
      "field_label": "Effective Date",
      "type": "datetime"
    },
    "Email": {
      "field_label": "Audit Email",
      "type": "email",
      "length": "80"
    },
    "ExpirationDate": {
      "field_label": "Expiration Date",
      "type": "datetime"
    },
    "GatewayAuthCode": {
      "field_label": "Gateway Auth Code",
      "type": "string",
      "length": "64"
    },
    "GatewayDate": {
      "field_label": "Gateway Date",
      "type": "datetime"
    },
    "GatewayRefDetails": {
      "field_label": "Gateway Reference Details",
      "type": "textarea",
      "length": "1000"
    },
    "GatewayRefNumber": {
      "field_label": "Gateway Reference Number",
      "type": "string",
      "length": "255"
    },
    "GatewayResultCode": {
      "field_label": "Gateway Result Code",
      "type": "string",
      "length": "64"
    },
    "GatewayResultCodeDescription": {
      "field_label": "Gateway Result Code Description",
      "type": "string",
      "length": "255"
    },
    "Id": {
      "field_label": "Payment Authorization ID",
      "type": "id",
      "length": "18"
    },
    "IpAddress": {
      "field_label": "IP Address",
      "type": "string",
      "length": "39"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "MacAddress": {
      "field_label": "MAC Address",
      "type": "string",
      "length": "32"
    },
    "OrderPaymentSummaryId": {
      "field_label": "Order Payment Summary ID",
      "type": "reference",
      "length": "18"
    },
    "PaymentAuthorizationNumber": {
      "field_label": "Payment Authorization Number",
      "type": "string",
      "length": "255"
    },
    "PaymentGatewayId": {
      "field_label": "Payment Gateway ID",
      "type": "reference",
      "length": "18"
    },
    "PaymentGroupId": {
      "field_label": "Payment Group ID",
      "type": "reference",
      "length": "18"
    },
    "PaymentIntentGuid": {
      "field_label": "Payment Intent Guid",
      "type": "string",
      "length": "255"
    },
    "PaymentIntentId": {
      "field_label": "Payment Intent ID",
      "type": "reference",
      "length": "18"
    },
    "PaymentMethodId": {
      "field_label": "Payment Method ID",
      "type": "reference",
      "length": "18"
    },
    "Phone": {
      "field_label": "Phone",
      "type": "phone",
      "length": "40"
    },
    "ProcessingMode": {
      "field_label": "Processing Mode",
      "type": "picklist",
      "length": "255"
    },
    "SfResultCode": {
      "field_label": "Salesforce Result Code",
      "type": "picklist",
      "length": "255"
    },
    "Status": {
      "field_label": "Status",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TotalAuthReversalAmount": {
      "field_label": "Total Payment Auth Reversal Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalPaymentCaptureAmount": {
      "field_label": "Total Payment Capture Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "precision",
    "scale"
  ]
}