Global

Type Definitions

DhEntry

Source:
Properties:
Name Type Description
reference string
currency string
amount number
counterCurrency string
amountAfterCancellations number | null
rate number | null
ratePair string
marketDirection string
entryDate string
valueDate string
createdTimeStamp string
entryStatus string
cancellationRatePercent number | null
entryRef string | null
notes string | null
counterValue number | null
positionRef string
conditionalOrderRef string
executionRate number | null
hedgedRate number | null
hedgedRatePair string
deltaResult number | null
orderRef string
executionReason string

Kantox Dynamic Hedging entry structure.

Type:
  • object

DhFetchParams

Source:
Properties:
Name Type Attributes Description
currency string <optional>
counterCurrency string <optional>
marketDirection string <optional>
createdStart Date <optional>
createdEnd Date <optional>
updatedStart Date <optional>
updatedEnd Date <optional>
entryRef string <optional>
positionRef string <optional>
entryStatus string <optional>
page number <optional>
perPage number <optional>
Type:
  • object

ExternalEventData

Source:
Properties:
Name Type Description
id string
url string
createdAt string
metadata any

External event data

Type:
  • object

ExternalPaymentEvent

Source:
Properties:
Name Type Attributes Description
event_id string
id string
payment_id string <optional>
status string
service string
external_url string
created_at Date
metadata any <optional>

External payment event

Type:
  • object

Payment

Source:
Properties:
Name Type Attributes Description
id number <optional>
createdAt Date <optional>
key string
amount number
currency string
direction PaymentDirection
description string <optional>
companyId string
actionBy string
status PaymentStatus
reason string <optional>
effectiveDate Date
processingKey string
processingState PaymentProcessingState
contractName string
externalKey string <optional>
externalService string <optional>
externalStatus string <optional>
metadata any <optional>
eventData ExternalEventData <optional>
originatingAccount string <optional>
receivingAccount string <optional>

The payment type

Type:
  • object

PaymentBatchApprove

Source:
Properties:
Name Type Description
approved Array
errors Array

Batch approval response type

Type:
  • object

PaymentError

Source:
Properties:
Name Type Description
key string
error string

Payment error used for batch approvals responses

Type:
  • object

PaymentFilters

Source:
Properties:
Name Type Attributes Description
contractName string <optional>
direction PaymentDirection <optional>
status Array <optional>
currency string <optional>
amount PaymentFiltersAmount <optional>
effectiveDate PaymentFiltersEffectiveDate <optional>
actionBy string <optional>
offset number <optional>
limit number <optional>

Filtering params for payment getters and filtering

Type:
  • object

PaymentFiltersAmount

Source:
Properties:
Name Type Description
gt number
gte number
lt number
lte number

Filtering params for amounts

Type:
  • object

PaymentFiltersEffectiveDate

Source:
Properties:
Name Type Description
gt Date
gte Date
lt Date
lte Date

Filtering params for the effective date

Type:
  • object

PaymentParams

Source:
Properties:
Name Type Attributes Description
key string <optional>
amount number
currency string
direction PaymentDirection
description string <optional>
effectiveDate Date <optional>
contractName string
originatingAccount string <optional>
companyId string <optional>
receivingAccount string <optional>
metadata any <optional>

Params for payment creation

Type:
  • object