Batch Payment Scheduler (POST)

Create a payment scheduler to automate and process payment runs on a recurring basis.

Special Access Rules

You need the Payment Ops permission set to use this API.

Resource

1/commerce/payments/payment-schedulers/

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.0/commerce/payments/payment-schedulers/

Available Version

64.0

HTTP Methods

POST

Request Body for POST

JSON Example

1{
2  "schedulerName": "Payment Scheduler",
3  "startDate": "2022-01-01",
4  "endDate": "2022-12-31",
5  "preferredTime": "02:05:00.000",
6  "frequencyCadence": "Monthly",
7  "recursEveryMonthOnDay": "28",
8  "criteriaMatchType": "MatchAny",
9  "status": "Active",
10  "filterCriteria": [
11    {
12      "objectName": "PaymentScheduleItem",
13      "fieldName": "PaymentRunMatchingValue",
14      "operation": "Equals",
15      "value": "1",
16      "criteriaSequence": 1
17    },
18    {
19      "objectName": "PaymentScheduleItem",
20      "fieldName": "PaymentRunMatchingValue",
21      "operation": "Equals",
22      "value": "2",
23      "criteriaSequence": 2
24    },
25    {
26      "objectName": "PaymentScheduleItem",
27      "fieldName": "PaymentRunMatchingValue",
28      "operation": "Equals",
29      "value": "3",
30      "criteriaSequence": 3
31    }
32  ]
33}

Properties

Name	Type	Description	Required or Optional	Available Version
`criteriaMatchType`	String	Match type for the criteria of the payment scheduler. Valid values are `Match Any` or `Match None`.	Required if the `frequencyCadence` property is set to `Monthly`.	64.0
`endDate`	String	End date of the payment scheduler.	Required if the `frequencyCadence` property is set to `Monthly`.	64.0
`frequencyCadence`	String	Frequency cadence of the payment scheduler.	Required	64.0
`filterCriteria`	Payment Run Batch Filter Criteria Input	List of criteria that are used to filter the payment run details.	Required if the `frequencyCadence` property is set to `Monthly`.	64.0
`preferredTime`	String	Preferred time for the payment scheduler run.	Required	64.0
`recursEveryMonthOnDay`	String	Date when the payment scheduler recurs.	Required if the `frequencyCadence` property is set to `Monthly`.	64.0
`schedulerName`	String	Name of the payment scheduler.	Required	64.0
`startDate`	String	Start date of the payment scheduler.	Required	64.0
`status`	String	Status of the payment scheduler. Valid values are `Active`, `Canceled`, `Draft`, or `Inactive`.	Required	64.0

Valid values are:

Once
Daily
Weekly
Monthly

Response Body for POST

Batch Payments Scheduler