accountId |
String |
Salesforce account that contains the payment for the sale
request. |
Optional |
54.0 |
additionalData |
Map<String, String> |
Additional data that can be passed with a payment request. This property
can include a maximum of five key-value pair entries. Each key and 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 |
A 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. The key can be in the
payload or the header but not both. |
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 |