Connect REST API Developer Guide

Connect REST API Developer Guide
Introduction
Quick Start
Work with Features
Examples
Resources
Request Bodies
Action Link Definition Input
Action Link Group Definition Input
Action Link Input
Action Link Template Binding Input
Activity Reminder Input
Address Input
Adjust Item Input
Adjust Order Item Summary Input
Alternative Input
Alternative Payment Method Input
Announcement Input
Article Topic Assignment Job Input
Asset Action Input
Asset Action Source Input
Asset File Input
Asset State Period Input
Assigned Resource Input
Associated Actions Capability Input
Audience Criterion Input
Audience Criterion Value Input
Audience Input
Authorization API Payment Method Input
Authorization Reversal Input
Authorization Input
Available Territory Slots Input
Banner Photo Input
Batch Collection Input
Batch Input
Bookmarks Capability Input
Bot Version Activation Input
Cancel Asset Input
Canvas Capability Input
Capacity Request Input
Capture Input
Card Payment Method Input
Card Payment Method Tokenization Input
Cart Coupon Input
Cart Inventory Reservation Input (Developer Preview)
Cart Input
Cart Item Input
Cart Item Promotion Collection Input
Cart Item Promotion Input
Cart Messages Visibility Input
Cart to Wishlist Input
Category Settings Input
Change Asset Input
Change Input
Change Item Input
Change Item Fee Input
Chatter Stream Input
Checkout Address Input
Checkout Input
Checkout Payment Input
Checkout Start Input
Clean Input
Close Capability Input
Comment Capabilities Input
Comment Input
Commerce Address Field Input
Commerce Address Input
Commerce Einstein Activity Job Input
Community Input
Confirm Held FO Capacity Input
Confirm Held FO Capacity Request Input
Connectors Call Input
Connectors Call List Input
Contact Information Input
Content Capability Input
Conversation Entries Update Input
Conversation Entry Update Input
Coupon Code Redemption Input
Create Credit Memo Input
Create Invoice From Change Orders Input
Create Multiple Invoices From Change Orders Input
Create Order Payment Summary Input
Credential Custom Header Input
Credential Input
Credential Value Input
Custom List Audience Criteria Input
Custom Recommendation Audience Input
Custom Recommendation Definition Input
Dashboard Component Snapshot Input
Data Cloud Calculated Insight Input
Data Cloud Identity Resolution Config Input
Data Cloud Identity Resolution Config Patch Input
Data Cloud Identity Resolution Match Criterion Input
Data Cloud Identity Resolution Match Criterion Party Identification Info Input
Data Cloud Identity Resolution Match Rule Input
Data Cloud Identity Resolution Reconciliation Field Rule Input
Data Cloud Identity Resolution Reconciliation Rule Input
Data Cloud Identity Resolution Reconciliation Source Input
Data Cloud Identity Resolution Run Now Input
Data Cloud Query Input
Data Cloud Segment Dbt Input
Data Cloud Segment Dbt Model Input
Data Cloud Segment Input
Digest Job Input
Direct Message Capability Input
Distinct Value Refinement Input
Distribute Picked Quantities Input
Distribute To Orders Input
Duplicate Job Input
Duplicate Job Status Input
Ensure Funds Async Input
Ensure Refunds Async Input
Entitlement Settings Input
Environment Hub SSO User Mapping Input
Extended Fields Input
Extension Input
Extensions Capability Input
External Credential Input
External Credential Parameter Input
External Credential Principal Input
Facetable Attribute Input
Facetable Attributes Collection Input
Feed Element Capabilities Input
Feed Entity Share Capability Input
Feed Favorite Input
Feed Item Input
Feed Item Topic Input
File ID Input
File Input
File Share Link Input
File Shares Input
Files Capability Input
Files Connect Field Value Input
Files Connect Item Input
Files Connect Permission Collection Input
Files Connect Permission Input
Find Routes With Fewest Splits Input
Find Routes With Fewest Splits Group Using OCI Input
Find Routes With Fewest Splits Using OCI Input
Find Routes With Fewest Splits Using OCI Item Input
Folder Input
Folder Item Input
Following Input
Form Field Input
Form Input
Form Submission Field Input
Form Submission Input
Fulfillment Group Input
Fulfillment Order Input
Fulfillment Order Invoice Input
Fulfillment Order Line Item Input
Fulfillment Order Line Items To Cancel Input
Generate Asset Input
Generic Batch Collection Input
Generic Batch Input
Get FO Capacity Values Request Input
Global Product Import Input
Group Chatter Settings Input
Group Information Input
Group Input
Group Member Input
Group Membership Request Update
Group Record Input
Hold FO Capacity Input
Hold FO Capacity Request Input
Import Configuration Input
Import Settings Input
Import Source Input
Inner Ensure Funds Async Input
Invite Collection Input
Invoice To Pay Input
Item Quantity Input
Knowledge Article View Stat Input
Lead Input
Link Capability Input
List Current Share Collection Input
Location Availability Input
Location Input
Managed Content Input
Managed Content Publish Input
Managed Content Type Searchable Input
Managed Content Unpublish Input
Managed Content Variant Input
Managed Content Variant Update Input
Media Settings Input
Managed Social Account Setup Input
Managed Topic Input
Managed Topic Position Collection Input
Managed Topic Position Input
Message Body Input
Message Segment Input: Entity Link
Message Segment Input: Hash Tag
Message Segment Input: Inline Image
Message Segment Input: Link
Message Segment Input: Markup Begin
Message Segment Input: Markup End
Message Segment Input: Mention
Message Segment Input: Text
Messaging Channel Input
Microbatching Ingestion Input
Moderation Flag Input
Multiple Ensure Funds Async Input
Multiple Fulfillment Order Input
Multiple Fulfillment Order Invoices Input
Mute Capability Input
Named Credential Callout Options Input
Named Credential Input
Named Credential Parameter Input
Network Connection Input
New User Audience Criteria Input
Next Best Action Strategy Input
Notification App Setting Input
Notification Collection Input
Notification Input
Notification Member Input
Notification Setting Input
OAuth Credential Auth URL Input
Object Input
OCI Create Reservation Input
OCI Create Reservation Single Input
OCI Fulfill Reservation Input
OCI Fulfill Reservation Single Input
OCI Get Inventory Availability Input
OCI Release Reservation Input
OCI Release Reservation Single Input
OCI Transfer Reservation Input
OCI Transfer Reservation Single Input
Order Item Summary Adjustment Collection Input
Order Item Summary Adjustment Input
Order Item Summary Input
Order Summary Adjustment Aggregates Async Input
Order Summary Graph Input
Order Summary Graphs Input
Order Summary Input
Order Summary Lookup Input
Order Summary Verification Input
Order to Cart Input
Payment Group Input
Payment Method Input
Payment Method Tokenization Input
Payment Token Input
Apple Pay Domain Input
Payment Intents Input
Photo Input
Pin Capability Input
Poll Capability Input
Post Auth Input
Post Authorization API Payment Method Input
Price Settings Input
Pricing Input
Pricing Line Item Input
Product Import Cancel Input
Product Import Input
Product Search Grouping Input
Program Application Input
Program Application Item Input
Program Application File Input
Product Search Input
Promotion Cart Delivery Group Input
Promotion Cart Input
Promotion Cart Item Input
Promotion Evaluation Input
Promotion Parent Products Input
Promotion Product Categories Input
Promotion Product Evaluation Input
Promotion Product Input
Push Notification Input
Quantity With SKU Input
Question and Answers Capability Input
Rank Average Distance Input
Read By Capability Input
Recommendation Reaction Input
Record Capability Input
Recordset Filter Criteria Input
Referenced Refund Input
Release Held FO Capacity Input
Release Held FO Capacity Request Input
Request Header Input
Return Items Input
Return Order Input
Return Order Item Delivery Charge Input
Return Order Item Fee Input
Return Order Item Input
Return Order Line Item Fee Input
Return Order Line Item Input
Sale API Payment Method Input
Sale Input
Scheduled Custom Recommendation Input
Searchable Attribute Input
Searchable Attributes Collection Input
Search Product Setting Collection Input
Search Product Setting Input
Search Results Rule Collection Input
Search Results Rule Input
Sequence Order Payment Summary Input
Service Appointment Input
Service Appointment Update Input
Service Appointments Create Input
Share Captured Activity Input
Share Input
Shifts from Pattern Input
Skill Requirement Input
Social Customer Service Configuration Input
Social Customer Service Message Type Settings Input
Social Customer Service Provider Settings Input
Social Post Mass Approval Input
Sort Rule Input
Sort Rules Collection Input
Status Capability Input
Stream Subscription Input
Survey Description Input
Survey Email Input
Survey Integer Question Response Input
Survey Invitation Settings Input
Survey Page Response Input
Survey Question Response Input
Survey Recipient Engagement Context Input
Survey Recipient Survey Subjects Input
Survey Response Input
Survey Selection Question Choice Input
Survey Selection Question Response Input
Survey Text Question Response Input
Target Collection Input
Target Collection Update Input
Target Input
Target Location Input
Target Update Input
Topic Assignment Input
Topic Endorsement Input
Topic Input
Topic Names Input
Topics Capability Input
Up Down Vote Capability Input
User Chatter Settings Input
User ID Collection Input
User Input
User Message
User Message Recipient Input
User Message Recipient List Input
User Mission Activity Input
User Status Input
User Stream (Conversation) Input
Verified Capability Input
Webstore Settings Input
Wishlist Input
Wishlist Item Input
Wishlist Update Input
Work Type Input
Response Bodies
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Sale Input

