| Name | Description | Type | Additional information |
|---|---|---|---|
| AccountLevelAddOnPayments | Collection of APIAccountLevelAddOnPayment |
None. |
|
| ApprovedByUserID |
Optional user ID of supervisor who approved payment request |
int? |
None. |
| Attributes |
Optional attributes to store on the payment record |
Dictionary of string [key] and string [value] |
None. |
| Channel |
Optional override for the payment channel |
PaymentChannel |
None. |
| CheckForDuplicate |
Specifies whether the payment should fail if another payment of equal amount was made for this account in the past 24 hours. |
boolean |
None. |
| Customer |
For one-time payments, contains the information of the customer submitting the payment. |
CustomerModel |
None. |
| CustomerToken |
For enrolled payments, contains the unique customer token used to identify the customer making the payment. |
string |
None. |
| EmailConfirmation | boolean |
None. |
|
| ExternalPaymentID |
Optional payment identifier generated from 3rd party for logging and reconciliation purposes. |
string |
String length: inclusive between 0 and 100 |
| ExternalTranactionID |
For BPX reconciliation purpose |
string |
String length: inclusive between 0 and 100 |
| InvoicePayments |
Lists the invoices and how they are to be paid. |
Collection of InvoicePaymentModel |
Required |
| MailConfirmation | boolean |
None. |
|
| PaymentAccount |
For enrolled or one-time payments, contains the new payment account information to use for the payment. Will be saved as an available payment account for enrolled customers. |
PaymentAccountModel |
None. |
| PaymentAccountCVV |
For enrolled credit card payments, contains the security code of the existing account being used. |
string |
Matching regular expression pattern: \d{3,4} |
| PaymentAccountToken |
For enrolled payments, contains the payment account token of the existing payment account to use. |
string |
String length: inclusive between 0 and 1024 |
| PaymentDate |
Optional processing date for future-dated payments |
date-time? |
None. |
| PayPalCMID | string |
String length: inclusive between 0 and 32 |
|
| UniqueTransactionID |
Optional unique identifier for new payment requests that are logically the same. Used in conjunction with the CheckForDuplicate flag to prevent duplicate payments |
string |
String length: inclusive between 0 and 100 |
| UserLevelAddOnPayments | Collection of APIAddOnPayment |
None. |
|
| WaiveFee |
Specifies whether fees should be waived |
boolean? |
None. |