Class ApiCaptureRequest
Inheritance
ApiCaptureRequest
Namespace: Worldline.Acquiring.Sdk.V1.Domain
Assembly: Worldline.Acquiring.Sdk.dll
Syntax
public class ApiCaptureRequest
Properties
Amount
Amount to capture. If not provided, the full amount will be captured.
Declaration
public AmountData Amount { get; set; }
Property Value
CaptureAmountBreakdownData
Additional data regarding the breakdown of the capture amount. This can include amounts such as tip.
The amounts specified are included in the total capture amount, the information is provided
for data enrichment and reconciliation purposes.
Declaration
public CaptureAmountBreakdownData CaptureAmountBreakdownData { get; set; }
Property Value
CaptureSequenceNumber
The index of the partial capture. Not needed for full capture.
Declaration
public int? CaptureSequenceNumber { get; set; }
Property Value
DynamicCurrencyConversion
Dynamic Currency Conversion (DCC) rate data from DCC lookup response.
Mandatory for DCC transactions.
Declaration
public DccData DynamicCurrencyConversion { get; set; }
Property Value
IsFinal
Indicates whether this partial capture is the final one.
Not needed for full capture.
Declaration
public bool? IsFinal { get; set; }
Property Value
MarketplaceData
Additional data for marketplace transactions. Required when capturing VISA payments on behalf of
sellers that are located in a different region than the marketplace. We advise marketplaces to
always provide this data to ensure optimal processing of the transactions.
Declaration
public MarketplaceData MarketplaceData { get; set; }
Property Value
OperationId
A globally unique identifier of the operation, generated by you.
We advise you to submit a UUID or an identifier composed of an arbitrary string
and a UUID/URL-safe Base64 UUID (RFC 4648 §5).
It's used to detect duplicate requests or to reference an operation in
technical reversals.
Declaration
public string OperationId { get; set; }
Property Value
References
Declaration
public PaymentReferences References { get; set; }
Property Value
TerminalData
Declaration
public TerminalData TerminalData { get; set; }
Property Value
TransactionTimestamp
Timestamp of transaction in ISO 8601 format (YYYY-MM-DDThh:mm:ss+TZD)
It can be expressed in merchant time zone (ex: 2023-10-10T08:00+02:00)
or in UTC (ex: 2023-10-10T08:00Z)
Declaration
public DateTimeOffset TransactionTimestamp { get; set; }
Property Value