Payment Sale input consumed by payment sale service.
JSON example (without idempotency)
1{
2  "accountId":"",
3  "amount":"5000",
4  "comments":"Sale of 20 renewed licenses",
5  "currencyIsoCode:"USD",
6  "effectiveDate":"05-01-2020",
7  "paymentGatewayId":"0000000",
8  "paymentGroup":"",
9  "paymentMethod":"SamplePaymentMethod"
10}
JSON example (idempotency key in JSON payload)
1{
2"accountId":"",
3"amount":"5000",
4"idempotencyKey":"qw",
5"comments":"Sale of 20 renewed licenses",
6"currencyIsoCode:"USD",
7"effectiveDate":"05-01-2020",
8"paymentGatewayId":"0000000",
9"paymentGroup":"",
10"paymentMethod":"SamplePaymentMethod"
11}
JSON example (idempotency key in header)
1{
2"accountId":"",
3"amount":"5000",
4"comments":"Sale of 20 renewed licenses",
5"currencyIsoCode:"USD",
6"effectiveDate":"05-01-2020",
7"paymentGatewayId":"0000000",
8"paymentGroup":"",
9"paymentMethod":"SamplePaymentMethod"
10}
Header
Name: sfdc-Payments-Idempotency-Key
Data Type: String
Max Length: 255
Example: 
1Content-Type: application/json; charset=UTF-8
2Accept: application/json
3sfdc-Payments-Idempotency-Key: UniqueIdempotencyKey
Properties
Name Type Description Required or Optional Available Version
accountId String Salesforce account that contains the payment for the sale request. Optional 54.0
additionalData Map<String, String> Allows users to enter additional data, if needed a payment request. The additionalData object consists of entries, each of which includes a key and value. Supports up to five key-value pairs. Each key and each value can contain up to 255 characters. Optional 54.0
amount Double The amount of the sale. Required 54.0
comments String Optional comments for the payment sale request. Optional 54.0
currencyIsoCode String Three-letter ISO 4217 currency code associated with the payment group record. Required, if multi-currency is enabled 54.0
effectiveDate String The date that the sale request takes effect. Optional 54.0
email String Email of the client that initiated the request. Optional 54.0
idempotencyKey String Idempotency key used for the payment request. Can be provided in the payload or the header, but not in both places at once. Optional 54.0
ipAddress String IP address of the client that made the request. Optional 54.0
macAddress String MAC address of the client that made the request. Optional 54.0
paymentGatewayId String The gateway that evaluates the payment sale request. Required 54.0
paymentGroup Payment Group Input Represents a group of payment requests. Optional 54.0
paymentMethod Sale API Payment Method Input Represents a payment method for a payment sale transaction. Required 54.0
phone String Phone number of the client that initiated the request. Optional 54.0