capture
The capture
element is the parent element for all Capture (deposit) transactions. You can use this element in either Online or Batch transactions.
Parent Elements:
cnpOnlineRequest, batchRequest
Attributes:
Attribute Name |
Type |
Required? |
Description |
---|---|---|---|
id |
String |
Yes |
A unique identifier assigned by the presenter and mirrored back in the response. minLength = 1 maxLength = 36 |
customerId |
String |
No |
A value assigned by the merchant to identify the consumer. minLength = N/A maxLength = 50 |
reportGroup |
String |
Yes |
Required attribute that defines the merchant sub-group in the user interface where this transaction will be displayed. For additional information, please refer to Coding for Report Groups. minLength = 1 maxLength = 25 |
partial |
Boolean |
No |
If there is more than one capture that references the same Valid Values = true or false Note: If you settle in a currency other than US or Canada, you cannot use partial captures. |
Child Elements:
Required: cnpTxnId, payPalOrderComplete (required only if closing a PayPal order)
Optional: orderId, amount, enhancedData, payPalNotes, pin, processingInstructions, surchargeAmount, lodgingInfo, passengerTransportData, foreignRetailerIndicator, partialCapture
If you do not specify an amount, the system uses the full amount from the associated Authorization transaction.