Capture Input

Payment capture input consumed by payment capture service.

JSON example (without idempotency)

1{
2{
3  "accountId":"",
4  "amount": 150,
5  "comments": "capture request",
6  "paymentGroup":{
7      "createPaymentGroup":"true",
8      "sourceObjectId":"",
9      "currencyIsoCode":"USD"
10  },
11{
12  "effectiveDate":"2019-10-18T11:32:27.000Z",
13  "ipAddress": "202.95.77.70",
14  "macAddress": "00-14-22-01-23-45",
15  "phone": "100-456-67",
16  "email": "test@ccs.org",
17  "additionalData":{
18      "key1":"value1",
19      "key2":"value2",
20      "key3":"value3",
21      "key4":"value4",
22      "key5":"value5"
23    }
24}

JSON example (idempotency key in JSON payload)

1{
2  "accountId":"",
3  "amount": 150,
4  "idempotencyKey":"qw",
5  "comments": "capture request",
6  "paymentGroup":{
7      "createPaymentGroup":"true",
8      "sourceObjectId":"",
9      "currencyIsoCode":"USD"
10  },
11  "effectiveDate":"2019-10-18T11:32:27.000Z",
12  "ipAddress": "202.95.77.70",
13  "macAddress": "00-14-22-01-23-45",
14  "phone": "100-456-67",
15  "email": "test@ccs.org",
16  "additionalData":{
17      "key1":"value1",
18      "key2":"value2",
19      "key3":"value3",
20      "key4":"value4",
21      "key5":"value5"
22    }
23}

JSON example (idempotency key in header)

JSON

1{
2  "accountId":"",
3  "amount": 150,
4  "comments": "capture request",
5  "paymentGroup":{
6      "createPaymentGroup":"true",
7      "sourceObjectId":"",
8      "currencyIsoCode":"USD"
9  },
10  "effectiveDate":"2019-10-18T11:32:27.000Z",
11  "ipAddress": "202.95.77.70",
12  "macAddress": "00-14-22-01-23-45",
13  "phone": "100-456-67",
14  "email": "test@ccs.org",
15  "additionalData":{
16      "key1":"value1",
17      "key2":"value2",
18      "key3":"value3",
19      "key4":"value4",
20      "key5":"value5"
21    }
22}

Header

Data Type: String

Max Length: 255

Header parameter name: sfdc-Payments-Idempotency-Key

Header example:

1"
2Content-Type: application/json; charset=UTF-8
3Accept: application/json
4sfdc-Payments-Idempotence-Key: UniqueIdempotencyKey
5"

Properties

Name	Type	Description	Required or Optional	Available Version
`accountId`	String	ID of the account that must be linked to this capture request.	Optional	48.0
`additionalData`	Map<String, String>	Allows users to enter additional data, if needed for 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	48.0
`amount`	Double	Amount that must be captured.	Required	48.0
`clientContext`	String	Provides context for payment APIs. Used for a payment caller to reestablish context.	Optional	49.0
`comments`	String	Comments for payment capture request.	Optional	48.0
`effectiveDate`	String	Date that the payment becomes effective.	Optional	48.0
`email`	String	Email of the client that initiated the request.	Optional	48.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	48.0
`ipAddress`	String	IP address of the client who made the request.	Optional	48.0
`macAddress`	String	MAC address of the client who made the request.	Optional	48.0
`paymentGroup`	Payment Group Input	Payment group details associated with the payment request.	Optional	48.0
`phone`	String	Phone number of the client that initiated the request.	Optional	48.0

Connect REST API Developer Guide

Capture Input