Getting Started

  • Kooltra exposes a simple RESTful API to book trades, send payments, and manage accounts, beneficiaries and more. The API operates over HTTP and all requests/responses are JSON objects.
  • To get started, please review the guide in full and reach out to your account manager or implementation@kooltra.com if you have any questions

Authentication

  • Kooltra provides authentication with OAuth2 - Client Credentials

Access Tokens

  • Upon request, Kooltra will provide the integrator with Sandbox and Production access credentials

Token Scopes

  • We leverage the least privileged principle for integrations with regard to token generation
  • Below is the list of scopes in Kooltra's API. At this time, Kooltra maintains scopes on behalf of the integrator during the onboarding process.
Scope Description FQN
counterparty Allows access to Counterparties API api.kooltra.com/counterparty:write for write operations
api.kooltra.com/counterparty:read for read operations
contact Allows access to Contacts API api.kooltra.com/contact:write for write operations
api.kooltra.com/contact:read for read operations
trade Allows access to Trades API api.kooltra.com/trade:write for write operations
api.kooltra.com/trade:read for read operations
beneficiary Allows access to Beneficiaries API api.kooltra.com/beneficiary:write for write operations
api.kooltra.com/beneficiary:read for read operations
cashflow Allows access to Cashflows API api.kooltra.com/cashflow:write for write operations
api.kooltra.com/cashflow:read for read operations
order Allows access to Orders API api.kooltra.com/order:write for write operations
api.kooltra.com/order:read for read operations

Development

  • Kooltra offers integrators both Sandbox and Production environments
  • Our process to go to production is as follows:
    1. Sandbox Connection: Integrator is provided Sandbox credentials
    2. Conformance Testing: Kooltra provides conformance tests matching the Integrator's use case. To receive our conformance test package, please reach out to implementation@kooltra.com.
    3. Production Connection: Once conformance tests are signed-off, Kooltra will provide production credentials for the integrator
    4. Final Sign-off: An additional set of production tests are run. Once confirmed, you will be able to use the API in production.

Status Codes

  • Kooltra's API uses standard HTTP response codes.
    • Any 200 response is successful
    • Any 400-499 response means there was a business error, like a missing currency pair on a trade. These errors are typically something that you can fix in your request.
    • Any 500 response means there was a system error, which is typically on our side and we will work to fix immediately.

Errors

  • When there is an error response, Kooltra provides as much descriptive information as we can.
  • Our errors include the following:
    • Message: Describes the reason for error with as much context as we have
    • Type: The category of error
    • Code: The specific error code

Idempotent Requests

  • Kooltra's API supports idempotent requests to help prevent you from accidentally issuing the same API call twice.
  • This feature can be helpful if you are booking a trade, creating a payment, or updating a counterparty.
  • To use our idempotency feature, you need to include an External Reference ID (a field in the request payload indicated as *idempotent) in all requests. The value is a user-defined unique identification used to both externally identify the record and avoid duplicate operations.

Additional Information

  • Results are only saved if the request is successfully executed.
  • The full operation may be complete even if there was a connection interruption or another external error that prevented us from responding to the original request.
  • If the system is in the middle or has completed processing a request with an idempotency key and receives another request with the same key, it will return a 400 error for the newer request.

Rate Limits

  • Sandbox: The current rate limit is 25 requests per second.
  • Production: The current rate limit is 100 requests per second.
  • If the rate limit is exceeded you will receive a 400 error response

Platform Fundamentals

Counterparties

  • In Kooltra's platform, counterparties include client accounts/counterparties, LP counterparties, and internal accounts
  • You can create counterparties through our API using our Company, Individual, or Internal endpoints
    • Company Counterparties: For client accounts that are legal entities or businesses.
      • Note: LP counterparty creation is not currently available through the API and can only be created using Kooltra's user interface
    • Individual Counterparties: For client accounts that are individuals.
    • Internal Counterparty: For accounts that are used internally, like a treasury or trading desk.
  • Kooltra's API currently supports the below settlement types. Based on the settlement type selected, the trades will be treated differently in settlement workflows.
    • Vostro: indicates the counterparty will settle on a net basis
    • Payments: indicates the counterparty will settle on a gross basis
  • For more information on counterparties please visit Knowledge Base - Counterparty Management

Trades

  • In Kooltra, all trades are booked from the "House" perspective
  • We currently support the following trade types in the API. Each trade type has its own set of endpoints to create and update, with a shared cancellation endpoint.
    • Spot/Forward
    • FX Swap
    • FX NDF
  • You have the ability to book single-leg counterparty trades or double-leg (i.e., client & hedge) trades with our API
    • Double Leg trade:
      • When a "hedgeCounterpartyId" is sent in the request, Kooltra will consider this a double leg trade
      • When a double leg trade is created, two trades will be booked in the system reflecting the client and hedge legs respectively
  • For more information on Kooltra's trading capabilities please visit Knowledge Base - Trade Management

Beneficiaries

  • A Beneficiary represents a bank account owned by a particular individual/entity that is associated with a counterparty.
  • Each Beneficiary can have one or more settlement methods associated with it, which define the mechanism for how funds are paid into, or received from, the bank account (e.g. wire, cheque, etc).
  • For more information on beneficiaries please visit Knowledge Base - Beneficiaries

Cashflows

  • Cashflows can be created as either incoming funds or outgoing payments. Kooltra distinguishes between incoming or outgoing funds using the "type" field in the payment request body.
  • The type field can have the following values:
    • WireIn: Used for incoming funds
    • WireOut: Used for outgoing funds
  • We also support vostro and nostro adjustments. Vostro adjustments are client account adjustments, while nostro adjustments are for bank/LP account adjustments
  • For more information on cashflows and settlements please refer to Knowledge Base - Cash Management
API docs by Redocly

Kooltra API (0.1.0)

Download OpenAPI specification:Download

Kooltra exposes a simple RESTful API to book trades, send payments, and manage accounts, beneficiaries and more. The API operates over HTTP and all requests/responses are JSON objects.

Counterparties

Get Counterparty

Authorizations:
CounterpartiesOAuth2
path Parameters
id
required
string
Example: a2759cca-21db-4a7f-90f9-e95d6ae7fb97

The code used to identify the counterparty

Responses

Response samples

Content type
application/json
Example
{
  • "status": "Active",
  • "settlementType": "Payments",
  • "entityId": "Entity Name",
  • "baseCurrency": "USD",
  • "primaryEmail": "general@abctech.com",
  • "phoneNumber": "1-647-218-7730",
  • "code": "123456-A435",
  • "address": {
    },
  • "lei": "7XIACKNMUAW2",
  • "leiExpirationDate": "2024-08-20",
  • "authorizedCurrencies": [
    ],
  • "authorizedProducts": [
    ],
  • "incomingSettlementMethods": [
    ],
  • "outgoingSettlementMethods": [
    ],
  • "referenceName": "ABC Tech Co.",
  • "legalName": "ABC Technologies Corporation",
  • "type": "Company",
  • "id": "e8c1e961-dc82-44d2-9775-b5580aa7460f"
}

Create company counterparty

Authorizations:
CounterpartiesOAuth2
Request Body schema: application/json
required
status
required
string (CounterpartyStatus)
Enum: "Pending" "PendingReview" "Active" "Inactive" "Greylist" "Suspended" "Closed" "RejectedByCompliance"

The account/counterparty status

settlementType
required
string (SettlementType)
Enum: "Payments" "Vostro"

The settlement type of the account/counterparty

entityId
required
string
baseCurrency
required
string

The account/counterparty base currency

primaryEmail
string <email>

The email of the Individual or Company primary contact

phoneNumber
string

Phone number of the account/counterparty

code
string^[A-Z0-9]{5,20}$

The code used to identify the account/counterparty

object (CounterpartyAddress)

address object

lei
string

Legal Entity Identifier

leiExpirationDate
string <date>

The expiration date of the LEI

authorizedCurrencies
Array of strings

List of authorized currencies for the account

authorizedProducts
Array of strings (AuthorizedProducts)
Items Enum: "FxSpot" "FxForward" "FxWindowForward" "FxSwap" "FxVanillaOption" "FxSingleBarrierOption" "FxDoubleBarrierOption" "FxNdf" "CFD" "Crypto"

List of products the account/counterparty is authorized for trading

incomingSettlementMethods
Array of strings

List of authorized incoming settlement methods for the account/counterparty

outgoingSettlementMethods
Array of strings

List of authorized outgoing settlement methods for the account/counterparty

referenceName
required
string

The account/counterparty name

legalName
string

The account/counterparty name

Responses

Request samples

Content type
application/json
{
  • "status": "Active",
  • "settlementType": "Payments",
  • "entityId": "Entity Name",
  • "baseCurrency": "USD",
  • "primaryEmail": "general@abctech.com",
  • "phoneNumber": "1-647-218-7730",
  • "code": "123456-A435",
  • "address": {
    },
  • "lei": "7XIACKNMUAW2",
  • "leiExpirationDate": "2024-08-20",
  • "authorizedCurrencies": [
    ],
  • "authorizedProducts": [
    ],
  • "incomingSettlementMethods": [
    ],
  • "outgoingSettlementMethods": [
    ],
  • "referenceName": "ABC Tech Co.",
  • "legalName": "ABC Technologies Corporation"
}

Response samples

Content type
application/json
{
  • "status": "Active",
  • "settlementType": "Payments",
  • "entityId": "Entity Name",
  • "baseCurrency": "USD",
  • "primaryEmail": "general@abctech.com",
  • "phoneNumber": "1-647-218-7730",
  • "code": "123456-A435",
  • "address": {
    },
  • "lei": "7XIACKNMUAW2",
  • "leiExpirationDate": "2024-08-20",
  • "authorizedCurrencies": [
    ],
  • "authorizedProducts": [
    ],
  • "incomingSettlementMethods": [
    ],
  • "outgoingSettlementMethods": [
    ],
  • "referenceName": "ABC Tech Co.",
  • "legalName": "ABC Technologies Corporation",
  • "type": "Company",
  • "id": "e8c1e961-dc82-44d2-9775-b5580aa7460f"
}

Update company counterparty

Authorizations:
CounterpartiesOAuth2
path Parameters
id
required
string
Example: a2759cca-21db-4a7f-90f9-e95d6ae7fb97

The code used to identify the counterparty

Request Body schema: application/json
required
status
required
string (CounterpartyStatus)
Enum: "Pending" "PendingReview" "Active" "Inactive" "Greylist" "Suspended" "Closed" "RejectedByCompliance"

The account/counterparty status

settlementType
required
string (SettlementType)
Enum: "Payments" "Vostro"

The settlement type of the account/counterparty

entityId
required
string
baseCurrency
required
string

The account/counterparty base currency

primaryEmail
string <email>

The email of the Individual or Company primary contact

phoneNumber
string

Phone number of the account/counterparty

code
string^[A-Z0-9]{5,20}$

The code used to identify the account/counterparty

object (CounterpartyAddress)

address object

lei
string

Legal Entity Identifier

leiExpirationDate
string <date>

The expiration date of the LEI

authorizedCurrencies
Array of strings

List of authorized currencies for the account

authorizedProducts
Array of strings (AuthorizedProducts)
Items Enum: "FxSpot" "FxForward" "FxWindowForward" "FxSwap" "FxVanillaOption" "FxSingleBarrierOption" "FxDoubleBarrierOption" "FxNdf" "CFD" "Crypto"

List of products the account/counterparty is authorized for trading

incomingSettlementMethods
Array of strings

List of authorized incoming settlement methods for the account/counterparty

outgoingSettlementMethods
Array of strings

List of authorized outgoing settlement methods for the account/counterparty

referenceName
required
string

The account/counterparty name

legalName
string

The account/counterparty name

Responses

Request samples

Content type
application/json
{
  • "status": "Active",
  • "settlementType": "Payments",
  • "entityId": "Entity Name",
  • "baseCurrency": "USD",
  • "primaryEmail": "general@abctech.com",
  • "phoneNumber": "1-647-218-7730",
  • "code": "123456-A435",
  • "address": {
    },
  • "lei": "7XIACKNMUAW2",
  • "leiExpirationDate": "2024-08-20",
  • "authorizedCurrencies": [
    ],
  • "authorizedProducts": [
    ],
  • "incomingSettlementMethods": [
    ],
  • "outgoingSettlementMethods": [
    ],
  • "referenceName": "ABC Tech Co.",
  • "legalName": "ABC Technologies Corporation"
}

Response samples

Content type
application/json
{
  • "status": "Active",
  • "settlementType": "Payments",
  • "entityId": "Entity Name",
  • "baseCurrency": "USD",
  • "primaryEmail": "general@abctech.com",
  • "phoneNumber": "1-647-218-7730",
  • "code": "123456-A435",
  • "address": {
    },
  • "lei": "7XIACKNMUAW2",
  • "leiExpirationDate": "2024-08-20",
  • "authorizedCurrencies": [
    ],
  • "authorizedProducts": [
    ],
  • "incomingSettlementMethods": [
    ],
  • "outgoingSettlementMethods": [
    ],
  • "referenceName": "ABC Tech Co.",
  • "legalName": "ABC Technologies Corporation",
  • "type": "Company",
  • "id": "e8c1e961-dc82-44d2-9775-b5580aa7460f"
}

Create internal counterparty

Authorizations:
CounterpartiesOAuth2
Request Body schema: application/json
required
status
required
string (CounterpartyStatus)
Enum: "Pending" "PendingReview" "Active" "Inactive" "Greylist" "Suspended" "Closed" "RejectedByCompliance"

The account/counterparty status

settlementType
required
string (SettlementType)
Enum: "Payments" "Vostro"

The settlement type of the account/counterparty

entityId
required
string
baseCurrency
required
string

The account/counterparty base currency

primaryEmail
string <email>

The email of the Individual or Company primary contact

phoneNumber
string

Phone number of the account/counterparty

code
string^[A-Z0-9]{5,20}$

The code used to identify the account/counterparty

object (CounterpartyAddress)

address object

lei
string

Legal Entity Identifier

leiExpirationDate
string <date>

The expiration date of the LEI

authorizedCurrencies
Array of strings

List of authorized currencies for the account

authorizedProducts
Array of strings (AuthorizedProducts)
Items Enum: "FxSpot" "FxForward" "FxWindowForward" "FxSwap" "FxVanillaOption" "FxSingleBarrierOption" "FxDoubleBarrierOption" "FxNdf" "CFD" "Crypto"

List of products the account/counterparty is authorized for trading

incomingSettlementMethods
Array of strings

List of authorized incoming settlement methods for the account/counterparty

outgoingSettlementMethods
Array of strings

List of authorized outgoing settlement methods for the account/counterparty

referenceName
required
string

The account/counterparty name

legalName
string

The account/counterparty name

Responses

Request samples

Content type
application/json
{
  • "status": "Active",
  • "settlementType": "Payments",
  • "entityId": "Entity Name",
  • "baseCurrency": "USD",
  • "primaryEmail": "general@abctech.com",
  • "phoneNumber": "1-647-218-7730",
  • "code": "123456-A435",
  • "address": {
    },
  • "lei": "7XIACKNMUAW2",
  • "leiExpirationDate": "2024-08-20",
  • "authorizedCurrencies": [
    ],
  • "authorizedProducts": [
    ],
  • "incomingSettlementMethods": [
    ],
  • "outgoingSettlementMethods": [
    ],
  • "referenceName": "ABC Tech Co.",
  • "legalName": "ABC Technologies Corporation"
}

Response samples

Content type
application/json
{
  • "status": "Active",
  • "settlementType": "Payments",
  • "entityId": "Entity Name",
  • "baseCurrency": "USD",
  • "primaryEmail": "general@abctech.com",
  • "phoneNumber": "1-647-218-7730",
  • "code": "123456-A435",
  • "address": {
    },
  • "lei": "7XIACKNMUAW2",
  • "leiExpirationDate": "2024-08-20",
  • "authorizedCurrencies": [
    ],
  • "authorizedProducts": [
    ],
  • "incomingSettlementMethods": [
    ],
  • "outgoingSettlementMethods": [
    ],
  • "referenceName": "ABC Tech Co.",
  • "legalName": "ABC Technologies Corporation",
  • "type": "Internal",
  • "id": "e8c1e961-dc82-44d2-9775-b5580aa7460f"
}

Update internal counterparty

Authorizations:
CounterpartiesOAuth2
path Parameters
id
required
string
Example: a2759cca-21db-4a7f-90f9-e95d6ae7fb97

The code used to identify the counterparty

Request Body schema: application/json
required
status
required
string (CounterpartyStatus)
Enum: "Pending" "PendingReview" "Active" "Inactive" "Greylist" "Suspended" "Closed" "RejectedByCompliance"

The account/counterparty status

settlementType
required
string (SettlementType)
Enum: "Payments" "Vostro"

The settlement type of the account/counterparty

entityId
required
string
baseCurrency
required
string

The account/counterparty base currency

primaryEmail
string <email>

The email of the Individual or Company primary contact

phoneNumber
string

Phone number of the account/counterparty

code
string^[A-Z0-9]{5,20}$

The code used to identify the account/counterparty

object (CounterpartyAddress)

address object

lei
string

Legal Entity Identifier

leiExpirationDate
string <date>

The expiration date of the LEI

authorizedCurrencies
Array of strings

List of authorized currencies for the account

authorizedProducts
Array of strings (AuthorizedProducts)
Items Enum: "FxSpot" "FxForward" "FxWindowForward" "FxSwap" "FxVanillaOption" "FxSingleBarrierOption" "FxDoubleBarrierOption" "FxNdf" "CFD" "Crypto"

List of products the account/counterparty is authorized for trading

incomingSettlementMethods
Array of strings

List of authorized incoming settlement methods for the account/counterparty

outgoingSettlementMethods
Array of strings

List of authorized outgoing settlement methods for the account/counterparty

referenceName
required
string

The account/counterparty name

legalName
string

The account/counterparty name

Responses

Request samples

Content type
application/json
{
  • "status": "Active",
  • "settlementType": "Payments",
  • "entityId": "Entity Name",
  • "baseCurrency": "USD",
  • "primaryEmail": "general@abctech.com",
  • "phoneNumber": "1-647-218-7730",
  • "code": "123456-A435",
  • "address": {
    },
  • "lei": "7XIACKNMUAW2",
  • "leiExpirationDate": "2024-08-20",
  • "authorizedCurrencies": [
    ],
  • "authorizedProducts": [
    ],
  • "incomingSettlementMethods": [
    ],
  • "outgoingSettlementMethods": [
    ],
  • "referenceName": "ABC Tech Co.",
  • "legalName": "ABC Technologies Corporation"
}

Response samples

Content type
application/json
{
  • "status": "Active",
  • "settlementType": "Payments",
  • "entityId": "Entity Name",
  • "baseCurrency": "USD",
  • "primaryEmail": "general@abctech.com",
  • "phoneNumber": "1-647-218-7730",
  • "code": "123456-A435",
  • "address": {
    },
  • "lei": "7XIACKNMUAW2",
  • "leiExpirationDate": "2024-08-20",
  • "authorizedCurrencies": [
    ],
  • "authorizedProducts": [
    ],
  • "incomingSettlementMethods": [
    ],
  • "outgoingSettlementMethods": [
    ],
  • "referenceName": "ABC Tech Co.",
  • "legalName": "ABC Technologies Corporation",
  • "type": "Internal",
  • "id": "e8c1e961-dc82-44d2-9775-b5580aa7460f"
}

Create individual counterparty

Authorizations:
CounterpartiesOAuth2
Request Body schema: application/json
required
status
required
string (CounterpartyStatus)
Enum: "Pending" "PendingReview" "Active" "Inactive" "Greylist" "Suspended" "Closed" "RejectedByCompliance"

The account/counterparty status

settlementType
required
string (SettlementType)
Enum: "Payments" "Vostro"

The settlement type of the account/counterparty

entityId
required
string
baseCurrency
required
string

The account/counterparty base currency

primaryEmail
string <email>

The email of the Individual or Company primary contact

phoneNumber
string

Phone number of the account/counterparty

code
string^[A-Z0-9]{5,20}$

The code used to identify the account/counterparty

object (CounterpartyAddress)

address object

lei
string

Legal Entity Identifier

leiExpirationDate
string <date>

The expiration date of the LEI

authorizedCurrencies
Array of strings

List of authorized currencies for the account

authorizedProducts
Array of strings (AuthorizedProducts)
Items Enum: "FxSpot" "FxForward" "FxWindowForward" "FxSwap" "FxVanillaOption" "FxSingleBarrierOption" "FxDoubleBarrierOption" "FxNdf" "CFD" "Crypto"

List of products the account/counterparty is authorized for trading

incomingSettlementMethods
Array of strings

List of authorized incoming settlement methods for the account/counterparty

outgoingSettlementMethods
Array of strings

List of authorized outgoing settlement methods for the account/counterparty

firstName
required
string

The account/counterparty first name

lastName
required
string

The account/counterparty last name

middleName
string

The account/counterparty middle name

Responses

Request samples

Content type
application/json
{
  • "status": "Active",
  • "settlementType": "Payments",
  • "entityId": "Entity Name",
  • "baseCurrency": "USD",
  • "primaryEmail": "general@abctech.com",
  • "phoneNumber": "1-647-218-7730",
  • "code": "123456-A435",
  • "address": {
    },
  • "lei": "7XIACKNMUAW2",
  • "leiExpirationDate": "2024-08-20",
  • "authorizedCurrencies": [
    ],
  • "authorizedProducts": [
    ],
  • "incomingSettlementMethods": [
    ],
  • "outgoingSettlementMethods": [
    ],
  • "firstName": "Mary.",
  • "lastName": "Smith",
  • "middleName": "Adam"
}

Response samples

Content type
application/json
{
  • "status": "Active",
  • "settlementType": "Payments",
  • "entityId": "Entity Name",
  • "baseCurrency": "USD",
  • "primaryEmail": "general@abctech.com",
  • "phoneNumber": "1-647-218-7730",
  • "code": "123456-A435",
  • "address": {
    },
  • "lei": "7XIACKNMUAW2",
  • "leiExpirationDate": "2024-08-20",
  • "authorizedCurrencies": [
    ],
  • "authorizedProducts": [
    ],
  • "incomingSettlementMethods": [
    ],
  • "outgoingSettlementMethods": [
    ],
  • "firstName": "Mary.",
  • "lastName": "Smith",
  • "middleName": "Adam",
  • "type": "Individual",
  • "id": "c9adb564-198c-4b51-9290-c65c9b8c0d43"
}

Update individual counterparty

Authorizations:
CounterpartiesOAuth2
path Parameters
id
required
string
Example: a2759cca-21db-4a7f-90f9-e95d6ae7fb97

The code used to identify the counterparty

Request Body schema: application/json
required
status
required
string (CounterpartyStatus)
Enum: "Pending" "PendingReview" "Active" "Inactive" "Greylist" "Suspended" "Closed" "RejectedByCompliance"

The account/counterparty status

settlementType
required
string (SettlementType)
Enum: "Payments" "Vostro"

The settlement type of the account/counterparty

entityId
required
string
baseCurrency
required
string

The account/counterparty base currency

primaryEmail
string <email>

The email of the Individual or Company primary contact

phoneNumber
string

Phone number of the account/counterparty

code
string^[A-Z0-9]{5,20}$

The code used to identify the account/counterparty

object (CounterpartyAddress)

address object

lei
string

Legal Entity Identifier

leiExpirationDate
string <date>

The expiration date of the LEI

authorizedCurrencies
Array of strings

List of authorized currencies for the account

authorizedProducts
Array of strings (AuthorizedProducts)
Items Enum: "FxSpot" "FxForward" "FxWindowForward" "FxSwap" "FxVanillaOption" "FxSingleBarrierOption" "FxDoubleBarrierOption" "FxNdf" "CFD" "Crypto"

List of products the account/counterparty is authorized for trading

incomingSettlementMethods
Array of strings

List of authorized incoming settlement methods for the account/counterparty

outgoingSettlementMethods
Array of strings

List of authorized outgoing settlement methods for the account/counterparty

firstName
required
string

The account/counterparty first name

lastName
required
string

The account/counterparty last name

middleName
string

The account/counterparty middle name

Responses

Request samples

Content type
application/json
{
  • "status": "Active",
  • "settlementType": "Payments",
  • "entityId": "Entity Name",
  • "baseCurrency": "USD",
  • "primaryEmail": "general@abctech.com",
  • "phoneNumber": "1-647-218-7730",
  • "code": "123456-A435",
  • "address": {
    },
  • "lei": "7XIACKNMUAW2",
  • "leiExpirationDate": "2024-08-20",
  • "authorizedCurrencies": [
    ],
  • "authorizedProducts": [
    ],
  • "incomingSettlementMethods": [
    ],
  • "outgoingSettlementMethods": [
    ],
  • "firstName": "Mary.",
  • "lastName": "Smith",
  • "middleName": "Adam"
}

Response samples

Content type
application/json
{
  • "status": "Active",
  • "settlementType": "Payments",
  • "entityId": "Entity Name",
  • "baseCurrency": "USD",
  • "primaryEmail": "general@abctech.com",
  • "phoneNumber": "1-647-218-7730",
  • "code": "123456-A435",
  • "address": {
    },
  • "lei": "7XIACKNMUAW2",
  • "leiExpirationDate": "2024-08-20",
  • "authorizedCurrencies": [
    ],
  • "authorizedProducts": [
    ],
  • "incomingSettlementMethods": [
    ],
  • "outgoingSettlementMethods": [
    ],
  • "firstName": "Mary.",
  • "lastName": "Smith",
  • "middleName": "Adam",
  • "type": "Individual",
  • "id": "c9adb564-198c-4b51-9290-c65c9b8c0d43"
}

Contacts

Create contact

Authorizations:
ContactsOAuth2
Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID of the Client as provided by Kooltra

firstName
required
string

The first name of the contact

middleName
string

The middle name of the contact

lastName
required
string

The last name of the contact

email
string <email>

The email of the contact

phone
string

The primary phone number of the contact

mobilePhone
string

The mobile phone number of the contact

object (ContactAddress)

address object

primaryContactForTheCounterparty
boolean

true: this contact is the primary for the counterparty false: this contact is not the primary for the counterparty

authorizations
Array of strings (ContactAuthorization)
Items Enum: "Trading" "Settlements" "Signing"

List of authorizations

status
required
string (ContactStatus)
Enum: "Pending" "Active" "Inactive" "Restricted" "Temporary"

The contact status

externalContactId
string

The external ID of the contact

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "ad54452b-5291-4171-a194-842a5f942874",
  • "firstName": "David",
  • "middleName": "Kyle",
  • "lastName": "Robinson",
  • "email": "drobinson@test.com",
  • "phone": "011-44-20-1234-5678",
  • "mobilePhone": "011-44-20-9998-7777",
  • "address": {
    },
  • "primaryContactForTheCounterparty": true,
  • "authorizations": [
    ],
  • "status": "Active",
  • "externalContactId": "CO-123-456"
}

Response samples

Content type
application/json
{
  • "counterpartyId": "ad54452b-5291-4171-a194-842a5f942874",
  • "firstName": "David",
  • "middleName": "Kyle",
  • "lastName": "Robinson",
  • "email": "drobinson@test.com",
  • "phone": "011-44-20-1234-5678",
  • "mobilePhone": "011-44-20-9998-7777",
  • "address": {
    },
  • "primaryContactForTheCounterparty": true,
  • "authorizations": [
    ],
  • "status": "Active",
  • "externalContactId": "CO-123-456",
  • "id": "0d3f1a1a-20f9-4726-8606-4f5fef85dc74"
}

Get contact

Authorizations:
ContactsOAuth2
path Parameters
id
required
string
Example: 6a3d65d0-c864-425c-988c-b880ae693b0b

The code used to identify the contact

Responses

Response samples

Content type
application/json
{
  • "counterpartyId": "ad54452b-5291-4171-a194-842a5f942874",
  • "firstName": "David",
  • "middleName": "Kyle",
  • "lastName": "Robinson",
  • "email": "drobinson@test.com",
  • "phone": "011-44-20-1234-5678",
  • "mobilePhone": "011-44-20-9998-7777",
  • "address": {
    },
  • "primaryContactForTheCounterparty": true,
  • "authorizations": [
    ],
  • "status": "Active",
  • "externalContactId": "CO-123-456",
  • "id": "0d3f1a1a-20f9-4726-8606-4f5fef85dc74"
}

Update contact

Authorizations:
ContactsOAuth2
path Parameters
id
required
string
Example: 6a3d65d0-c864-425c-988c-b880ae693b0b

The code used to identify the contact

Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID of the Client as provided by Kooltra

firstName
required
string

The first name of the contact

middleName
string

The middle name of the contact

lastName
required
string

The last name of the contact

email
string <email>

The email of the contact

phone
string

The primary phone number of the contact

mobilePhone
string

The mobile phone number of the contact

object (ContactAddress)

address object

primaryContactForTheCounterparty
boolean

true: this contact is the primary for the counterparty false: this contact is not the primary for the counterparty

authorizations
Array of strings (ContactAuthorization)
Items Enum: "Trading" "Settlements" "Signing"

List of authorizations

status
required
string (ContactStatus)
Enum: "Pending" "Active" "Inactive" "Restricted" "Temporary"

The contact status

externalContactId
string

The external ID of the contact

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "ad54452b-5291-4171-a194-842a5f942874",
  • "firstName": "David",
  • "middleName": "Kyle",
  • "lastName": "Robinson",
  • "email": "drobinson@test.com",
  • "phone": "011-44-20-1234-5678",
  • "mobilePhone": "011-44-20-9998-7777",
  • "address": {
    },
  • "primaryContactForTheCounterparty": true,
  • "authorizations": [
    ],
  • "status": "Active",
  • "externalContactId": "CO-123-456"
}

Response samples

Content type
application/json
{
  • "counterpartyId": "ad54452b-5291-4171-a194-842a5f942874",
  • "firstName": "David",
  • "middleName": "Kyle",
  • "lastName": "Robinson",
  • "email": "drobinson@test.com",
  • "phone": "011-44-20-1234-5678",
  • "mobilePhone": "011-44-20-9998-7777",
  • "address": {
    },
  • "primaryContactForTheCounterparty": true,
  • "authorizations": [
    ],
  • "status": "Active",
  • "externalContactId": "CO-123-456",
  • "id": "0d3f1a1a-20f9-4726-8606-4f5fef85dc74"
}

Trades

Get trade

Authorizations:
TradesOAuth2
path Parameters
id
required
string
Example: 780d9625-efaf-4717-9cca-627c13f90ce2

The code used to identify the trade

query Parameters
includeMtm
boolean
Default: false
Example: includeMtm=true

Indicates if we need to include mtm value in response

Responses

Response samples

Content type
application/json
Example
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "dealtAmount": 1000,
  • "rate": 1.35,
  • "hedgeRate": 1.3,
  • "counterAmount": 1350,
  • "valueDate": "2023-06-22",
  • "id": "1dc09d9a-c78e-47e4-b7bb-538215fb99ed",
  • "mtm": {
    },
  • "type": "FxSpotForward"
}

Create Spot/Forward

Authorizations:
TradesOAuth2
Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID as provided by Kooltra

contactId
string <uuid>

The Contact ID as provided by Kooltra

bookId
string <uuid>

The Book ID as provided by Kooltra

ccyPair
required
string

The Currency Pair Name for the trade

dealtCurrency
required
string

The Dealt Currency of the trade

dealtAction
required
string (TradeAction)
Enum: "Buy" "Sell"

Buy: House purchases the Dealt Currency from the Counterparty Sell: House sells the Dealt Currency to the Counterparty

tradeDate
string <date>

The date the trade was executed

fee
number

The total Fee charged for the trade

feeCurrency
string

The currency of the Fee associated with the trade

internalComment
string

Comment that is only visible to internal team members when viewing the trade in Kooltra

clientComment
string

Comment that will be visible to internal team members and clients when viewing the trade in Kooltra

hedgeCounterpartyId
string <uuid>

Required for Double Leg Trades Only - The Counterparty ID of the Hedge Counterparty

orderId
string <uuid>

The Order ID in Kooltra associated with the trade

externalTradeId
string

Provide an external trade reference

liquidityProvider
string

The liquidity provider of the trade

platformVenue
string

The execution venue of the trade

dealtAmount
required
number

The amount bought or sold in the dealt currency

rate
required
number

The rate of the trade executed with the counterparty

hedgeRate
required
number

The hedge rate of the trade

counterAmount
number

The amount bought or sold in the non-dealt currency

valueDate
required
string <date>

The value date/settlement date of the trade

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "dealtAmount": 1000,
  • "rate": 1.35,
  • "hedgeRate": 1.3,
  • "counterAmount": 1350,
  • "valueDate": "2023-06-22"
}

Response samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "dealtAmount": 1000,
  • "rate": 1.35,
  • "hedgeRate": 1.3,
  • "counterAmount": 1350,
  • "valueDate": "2023-06-22",
  • "id": "1dc09d9a-c78e-47e4-b7bb-538215fb99ed",
  • "mtm": {
    },
  • "type": "FxSpot"
}

Create historical Spot/Forward

Authorizations:
TradesOAuth2
Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID as provided by Kooltra

contactId
string <uuid>

The Contact ID as provided by Kooltra

bookId
string <uuid>

The Book ID as provided by Kooltra

ccyPair
required
string

The Currency Pair Name for the trade

dealtCurrency
required
string

The Dealt Currency of the trade

dealtAction
required
string (TradeAction)
Enum: "Buy" "Sell"

Buy: House purchases the Dealt Currency from the Counterparty Sell: House sells the Dealt Currency to the Counterparty

tradeDate
string <date>

The date the trade was executed

fee
number

The total Fee charged for the trade

feeCurrency
string

The currency of the Fee associated with the trade

internalComment
string

Comment that is only visible to internal team members when viewing the trade in Kooltra

clientComment
string

Comment that will be visible to internal team members and clients when viewing the trade in Kooltra

hedgeCounterpartyId
string <uuid>

Required for Double Leg Trades Only - The Counterparty ID of the Hedge Counterparty

orderId
string <uuid>

The Order ID in Kooltra associated with the trade

externalTradeId
string

Provide an external trade reference

liquidityProvider
string

The liquidity provider of the trade

platformVenue
string

The execution venue of the trade

dealtAmount
required
number

The amount bought or sold in the dealt currency

rate
required
number

The rate of the trade executed with the counterparty

hedgeRate
required
number

The hedge rate of the trade

counterAmount
number

The amount bought or sold in the non-dealt currency

valueDate
required
string <date>

The value date/settlement date of the trade

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "dealtAmount": 1000,
  • "rate": 1.35,
  • "hedgeRate": 1.3,
  • "counterAmount": 1350,
  • "valueDate": "2023-06-22"
}

Response samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "dealtAmount": 1000,
  • "rate": 1.35,
  • "hedgeRate": 1.3,
  • "counterAmount": 1350,
  • "valueDate": "2023-06-22",
  • "id": "1dc09d9a-c78e-47e4-b7bb-538215fb99ed",
  • "mtm": {
    },
  • "type": "FxSpot"
}

Update Spot/Forward

Authorizations:
TradesOAuth2
path Parameters
id
required
string
Example: 780d9625-efaf-4717-9cca-627c13f90ce2

The code used to identify the trade

Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID as provided by Kooltra

contactId
string <uuid>

The Contact ID as provided by Kooltra

bookId
string <uuid>

The Book ID as provided by Kooltra

ccyPair
required
string

The Currency Pair Name for the trade

dealtCurrency
required
string

The Dealt Currency of the trade

dealtAction
required
string (TradeAction)
Enum: "Buy" "Sell"

Buy: House purchases the Dealt Currency from the Counterparty Sell: House sells the Dealt Currency to the Counterparty

tradeDate
string <date>

The date the trade was executed

fee
number

The total Fee charged for the trade

feeCurrency
string

The currency of the Fee associated with the trade

internalComment
string

Comment that is only visible to internal team members when viewing the trade in Kooltra

clientComment
string

Comment that will be visible to internal team members and clients when viewing the trade in Kooltra

hedgeCounterpartyId
string <uuid>

Required for Double Leg Trades Only - The Counterparty ID of the Hedge Counterparty

orderId
string <uuid>

The Order ID in Kooltra associated with the trade

externalTradeId
string

Provide an external trade reference

liquidityProvider
string

The liquidity provider of the trade

platformVenue
string

The execution venue of the trade

dealtAmount
required
number

The amount bought or sold in the dealt currency

rate
required
number

The rate of the trade executed with the counterparty

hedgeRate
required
number

The hedge rate of the trade

counterAmount
number

The amount bought or sold in the non-dealt currency

valueDate
required
string <date>

The value date/settlement date of the trade

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "dealtAmount": 1000,
  • "rate": 1.35,
  • "hedgeRate": 1.3,
  • "counterAmount": 1350,
  • "valueDate": "2023-06-22"
}

Response samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "dealtAmount": 1000,
  • "rate": 1.35,
  • "hedgeRate": 1.3,
  • "counterAmount": 1350,
  • "valueDate": "2023-06-22",
  • "id": "1dc09d9a-c78e-47e4-b7bb-538215fb99ed",
  • "mtm": {
    },
  • "type": "FxSpot"
}

Create Swap

Authorizations:
TradesOAuth2
Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID as provided by Kooltra

contactId
string <uuid>

The Contact ID as provided by Kooltra

bookId
string <uuid>

The Book ID as provided by Kooltra

ccyPair
required
string

The Currency Pair Name for the trade

dealtCurrency
required
string

The Dealt Currency of the trade

dealtAction
required
string (TradeAction)
Enum: "Buy" "Sell"

Buy: House purchases the Dealt Currency from the Counterparty Sell: House sells the Dealt Currency to the Counterparty

tradeDate
string <date>

The date the trade was executed

fee
number

The total Fee charged for the trade

feeCurrency
string

The currency of the Fee associated with the trade

internalComment
string

Comment that is only visible to internal team members when viewing the trade in Kooltra

clientComment
string

Comment that will be visible to internal team members and clients when viewing the trade in Kooltra

hedgeCounterpartyId
string <uuid>

Required for Double Leg Trades Only - The Counterparty ID of the Hedge Counterparty

orderId
string <uuid>

The Order ID in Kooltra associated with the trade

externalTradeId
string

Provide an external trade reference

liquidityProvider
string

The liquidity provider of the trade

platformVenue
string

The execution venue of the trade

parentTradeId
string <uuid>

The Parent Trade id of the swap

subType
string

Indication of whether the swap is a "Drawdown" or "Rollover" of another trade

nearDealtAmount
required
number

The amount bought or sold in the dealt currency on the near leg and far leg of the swap

nearRate
required
number

The rate of the trade executed with the counterparty. For FX Swaps, this is the rate on the near leg of the swap.

nearCounterAmount
number

The amount bought or sold in the non-dealt currency. For FX Swaps, the amount bought or sold in the non-dealt currency on the near leg of the swap

nearValueDate
required
string <date>

The value date/settlement date of the near leg of the swap

nearHedgeRate
required
number

The hedge rate of the trade. For FX Swaps, the Hedge Rate is the Hedge Rate of near leg of the swap

farDealtAmount
number

The amount bought or sold in the dealt currency on the near leg and far leg of the swap

farRate
required
number

The Rate on the Far Leg of the Swap

farCounterAmount
number

The amount bought or sold in the non-dealt currency. For FX Swaps, the amount bought or sold in the non-dealt currency on the far leg of the swap

farValueDate
required
string <date>

The value date/settlement date on the Far Leg of the Swap

farHedgeRate
required
number

The Hedge Rate of the Far Leg of the Swap

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "parentTradeId": "0856cf25-4369-42d8-abfe-57882a024c45",
  • "subType": null,
  • "nearDealtAmount": 1000,
  • "nearRate": 1.35,
  • "nearCounterAmount": 1000,
  • "nearValueDate": "2023-06-21",
  • "nearHedgeRate": 1.35,
  • "farDealtAmount": 1000,
  • "farRate": 1.35,
  • "farCounterAmount": 1000,
  • "farValueDate": "2023-06-21",
  • "farHedgeRate": 1.35
}

Response samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "parentTradeId": "0856cf25-4369-42d8-abfe-57882a024c45",
  • "subType": null,
  • "nearDealtAmount": 1000,
  • "nearRate": 1.35,
  • "nearCounterAmount": 1000,
  • "nearValueDate": "2023-06-21",
  • "nearHedgeRate": 1.35,
  • "farDealtAmount": 1000,
  • "farRate": 1.35,
  • "farCounterAmount": 1000,
  • "farValueDate": "2023-06-21",
  • "farHedgeRate": 1.35,
  • "id": "82e7047f-738b-4f48-9474-503de2939984",
  • "nearMtm": {
    },
  • "farMtm": {
    },
  • "type": "FxSwap"
}

Create historical Swap

Authorizations:
TradesOAuth2
Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID as provided by Kooltra

contactId
string <uuid>

The Contact ID as provided by Kooltra

bookId
string <uuid>

The Book ID as provided by Kooltra

ccyPair
required
string

The Currency Pair Name for the trade

dealtCurrency
required
string

The Dealt Currency of the trade

dealtAction
required
string (TradeAction)
Enum: "Buy" "Sell"

Buy: House purchases the Dealt Currency from the Counterparty Sell: House sells the Dealt Currency to the Counterparty

tradeDate
string <date>

The date the trade was executed

fee
number

The total Fee charged for the trade

feeCurrency
string

The currency of the Fee associated with the trade

internalComment
string

Comment that is only visible to internal team members when viewing the trade in Kooltra

clientComment
string

Comment that will be visible to internal team members and clients when viewing the trade in Kooltra

hedgeCounterpartyId
string <uuid>

Required for Double Leg Trades Only - The Counterparty ID of the Hedge Counterparty

orderId
string <uuid>

The Order ID in Kooltra associated with the trade

externalTradeId
string

Provide an external trade reference

liquidityProvider
string

The liquidity provider of the trade

platformVenue
string

The execution venue of the trade

parentTradeId
string <uuid>

The Parent Trade id of the swap

subType
string

Indication of whether the swap is a "Drawdown" or "Rollover" of another trade

nearDealtAmount
required
number

The amount bought or sold in the dealt currency on the near leg and far leg of the swap

nearRate
required
number

The rate of the trade executed with the counterparty. For FX Swaps, this is the rate on the near leg of the swap.

nearCounterAmount
number

The amount bought or sold in the non-dealt currency. For FX Swaps, the amount bought or sold in the non-dealt currency on the near leg of the swap

nearValueDate
required
string <date>

The value date/settlement date of the near leg of the swap

nearHedgeRate
required
number

The hedge rate of the trade. For FX Swaps, the Hedge Rate is the Hedge Rate of near leg of the swap

farDealtAmount
number

The amount bought or sold in the dealt currency on the near leg and far leg of the swap

farRate
required
number

The Rate on the Far Leg of the Swap

farCounterAmount
number

The amount bought or sold in the non-dealt currency. For FX Swaps, the amount bought or sold in the non-dealt currency on the far leg of the swap

farValueDate
required
string <date>

The value date/settlement date on the Far Leg of the Swap

farHedgeRate
required
number

The Hedge Rate of the Far Leg of the Swap

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "parentTradeId": "0856cf25-4369-42d8-abfe-57882a024c45",
  • "subType": null,
  • "nearDealtAmount": 1000,
  • "nearRate": 1.35,
  • "nearCounterAmount": 1000,
  • "nearValueDate": "2023-06-21",
  • "nearHedgeRate": 1.35,
  • "farDealtAmount": 1000,
  • "farRate": 1.35,
  • "farCounterAmount": 1000,
  • "farValueDate": "2023-06-21",
  • "farHedgeRate": 1.35
}

Response samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "parentTradeId": "0856cf25-4369-42d8-abfe-57882a024c45",
  • "subType": null,
  • "nearDealtAmount": 1000,
  • "nearRate": 1.35,
  • "nearCounterAmount": 1000,
  • "nearValueDate": "2023-06-21",
  • "nearHedgeRate": 1.35,
  • "farDealtAmount": 1000,
  • "farRate": 1.35,
  • "farCounterAmount": 1000,
  • "farValueDate": "2023-06-21",
  • "farHedgeRate": 1.35,
  • "id": "82e7047f-738b-4f48-9474-503de2939984",
  • "nearMtm": {
    },
  • "farMtm": {
    },
  • "type": "FxSwap"
}

Update Swap

Authorizations:
TradesOAuth2
path Parameters
id
required
string
Example: 780d9625-efaf-4717-9cca-627c13f90ce2

The code used to identify the trade

Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID as provided by Kooltra

contactId
string <uuid>

The Contact ID as provided by Kooltra

bookId
string <uuid>

The Book ID as provided by Kooltra

ccyPair
required
string

The Currency Pair Name for the trade

dealtCurrency
required
string

The Dealt Currency of the trade

dealtAction
required
string (TradeAction)
Enum: "Buy" "Sell"

Buy: House purchases the Dealt Currency from the Counterparty Sell: House sells the Dealt Currency to the Counterparty

tradeDate
string <date>

The date the trade was executed

fee
number

The total Fee charged for the trade

feeCurrency
string

The currency of the Fee associated with the trade

internalComment
string

Comment that is only visible to internal team members when viewing the trade in Kooltra

clientComment
string

Comment that will be visible to internal team members and clients when viewing the trade in Kooltra

hedgeCounterpartyId
string <uuid>

Required for Double Leg Trades Only - The Counterparty ID of the Hedge Counterparty

orderId
string <uuid>

The Order ID in Kooltra associated with the trade

externalTradeId
string

Provide an external trade reference

liquidityProvider
string

The liquidity provider of the trade

platformVenue
string

The execution venue of the trade

parentTradeId
string <uuid>

The Parent Trade id of the swap

subType
string

Indication of whether the swap is a "Drawdown" or "Rollover" of another trade

nearDealtAmount
required
number

The amount bought or sold in the dealt currency on the near leg and far leg of the swap

nearRate
required
number

The rate of the trade executed with the counterparty. For FX Swaps, this is the rate on the near leg of the swap.

nearCounterAmount
number

The amount bought or sold in the non-dealt currency. For FX Swaps, the amount bought or sold in the non-dealt currency on the near leg of the swap

nearValueDate
required
string <date>

The value date/settlement date of the near leg of the swap

nearHedgeRate
required
number

The hedge rate of the trade. For FX Swaps, the Hedge Rate is the Hedge Rate of near leg of the swap

farDealtAmount
number

The amount bought or sold in the dealt currency on the near leg and far leg of the swap

farRate
required
number

The Rate on the Far Leg of the Swap

farCounterAmount
number

The amount bought or sold in the non-dealt currency. For FX Swaps, the amount bought or sold in the non-dealt currency on the far leg of the swap

farValueDate
required
string <date>

The value date/settlement date on the Far Leg of the Swap

farHedgeRate
required
number

The Hedge Rate of the Far Leg of the Swap

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "parentTradeId": "0856cf25-4369-42d8-abfe-57882a024c45",
  • "subType": null,
  • "nearDealtAmount": 1000,
  • "nearRate": 1.35,
  • "nearCounterAmount": 1000,
  • "nearValueDate": "2023-06-21",
  • "nearHedgeRate": 1.35,
  • "farDealtAmount": 1000,
  • "farRate": 1.35,
  • "farCounterAmount": 1000,
  • "farValueDate": "2023-06-21",
  • "farHedgeRate": 1.35
}

Response samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "parentTradeId": "0856cf25-4369-42d8-abfe-57882a024c45",
  • "subType": null,
  • "nearDealtAmount": 1000,
  • "nearRate": 1.35,
  • "nearCounterAmount": 1000,
  • "nearValueDate": "2023-06-21",
  • "nearHedgeRate": 1.35,
  • "farDealtAmount": 1000,
  • "farRate": 1.35,
  • "farCounterAmount": 1000,
  • "farValueDate": "2023-06-21",
  • "farHedgeRate": 1.35,
  • "id": "82e7047f-738b-4f48-9474-503de2939984",
  • "nearMtm": {
    },
  • "farMtm": {
    },
  • "type": "FxSwap"
}

Create NDF

Authorizations:
TradesOAuth2
Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID as provided by Kooltra

contactId
string <uuid>

The Contact ID as provided by Kooltra

bookId
string <uuid>

The Book ID as provided by Kooltra

ccyPair
required
string

The Currency Pair Name for the trade

dealtCurrency
required
string

The Dealt Currency of the trade

dealtAction
required
string (TradeAction)
Enum: "Buy" "Sell"

Buy: House purchases the Dealt Currency from the Counterparty Sell: House sells the Dealt Currency to the Counterparty

tradeDate
string <date>

The date the trade was executed

fee
number

The total Fee charged for the trade

feeCurrency
string

The currency of the Fee associated with the trade

internalComment
string

Comment that is only visible to internal team members when viewing the trade in Kooltra

clientComment
string

Comment that will be visible to internal team members and clients when viewing the trade in Kooltra

hedgeCounterpartyId
string <uuid>

Required for Double Leg Trades Only - The Counterparty ID of the Hedge Counterparty

orderId
string <uuid>

The Order ID in Kooltra associated with the trade

externalTradeId
string

Provide an external trade reference

liquidityProvider
string

The liquidity provider of the trade

platformVenue
string

The execution venue of the trade

rate
required
number

The rate of the trade executed with the counterparty

valueDate
required
string <date>

The value date/settlement date of the trade

counterAmount
number

The amount bought or sold in the non-dealt currency

fixingDate
required
string <date>

The fixing date for an NDF trade

fixingReference
string

The Fixing Reference and associated Fixing Time (Ex: BRL PTAX (BRBR) Sao Paulo 13:15)

ndfSettlementCurrency
required
string

The currency of the settlement

hedgeRate
required
number

The hedge rate of the trade

dealtAmount
required
number

The amount bought or sold in the dealt currency

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "rate": 1.35,
  • "valueDate": "2023-06-22",
  • "counterAmount": 1350,
  • "fixingDate": "2023-06-22",
  • "fixingReference": "BRL PTAX (BRBR) Sao Paulo 13:15",
  • "ndfSettlementCurrency": "USD",
  • "hedgeRate": 1.3,
  • "dealtAmount": 1000
}

Response samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "rate": 1.35,
  • "valueDate": "2023-06-22",
  • "counterAmount": 1350,
  • "fixingDate": "2023-06-22",
  • "fixingReference": "BRL PTAX (BRBR) Sao Paulo 13:15",
  • "ndfSettlementCurrency": "USD",
  • "hedgeRate": 1.3,
  • "dealtAmount": 1000,
  • "id": "82e7047f-738b-4f48-9474-503de2939984",
  • "mtm": {
    },
  • "type": "FxNdf"
}

Create historical NDF

Authorizations:
TradesOAuth2
Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID as provided by Kooltra

contactId
string <uuid>

The Contact ID as provided by Kooltra

bookId
string <uuid>

The Book ID as provided by Kooltra

ccyPair
required
string

The Currency Pair Name for the trade

dealtCurrency
required
string

The Dealt Currency of the trade

dealtAction
required
string (TradeAction)
Enum: "Buy" "Sell"

Buy: House purchases the Dealt Currency from the Counterparty Sell: House sells the Dealt Currency to the Counterparty

tradeDate
string <date>

The date the trade was executed

fee
number

The total Fee charged for the trade

feeCurrency
string

The currency of the Fee associated with the trade

internalComment
string

Comment that is only visible to internal team members when viewing the trade in Kooltra

clientComment
string

Comment that will be visible to internal team members and clients when viewing the trade in Kooltra

hedgeCounterpartyId
string <uuid>

Required for Double Leg Trades Only - The Counterparty ID of the Hedge Counterparty

orderId
string <uuid>

The Order ID in Kooltra associated with the trade

externalTradeId
string

Provide an external trade reference

liquidityProvider
string

The liquidity provider of the trade

platformVenue
string

The execution venue of the trade

rate
required
number

The rate of the trade executed with the counterparty

valueDate
required
string <date>

The value date/settlement date of the trade

counterAmount
number

The amount bought or sold in the non-dealt currency

fixingDate
required
string <date>

The fixing date for an NDF trade

fixingReference
string

The Fixing Reference and associated Fixing Time (Ex: BRL PTAX (BRBR) Sao Paulo 13:15)

ndfSettlementCurrency
required
string

The currency of the settlement

hedgeRate
required
number

The hedge rate of the trade

dealtAmount
required
number

The amount bought or sold in the dealt currency

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "rate": 1.35,
  • "valueDate": "2023-06-22",
  • "counterAmount": 1350,
  • "fixingDate": "2023-06-22",
  • "fixingReference": "BRL PTAX (BRBR) Sao Paulo 13:15",
  • "ndfSettlementCurrency": "USD",
  • "hedgeRate": 1.3,
  • "dealtAmount": 1000
}

Response samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "rate": 1.35,
  • "valueDate": "2023-06-22",
  • "counterAmount": 1350,
  • "fixingDate": "2023-06-22",
  • "fixingReference": "BRL PTAX (BRBR) Sao Paulo 13:15",
  • "ndfSettlementCurrency": "USD",
  • "hedgeRate": 1.3,
  • "dealtAmount": 1000,
  • "id": "82e7047f-738b-4f48-9474-503de2939984",
  • "mtm": {
    },
  • "type": "FxNdf"
}

Update NDF

Authorizations:
TradesOAuth2
path Parameters
id
required
string
Example: 780d9625-efaf-4717-9cca-627c13f90ce2

The code used to identify the trade

Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID as provided by Kooltra

contactId
string <uuid>

The Contact ID as provided by Kooltra

bookId
string <uuid>

The Book ID as provided by Kooltra

ccyPair
required
string

The Currency Pair Name for the trade

dealtCurrency
required
string

The Dealt Currency of the trade

dealtAction
required
string (TradeAction)
Enum: "Buy" "Sell"

Buy: House purchases the Dealt Currency from the Counterparty Sell: House sells the Dealt Currency to the Counterparty

tradeDate
string <date>

The date the trade was executed

fee
number

The total Fee charged for the trade

feeCurrency
string

The currency of the Fee associated with the trade

internalComment
string

Comment that is only visible to internal team members when viewing the trade in Kooltra

clientComment
string

Comment that will be visible to internal team members and clients when viewing the trade in Kooltra

hedgeCounterpartyId
string <uuid>

Required for Double Leg Trades Only - The Counterparty ID of the Hedge Counterparty

orderId
string <uuid>

The Order ID in Kooltra associated with the trade

externalTradeId
string

Provide an external trade reference

liquidityProvider
string

The liquidity provider of the trade

platformVenue
string

The execution venue of the trade

rate
required
number

The rate of the trade executed with the counterparty

valueDate
required
string <date>

The value date/settlement date of the trade

counterAmount
number

The amount bought or sold in the non-dealt currency

fixingDate
required
string <date>

The fixing date for an NDF trade

fixingReference
string

The Fixing Reference and associated Fixing Time (Ex: BRL PTAX (BRBR) Sao Paulo 13:15)

ndfSettlementCurrency
required
string

The currency of the settlement

hedgeRate
required
number

The hedge rate of the trade

dealtAmount
required
number

The amount bought or sold in the dealt currency

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "rate": 1.35,
  • "valueDate": "2023-06-22",
  • "counterAmount": 1350,
  • "fixingDate": "2023-06-22",
  • "fixingReference": "BRL PTAX (BRBR) Sao Paulo 13:15",
  • "ndfSettlementCurrency": "USD",
  • "hedgeRate": 1.3,
  • "dealtAmount": 1000
}

Response samples

Content type
application/json
{
  • "counterpartyId": "e53f286e-a2df-499c-b1c4-70ab0cfa7a31",
  • "contactId": "4b90b24c-3fb3-4de7-ad6b-b9f50d36d415",
  • "bookId": "967888c6-b1ef-41ff-9fd8-30e651b9926f",
  • "ccyPair": "USDCAD",
  • "dealtCurrency": "USD",
  • "dealtAction": "Buy",
  • "tradeDate": "2023-06-21",
  • "fee": 10,
  • "feeCurrency": "USD",
  • "internalComment": "Take a look internal",
  • "clientComment": "Take a look client",
  • "hedgeCounterpartyId": "cac8f03c-37cf-4325-8cc5-3abf8c6ef1dc",
  • "orderId": "c16ac564-2f66-4fbe-8d3d-683c5fc38c2d",
  • "externalTradeId": "EXTERNAL_TRADE_ID",
  • "liquidityProvider": "Some LP",
  • "platformVenue": "Some Platform",
  • "rate": 1.35,
  • "valueDate": "2023-06-22",
  • "counterAmount": 1350,
  • "fixingDate": "2023-06-22",
  • "fixingReference": "BRL PTAX (BRBR) Sao Paulo 13:15",
  • "ndfSettlementCurrency": "USD",
  • "hedgeRate": 1.3,
  • "dealtAmount": 1000,
  • "id": "82e7047f-738b-4f48-9474-503de2939984",
  • "mtm": {
    },
  • "type": "FxNdf"
}

Cancel trade

Authorizations:
TradesOAuth2
path Parameters
id
required
string
Example: 780d9625-efaf-4717-9cca-627c13f90ce2

The code used to identify the trade

Responses

Response samples

Content type
application/json
{
  • "requestId": "29476b9a-c5bb-48a0-86e3-43b95de1e5b6",
  • "errors": [
    ]
}

Orders

Get order

Authorizations:
OrdersOAuth2
path Parameters
id
required
string
Example: 5802125b-b2ca-4730-9217-4ac2a3cf4123

The code used to identify the order

Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID as provided by Kooltra

currencyPair
required
string

The Currency Pair Name for the order

clientDealtCurrency
required
string

The Dealt Currency of the order

clientDealtAction
required
string (OrderAction)
Enum: "Buy" "Sell"

Buy: Client purchases the Dealt Currency from the Counterparty Sell: Client sells the Dealt Currency to the Counterparty

clientDealtAmount
required
number

The amount bought or sold in the dealt currency

clientOrderRate
required
number

The rate of the order left by the counterparty/client

expirationType
required
string (ExpirationType)
Enum: "GoodTillCancel" "GoodTillDate"

The expiration type of the order

expirationDate
string <date-time>

Expiration Date

allOrNone
required
boolean
Default: false

Whether the order is all-or-none True: Do not allow partial fills False: Partial fills are allowed

hedgeCounterpartyId
required
string <uuid>

The Counterparty ID of the Hedge provider in Kooltra

hedgeOrderRate
required
number

The rate of the order left by the house with the hedge counterparty

externalOrderId
string

External order reference as unique identifier

clientFillRate
number

The rate the counterparty/client was filled at

hedgeFillRate
number

The rate the house was filled at with the hedge

source
string

The source of the order

status
required
string (RequestOrderStatus)
Enum: "Placed" "Filled"

The current status of the order

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "ff3c1787-1d40-448e-b917-bab4e25ac74b",
  • "currencyPair": "USDCAD",
  • "clientDealtCurrency": "USD",
  • "clientDealtAction": "Buy",
  • "clientDealtAmount": 1000,
  • "clientOrderRate": 1.35,
  • "expirationType": "GoodTillCancel",
  • "expirationDate": "2024-04-05T17:32:28Z",
  • "allOrNone": false,
  • "hedgeCounterpartyId": "faf9dd89-7add-4e1f-8ec3-d751ebf4ab3b",
  • "hedgeOrderRate": 1.3,
  • "externalOrderId": "f47832ed-a50b-4dc8-8307-ec84621300fd",
  • "clientFillRate": 1.311,
  • "hedgeFillRate": 1.311,
  • "source": "Backoffice Trader",
  • "status": "Placed",
  • "type": "Limit"
}

Response samples

Content type
application/json
{
  • "counterpartyId": "ff3c1787-1d40-448e-b917-bab4e25ac74b",
  • "currencyPair": "USDCAD",
  • "clientDealtCurrency": "USD",
  • "clientDealtAction": "Buy",
  • "clientDealtAmount": 1000,
  • "clientOrderRate": 1.35,
  • "expirationType": "GoodTillCancel",
  • "expirationDate": "2024-04-05T17:32:28Z",
  • "allOrNone": false,
  • "hedgeCounterpartyId": "faf9dd89-7add-4e1f-8ec3-d751ebf4ab3b",
  • "hedgeOrderRate": 1.3,
  • "externalOrderId": "f47832ed-a50b-4dc8-8307-ec84621300fd",
  • "clientFillRate": 1.311,
  • "hedgeFillRate": 1.311,
  • "source": "Backoffice Trader",
  • "id": "8f7195cf-9a57-4a5d-a609-9c612b8fadaa",
  • "type": "Limit",
  • "status": "Placed"
}

Cancel order

Authorizations:
OrdersOAuth2
path Parameters
id
required
string
Example: 5802125b-b2ca-4730-9217-4ac2a3cf4123

The code used to identify the trade

Responses

Response samples

Content type
application/json
{
  • "requestId": "29476b9a-c5bb-48a0-86e3-43b95de1e5b6",
  • "errors": [
    ]
}

Create limit order

Authorizations:
OrdersOAuth2
Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID as provided by Kooltra

currencyPair
required
string

The Currency Pair Name for the order

clientDealtCurrency
required
string

The Dealt Currency of the order

clientDealtAction
required
string (OrderAction)
Enum: "Buy" "Sell"

Buy: Client purchases the Dealt Currency from the Counterparty Sell: Client sells the Dealt Currency to the Counterparty

clientDealtAmount
required
number

The amount bought or sold in the dealt currency

clientOrderRate
required
number

The rate of the order left by the counterparty/client

expirationType
required
string (ExpirationType)
Enum: "GoodTillCancel" "GoodTillDate"

The expiration type of the order

expirationDate
string <date-time>

Expiration Date

allOrNone
required
boolean
Default: false

Whether the order is all-or-none True: Do not allow partial fills False: Partial fills are allowed

hedgeCounterpartyId
required
string <uuid>

The Counterparty ID of the Hedge provider in Kooltra

hedgeOrderRate
required
number

The rate of the order left by the house with the hedge counterparty

externalOrderId
string

External order reference as unique identifier

clientFillRate
number

The rate the counterparty/client was filled at

hedgeFillRate
number

The rate the house was filled at with the hedge

source
string

The source of the order

status
required
string (RequestOrderStatus)
Enum: "Placed" "Filled"

The current status of the order

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "ff3c1787-1d40-448e-b917-bab4e25ac74b",
  • "currencyPair": "USDCAD",
  • "clientDealtCurrency": "USD",
  • "clientDealtAction": "Buy",
  • "clientDealtAmount": 1000,
  • "clientOrderRate": 1.35,
  • "expirationType": "GoodTillCancel",
  • "expirationDate": "2024-04-05T17:32:28Z",
  • "allOrNone": false,
  • "hedgeCounterpartyId": "faf9dd89-7add-4e1f-8ec3-d751ebf4ab3b",
  • "hedgeOrderRate": 1.3,
  • "externalOrderId": "f47832ed-a50b-4dc8-8307-ec84621300fd",
  • "clientFillRate": 1.311,
  • "hedgeFillRate": 1.311,
  • "source": "Backoffice Trader",
  • "status": "Placed"
}

Response samples

Content type
application/json
{
  • "counterpartyId": "ff3c1787-1d40-448e-b917-bab4e25ac74b",
  • "currencyPair": "USDCAD",
  • "clientDealtCurrency": "USD",
  • "clientDealtAction": "Buy",
  • "clientDealtAmount": 1000,
  • "clientOrderRate": 1.35,
  • "expirationType": "GoodTillCancel",
  • "expirationDate": "2024-04-05T17:32:28Z",
  • "allOrNone": false,
  • "hedgeCounterpartyId": "faf9dd89-7add-4e1f-8ec3-d751ebf4ab3b",
  • "hedgeOrderRate": 1.3,
  • "externalOrderId": "f47832ed-a50b-4dc8-8307-ec84621300fd",
  • "clientFillRate": 1.311,
  • "hedgeFillRate": 1.311,
  • "source": "Backoffice Trader",
  • "id": "8f7195cf-9a57-4a5d-a609-9c612b8fadaa",
  • "type": "Limit",
  • "status": "Placed"
}

Update limit order

Authorizations:
OrdersOAuth2
path Parameters
id
required
string
Example: 5802125b-b2ca-4730-9217-4ac2a3cf4123

The code used to identify the order

Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID as provided by Kooltra

currencyPair
required
string

The Currency Pair Name for the order

clientDealtCurrency
required
string

The Dealt Currency of the order

clientDealtAction
required
string (OrderAction)
Enum: "Buy" "Sell"

Buy: Client purchases the Dealt Currency from the Counterparty Sell: Client sells the Dealt Currency to the Counterparty

clientDealtAmount
required
number

The amount bought or sold in the dealt currency

clientOrderRate
required
number

The rate of the order left by the counterparty/client

expirationType
required
string (ExpirationType)
Enum: "GoodTillCancel" "GoodTillDate"

The expiration type of the order

expirationDate
string <date-time>

Expiration Date

allOrNone
required
boolean
Default: false

Whether the order is all-or-none True: Do not allow partial fills False: Partial fills are allowed

hedgeCounterpartyId
required
string <uuid>

The Counterparty ID of the Hedge provider in Kooltra

hedgeOrderRate
required
number

The rate of the order left by the house with the hedge counterparty

externalOrderId
string

External order reference as unique identifier

clientFillRate
number

The rate the counterparty/client was filled at

hedgeFillRate
number

The rate the house was filled at with the hedge

source
string

The source of the order

status
required
string (RequestOrderStatus)
Enum: "Placed" "Filled"

The current status of the order

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "ff3c1787-1d40-448e-b917-bab4e25ac74b",
  • "currencyPair": "USDCAD",
  • "clientDealtCurrency": "USD",
  • "clientDealtAction": "Buy",
  • "clientDealtAmount": 1000,
  • "clientOrderRate": 1.35,
  • "expirationType": "GoodTillCancel",
  • "expirationDate": "2024-04-05T17:32:28Z",
  • "allOrNone": false,
  • "hedgeCounterpartyId": "faf9dd89-7add-4e1f-8ec3-d751ebf4ab3b",
  • "hedgeOrderRate": 1.3,
  • "externalOrderId": "f47832ed-a50b-4dc8-8307-ec84621300fd",
  • "clientFillRate": 1.311,
  • "hedgeFillRate": 1.311,
  • "source": "Backoffice Trader",
  • "status": "Placed"
}

Response samples

Content type
application/json
{
  • "counterpartyId": "ff3c1787-1d40-448e-b917-bab4e25ac74b",
  • "currencyPair": "USDCAD",
  • "clientDealtCurrency": "USD",
  • "clientDealtAction": "Buy",
  • "clientDealtAmount": 1000,
  • "clientOrderRate": 1.35,
  • "expirationType": "GoodTillCancel",
  • "expirationDate": "2024-04-05T17:32:28Z",
  • "allOrNone": false,
  • "hedgeCounterpartyId": "faf9dd89-7add-4e1f-8ec3-d751ebf4ab3b",
  • "hedgeOrderRate": 1.3,
  • "externalOrderId": "f47832ed-a50b-4dc8-8307-ec84621300fd",
  • "clientFillRate": 1.311,
  • "hedgeFillRate": 1.311,
  • "source": "Backoffice Trader",
  • "id": "8f7195cf-9a57-4a5d-a609-9c612b8fadaa",
  • "type": "Limit",
  • "status": "Placed"
}

Beneficiaries

Create beneficiary

Authorizations:
BeneficiariesOAuth2
Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID of the beneficiary as provided by Kooltra

referenceName
required
string

The beneficiary name

currency
required
string

The currency of the beneficiary

isThirdParty
required
boolean

true: the beneficiary is a third-party false: the beneficiary is not a third-party

type
string (BeneficiaryType)
Enum: "Individual" "Company" "Corporation" "Trust" "Association" "GovernmentBody" "Partnership" "RegisteredBody"
legalName
string

The full legal name of the beneficiary if the beneficiary is not an Individual

firstName
string

The first name of the beneficiary if the beneficiary is an Individual

middleName
string

The middle name of the beneficiary if the beneficiary is an Individual

lastName
string

The last name of the beneficiary if the beneficiary is an Individual

required
object (Beneficiary Address)

address object

phoneNumber
string

The phone number of the beneficiary

primaryEmail
string <email>

The primary email for the beneficiary

settlementMethodsEnabled
required
Array of strings

List of settlement methods available for this beneficiary

status
required
string (BeneficiaryStatus)
Enum: "Draft" "PendingBackoffice" "Pending" "Active" "Suspended" "Inactive" "NostroInstructions"

The status of the beneficiary

externalBeneficiaryId
string

The external ID of the beneficiary

required
object (Bank)

The Bank object

object (IntermediaryBank)

The Intermediary Bank object

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "cb8917c4-d810-43d6-b01a-eb4aa0f97f4c",
  • "referenceName": "David Smith",
  • "currency": "CAD",
  • "isThirdParty": true,
  • "type": "Individual",
  • "legalName": "XYZ Beneficiary Company Ltd",
  • "firstName": "David",
  • "middleName": "John",
  • "lastName": "Smith",
  • "address": {
    },
  • "phoneNumber": "1-647-218-7730",
  • "primaryEmail": "general@abctech.com",
  • "settlementMethodsEnabled": [
    ],
  • "status": "Active",
  • "externalBeneficiaryId": "ABCD-1234-5678",
  • "bank": {
    },
  • "intermediaryBank": {
    }
}

Response samples

Content type
application/json
{
  • "counterpartyId": "cb8917c4-d810-43d6-b01a-eb4aa0f97f4c",
  • "referenceName": "David Smith",
  • "currency": "CAD",
  • "isThirdParty": true,
  • "type": "Individual",
  • "legalName": "XYZ Beneficiary Company Ltd",
  • "firstName": "David",
  • "middleName": "John",
  • "lastName": "Smith",
  • "address": {
    },
  • "phoneNumber": "1-647-218-7730",
  • "primaryEmail": "general@abctech.com",
  • "settlementMethodsEnabled": [
    ],
  • "status": "Active",
  • "externalBeneficiaryId": "ABCD-1234-5678",
  • "bank": {
    },
  • "intermediaryBank": {
    },
  • "id": "2fcb4fce-190c-4525-a5a7-7058fc263703"
}

Get beneficiary

Authorizations:
BeneficiariesOAuth2
path Parameters
id
required
string
Example: 1b2119d4-ac08-4766-8144-57d3f70873c9

The code used to identify the beneficiary

Responses

Response samples

Content type
application/json
{
  • "counterpartyId": "cb8917c4-d810-43d6-b01a-eb4aa0f97f4c",
  • "referenceName": "David Smith",
  • "currency": "CAD",
  • "isThirdParty": true,
  • "type": "Individual",
  • "legalName": "XYZ Beneficiary Company Ltd",
  • "firstName": "David",
  • "middleName": "John",
  • "lastName": "Smith",
  • "address": {
    },
  • "phoneNumber": "1-647-218-7730",
  • "primaryEmail": "general@abctech.com",
  • "settlementMethodsEnabled": [
    ],
  • "status": "Active",
  • "externalBeneficiaryId": "ABCD-1234-5678",
  • "bank": {
    },
  • "intermediaryBank": {
    },
  • "id": "2fcb4fce-190c-4525-a5a7-7058fc263703"
}

Update beneficiary

Authorizations:
BeneficiariesOAuth2
path Parameters
id
required
string
Example: 1b2119d4-ac08-4766-8144-57d3f70873c9

The code used to identify the beneficiary

Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID of the beneficiary as provided by Kooltra

referenceName
required
string

The beneficiary name

currency
required
string

The currency of the beneficiary

isThirdParty
required
boolean

true: the beneficiary is a third-party false: the beneficiary is not a third-party

type
string (BeneficiaryType)
Enum: "Individual" "Company" "Corporation" "Trust" "Association" "GovernmentBody" "Partnership" "RegisteredBody"
legalName
string

The full legal name of the beneficiary if the beneficiary is not an Individual

firstName
string

The first name of the beneficiary if the beneficiary is an Individual

middleName
string

The middle name of the beneficiary if the beneficiary is an Individual

lastName
string

The last name of the beneficiary if the beneficiary is an Individual

required
object (Beneficiary Address)

address object

phoneNumber
string

The phone number of the beneficiary

primaryEmail
string <email>

The primary email for the beneficiary

settlementMethodsEnabled
required
Array of strings

List of settlement methods available for this beneficiary

status
required
string (BeneficiaryStatus)
Enum: "Draft" "PendingBackoffice" "Pending" "Active" "Suspended" "Inactive" "NostroInstructions"

The status of the beneficiary

externalBeneficiaryId
string

The external ID of the beneficiary

required
object (Bank)

The Bank object

object (IntermediaryBank)

The Intermediary Bank object

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "cb8917c4-d810-43d6-b01a-eb4aa0f97f4c",
  • "referenceName": "David Smith",
  • "currency": "CAD",
  • "isThirdParty": true,
  • "type": "Individual",
  • "legalName": "XYZ Beneficiary Company Ltd",
  • "firstName": "David",
  • "middleName": "John",
  • "lastName": "Smith",
  • "address": {
    },
  • "phoneNumber": "1-647-218-7730",
  • "primaryEmail": "general@abctech.com",
  • "settlementMethodsEnabled": [
    ],
  • "status": "Active",
  • "externalBeneficiaryId": "ABCD-1234-5678",
  • "bank": {
    },
  • "intermediaryBank": {
    }
}

Response samples

Content type
application/json
{
  • "counterpartyId": "cb8917c4-d810-43d6-b01a-eb4aa0f97f4c",
  • "referenceName": "David Smith",
  • "currency": "CAD",
  • "isThirdParty": true,
  • "type": "Individual",
  • "legalName": "XYZ Beneficiary Company Ltd",
  • "firstName": "David",
  • "middleName": "John",
  • "lastName": "Smith",
  • "address": {
    },
  • "phoneNumber": "1-647-218-7730",
  • "primaryEmail": "general@abctech.com",
  • "settlementMethodsEnabled": [
    ],
  • "status": "Active",
  • "externalBeneficiaryId": "ABCD-1234-5678",
  • "bank": {
    },
  • "intermediaryBank": {
    },
  • "id": "2fcb4fce-190c-4525-a5a7-7058fc263703"
}

Cashflows

Get payment or adjustment

Authorizations:
CashflowsOAuth2
path Parameters
id
required
string
Example: 2e8d9074-4c80-4c7e-ab87-b89c064f3861

The code used to identify the cashflow

Responses

Response samples

Content type
application/json
Example
{
  • "counterpartyId": "e9c09648-c8c5-46bb-ab15-676631d98345",
  • "currency": "USD",
  • "bankAmount": 1000,
  • "bankIntermediaryFee": 1000,
  • "counterpartyCharge": 1000,
  • "counterpartyAmount": 1000,
  • "contactId": "26088bcf-467f-439e-8822-e735b8ae53f7",
  • "beneficiarySourceId": "7b4843b5-1e11-4cd3-8974-c3626aa6cd84",
  • "settlementMethod": "Wire",
  • "nostroAccountId": "a4ea70ab-0fbd-4b6f-8d26-2fc3b917a070",
  • "settlementFee": 1000,
  • "settlementFeeCurrency": "USD",
  • "purposeOfPayment": "Payments to Suppliers",
  • "subType": null,
  • "internalComment": "Take a look internal",
  • "externalComment": "Take a look client",
  • "recipientComment": "Take a look beneficiary",
  • "valueDate": "2023-06-21",
  • "externalCashflowId": "MY_EXTERNAL_ID",
  • "tradeId": "e7957754-e898-4cb2-a9a7-3e12fdd1495e",
  • "id": "c491afda-e916-471f-acbd-de7319c798e1",
  • "type": "WireIn",
  • "status": "Cancelled"
}

Create payment

Authorizations:
CashflowsOAuth2
Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID of the Client as provided by Kooltra

currency
required
string

Provide the currency of cashflow

bankAmount
required
number

The amount to be deposited/withdrawn from the associated nostro/bank account

bankIntermediaryFee
number

The intermediary fee charged by the bank

counterpartyCharge
number

The amount of bank intermediary fee passed on to the client/counterparty

counterpartyAmount
number

The amount to be deposited/withdrawn from the counterparty's vostro account

contactId
string <uuid>

The Contact ID as provided by Kooltra

beneficiarySourceId
string <uuid>

The Beneficiary/Source ID as provided by Kooltra

settlementMethod
required
string

List of defined settlement methods in Kooltra

nostroAccountId
required
string <uuid>

The Nostro Account ID as provided by Kooltra

settlementFee
number

Additional fee amount for the transaction

settlementFeeCurrency
string

The currency of the settlement fee

purposeOfPayment
string

The reason for the payment

subType
string

Additional information regarding the cashflow transaction

internalComment
string

Comment that is only visible to internal team members when viewing the trade in Kooltra

externalComment
string

Comment that will be visible to internal team members and clients when viewing the trade in Kooltra

recipientComment
string

Comments to be sent to the beneficiary with a beneficiary confirmation

valueDate
required
string <date>

The date the cashflow will be settled/valued on

externalCashflowId
string

Add a unique external ID for future reference

tradeId
string <uuid>

Used to link cashflows to trades for visibility in Kooltra

processCashflow
required
string (ProcessWireCashflowEnum)
Enum: "Immediate" "OnValueDate" "Pending" "Open"

Provide one of the following processing options for the cashflow:

  1. Immediate: the cashflow will be created and processed/closed (i.e, settled) immediately
  2. OnValueDate: the cashflow will be pre-processed and closed (i.e., settled) on the value date
  3. Pending: the cashflow will not be automatically processed/closed and is directly linked to a trade settlement.
  4. Open: the cashflow will not be automatically processed/closed and is not directly linked to a trade settlement.
type
required
string

Type of cashflow. For possible values please see WireType schema

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "e9c09648-c8c5-46bb-ab15-676631d98345",
  • "currency": "USD",
  • "bankAmount": 1000,
  • "bankIntermediaryFee": 1000,
  • "counterpartyCharge": 1000,
  • "counterpartyAmount": 1000,
  • "contactId": "26088bcf-467f-439e-8822-e735b8ae53f7",
  • "beneficiarySourceId": "7b4843b5-1e11-4cd3-8974-c3626aa6cd84",
  • "settlementMethod": "Wire",
  • "nostroAccountId": "a4ea70ab-0fbd-4b6f-8d26-2fc3b917a070",
  • "settlementFee": 1000,
  • "settlementFeeCurrency": "USD",
  • "purposeOfPayment": "Payments to Suppliers",
  • "subType": null,
  • "internalComment": "Take a look internal",
  • "externalComment": "Take a look client",
  • "recipientComment": "Take a look beneficiary",
  • "valueDate": "2023-06-21",
  • "externalCashflowId": "MY_EXTERNAL_ID",
  • "tradeId": "e7957754-e898-4cb2-a9a7-3e12fdd1495e",
  • "processCashflow": "Pending",
  • "type": "WireIn"
}

Response samples

Content type
application/json
{
  • "counterpartyId": "e9c09648-c8c5-46bb-ab15-676631d98345",
  • "currency": "USD",
  • "bankAmount": 1000,
  • "bankIntermediaryFee": 1000,
  • "counterpartyCharge": 1000,
  • "counterpartyAmount": 1000,
  • "contactId": "26088bcf-467f-439e-8822-e735b8ae53f7",
  • "beneficiarySourceId": "7b4843b5-1e11-4cd3-8974-c3626aa6cd84",
  • "settlementMethod": "Wire",
  • "nostroAccountId": "a4ea70ab-0fbd-4b6f-8d26-2fc3b917a070",
  • "settlementFee": 1000,
  • "settlementFeeCurrency": "USD",
  • "purposeOfPayment": "Payments to Suppliers",
  • "subType": null,
  • "internalComment": "Take a look internal",
  • "externalComment": "Take a look client",
  • "recipientComment": "Take a look beneficiary",
  • "valueDate": "2023-06-21",
  • "externalCashflowId": "MY_EXTERNAL_ID",
  • "tradeId": "e7957754-e898-4cb2-a9a7-3e12fdd1495e",
  • "id": "c491afda-e916-471f-acbd-de7319c798e1",
  • "type": "WireIn",
  • "status": "Cancelled"
}

Update payment

Authorizations:
CashflowsOAuth2
path Parameters
id
required
string
Example: 2e8d9074-4c80-4c7e-ab87-b89c064f3861

The code used to identify the cashflow

Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID of the Client as provided by Kooltra

currency
required
string

Provide the currency of cashflow

bankAmount
required
number

The amount to be deposited/withdrawn from the associated nostro/bank account

bankIntermediaryFee
number

The intermediary fee charged by the bank

counterpartyCharge
number

The amount of bank intermediary fee passed on to the client/counterparty

counterpartyAmount
number

The amount to be deposited/withdrawn from the counterparty's vostro account

contactId
string <uuid>

The Contact ID as provided by Kooltra

beneficiarySourceId
string <uuid>

The Beneficiary/Source ID as provided by Kooltra

settlementMethod
required
string

List of defined settlement methods in Kooltra

nostroAccountId
required
string <uuid>

The Nostro Account ID as provided by Kooltra

settlementFee
number

Additional fee amount for the transaction

settlementFeeCurrency
string

The currency of the settlement fee

purposeOfPayment
string

The reason for the payment

subType
string

Additional information regarding the cashflow transaction

internalComment
string

Comment that is only visible to internal team members when viewing the trade in Kooltra

externalComment
string

Comment that will be visible to internal team members and clients when viewing the trade in Kooltra

recipientComment
string

Comments to be sent to the beneficiary with a beneficiary confirmation

valueDate
required
string <date>

The date the cashflow will be settled/valued on

externalCashflowId
string

Add a unique external ID for future reference

tradeId
string <uuid>

Used to link cashflows to trades for visibility in Kooltra

processCashflow
required
string (ProcessWireCashflowEnum)
Enum: "Immediate" "OnValueDate" "Pending" "Open"

Provide one of the following processing options for the cashflow:

  1. Immediate: the cashflow will be created and processed/closed (i.e, settled) immediately
  2. OnValueDate: the cashflow will be pre-processed and closed (i.e., settled) on the value date
  3. Pending: the cashflow will not be automatically processed/closed and is directly linked to a trade settlement.
  4. Open: the cashflow will not be automatically processed/closed and is not directly linked to a trade settlement.
type
required
string

Type of cashflow. For possible values please see WireType schema

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "e9c09648-c8c5-46bb-ab15-676631d98345",
  • "currency": "USD",
  • "bankAmount": 1000,
  • "bankIntermediaryFee": 1000,
  • "counterpartyCharge": 1000,
  • "counterpartyAmount": 1000,
  • "contactId": "26088bcf-467f-439e-8822-e735b8ae53f7",
  • "beneficiarySourceId": "7b4843b5-1e11-4cd3-8974-c3626aa6cd84",
  • "settlementMethod": "Wire",
  • "nostroAccountId": "a4ea70ab-0fbd-4b6f-8d26-2fc3b917a070",
  • "settlementFee": 1000,
  • "settlementFeeCurrency": "USD",
  • "purposeOfPayment": "Payments to Suppliers",
  • "subType": null,
  • "internalComment": "Take a look internal",
  • "externalComment": "Take a look client",
  • "recipientComment": "Take a look beneficiary",
  • "valueDate": "2023-06-21",
  • "externalCashflowId": "MY_EXTERNAL_ID",
  • "tradeId": "e7957754-e898-4cb2-a9a7-3e12fdd1495e",
  • "processCashflow": "Pending",
  • "type": "WireIn"
}

Response samples

Content type
application/json
{
  • "counterpartyId": "e9c09648-c8c5-46bb-ab15-676631d98345",
  • "currency": "USD",
  • "bankAmount": 1000,
  • "bankIntermediaryFee": 1000,
  • "counterpartyCharge": 1000,
  • "counterpartyAmount": 1000,
  • "contactId": "26088bcf-467f-439e-8822-e735b8ae53f7",
  • "beneficiarySourceId": "7b4843b5-1e11-4cd3-8974-c3626aa6cd84",
  • "settlementMethod": "Wire",
  • "nostroAccountId": "a4ea70ab-0fbd-4b6f-8d26-2fc3b917a070",
  • "settlementFee": 1000,
  • "settlementFeeCurrency": "USD",
  • "purposeOfPayment": "Payments to Suppliers",
  • "subType": null,
  • "internalComment": "Take a look internal",
  • "externalComment": "Take a look client",
  • "recipientComment": "Take a look beneficiary",
  • "valueDate": "2023-06-21",
  • "externalCashflowId": "MY_EXTERNAL_ID",
  • "tradeId": "e7957754-e898-4cb2-a9a7-3e12fdd1495e",
  • "id": "c491afda-e916-471f-acbd-de7319c798e1",
  • "type": "WireIn",
  • "status": "Cancelled"
}

Create vostro adjustment

Authorizations:
CashflowsOAuth2
Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID of the Client as provided by Kooltra

currency
required
string

The currency of the cashflow

counterpartyAmount
required
number

The amount to be credited/debited from the counterparty's vostro account

contactId
string <uuid>

The Contact ID as provided by Kooltra

subType
string

Additional information regarding the cashflow transaction

internalComment
string

Comment that is only visible to internal team members when viewing the trade in Kooltra

externalComment
string

Comment that will be visible to internal team members and clients when viewing the trade in Kooltra

valueDate
required
string <date>

The date the cashflow will be settled/valued on

externalCashflowId
string

Add a unique external ID for future reference

processCashflow
required
string (ProcessVostroCashflowEnum)
Enum: "Immediate" "OnValueDate" "Open"

Provide one of the following processing options for the cashflow:

  1. Immediate: the cashflow will be created and processed/closed (i.e, settled) immediately
  2. OnValueDate: the cashflow will be pre-processed and closed (i.e., settled) on the value date
  3. Open: the cashflow will not automatically processed/closed
type
required
string

Type of cashflow. For possible values please see VostroType schema

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "3ba6ea78-b836-47ce-ba16-dd8b1f26224a",
  • "currency": "USD",
  • "counterpartyAmount": 1000,
  • "contactId": "b866986c-ce58-4d89-a233-3d741f8638ed",
  • "subType": null,
  • "internalComment": "Take a look internal",
  • "externalComment": "Take a look client",
  • "valueDate": "2023-06-21",
  • "externalCashflowId": "f2679cf3-b145-481c-a21a-619e41c2efa2",
  • "processCashflow": "Immediate",
  • "type": "VostroDebit"
}

Response samples

Content type
application/json
{
  • "counterpartyId": "3ba6ea78-b836-47ce-ba16-dd8b1f26224a",
  • "currency": "USD",
  • "counterpartyAmount": 1000,
  • "contactId": "b866986c-ce58-4d89-a233-3d741f8638ed",
  • "subType": null,
  • "internalComment": "Take a look internal",
  • "externalComment": "Take a look client",
  • "valueDate": "2023-06-21",
  • "externalCashflowId": "f2679cf3-b145-481c-a21a-619e41c2efa2",
  • "id": "c6737790-a387-41b6-b13a-c31ead0ad8ff",
  • "type": "VostroDebit",
  • "status": "Cancelled"
}

Update vostro adjustment

Authorizations:
CashflowsOAuth2
path Parameters
id
required
string
Example: 4eafc554-ef5f-4e66-8583-91d1a3de94e5

The code used to identify the cashflow

Request Body schema: application/json
required
counterpartyId
required
string <uuid>

The Counterparty ID of the Client as provided by Kooltra

currency
required
string

The currency of the cashflow

counterpartyAmount
required
number

The amount to be credited/debited from the counterparty's vostro account

contactId
string <uuid>

The Contact ID as provided by Kooltra

subType
string

Additional information regarding the cashflow transaction

internalComment
string

Comment that is only visible to internal team members when viewing the trade in Kooltra

externalComment
string

Comment that will be visible to internal team members and clients when viewing the trade in Kooltra

valueDate
required
string <date>

The date the cashflow will be settled/valued on

externalCashflowId
string

Add a unique external ID for future reference

processCashflow
required
string (ProcessVostroCashflowEnum)
Enum: "Immediate" "OnValueDate" "Open"

Provide one of the following processing options for the cashflow:

  1. Immediate: the cashflow will be created and processed/closed (i.e, settled) immediately
  2. OnValueDate: the cashflow will be pre-processed and closed (i.e., settled) on the value date
  3. Open: the cashflow will not automatically processed/closed
type
required
string

Type of cashflow. For possible values please see VostroType schema

Responses

Request samples

Content type
application/json
{
  • "counterpartyId": "3ba6ea78-b836-47ce-ba16-dd8b1f26224a",
  • "currency": "USD",
  • "counterpartyAmount": 1000,
  • "contactId": "b866986c-ce58-4d89-a233-3d741f8638ed",
  • "subType": null,
  • "internalComment": "Take a look internal",
  • "externalComment": "Take a look client",
  • "valueDate": "2023-06-21",
  • "externalCashflowId": "f2679cf3-b145-481c-a21a-619e41c2efa2",
  • "processCashflow": "Immediate",
  • "type": "VostroDebit"
}

Response samples

Content type
application/json
{
  • "counterpartyId": "3ba6ea78-b836-47ce-ba16-dd8b1f26224a",
  • "currency": "USD",
  • "counterpartyAmount": 1000,
  • "contactId": "b866986c-ce58-4d89-a233-3d741f8638ed",
  • "subType": null,
  • "internalComment": "Take a look internal",
  • "externalComment": "Take a look client",
  • "valueDate": "2023-06-21",
  • "externalCashflowId": "f2679cf3-b145-481c-a21a-619e41c2efa2",
  • "id": "c6737790-a387-41b6-b13a-c31ead0ad8ff",
  • "type": "VostroDebit",
  • "status": "Cancelled"
}

Create nostro adjustment

Authorizations:
CashflowsOAuth2
Request Body schema: application/json
required
nostroId
required
string <uuid>

The Nostro ID of the Client as provided by Kooltra

currency
required
string

The currency of the cashflow

amount
required
number

The amount to be credited/debited from the counterparty's vostro account

subType
string

Additional information regarding the cashflow transaction

internalComment
string

Comment that is only visible to internal team members when viewing the trade in Kooltra

valueDate
required
string <date>

The date the cashflow will be settled/valued on

externalCashflowId
string

Add a unique external ID for future reference

processCashflow
required
string (ProcessNostroCashflowEnum)
Enum: "Immediate" "OnValueDate" "Open"

Provide one of the following processing options for the cashflow:

  1. Immediate: the cashflow will be created and processed/closed (i.e, settled) immediately
  2. OnValueDate: the cashflow will be pre-processed and closed (i.e., settled) on the value date
  3. Open: the cashflow will not automatically processed/closed
type
required
string

Type of cashflow. For possible values please see NostroType schema

Responses

Request samples

Content type
application/json
{
  • "nostroId": "c1a4485e-ba46-4f37-8d8b-bb815a4a68ae",
  • "currency": "USD",
  • "amount": 1000,
  • "subType": null,
  • "internalComment": "Take a look internal",
  • "valueDate": "2023-06-21",
  • "externalCashflowId": "86103c0a-c8f9-4138-a9ef-d8c76fe8c9c8",
  • "processCashflow": "Immediate",
  • "type": "NostroDebit"
}

Response samples

Content type
application/json
{
  • "nostroId": "c1a4485e-ba46-4f37-8d8b-bb815a4a68ae",
  • "currency": "USD",
  • "amount": 1000,
  • "subType": null,
  • "internalComment": "Take a look internal",
  • "valueDate": "2023-06-21",
  • "externalCashflowId": "86103c0a-c8f9-4138-a9ef-d8c76fe8c9c8",
  • "id": "c9d0aa0c-9e8d-4642-8638-6e4d67eaec3c",
  • "type": "NostroDebit",
  • "status": "Cancelled"
}

Update nostro adjustment

Authorizations:
CashflowsOAuth2
path Parameters
id
required
string
Example: 059e28eb-e297-4406-bd9c-fad27d7d036b

The code used to identify the cashflow

Request Body schema: application/json
required
nostroId
required
string <uuid>

The Nostro ID of the Client as provided by Kooltra

currency
required
string

The currency of the cashflow

amount
required
number

The amount to be credited/debited from the counterparty's vostro account

subType
string

Additional information regarding the cashflow transaction

internalComment
string

Comment that is only visible to internal team members when viewing the trade in Kooltra

valueDate
required
string <date>

The date the cashflow will be settled/valued on

externalCashflowId
string

Add a unique external ID for future reference

processCashflow
required
string (ProcessNostroCashflowEnum)
Enum: "Immediate" "OnValueDate" "Open"

Provide one of the following processing options for the cashflow:

  1. Immediate: the cashflow will be created and processed/closed (i.e, settled) immediately
  2. OnValueDate: the cashflow will be pre-processed and closed (i.e., settled) on the value date
  3. Open: the cashflow will not automatically processed/closed
type
required
string

Type of cashflow. For possible values please see NostroType schema

Responses

Request samples

Content type
application/json
{
  • "nostroId": "c1a4485e-ba46-4f37-8d8b-bb815a4a68ae",
  • "currency": "USD",
  • "amount": 1000,
  • "subType": null,
  • "internalComment": "Take a look internal",
  • "valueDate": "2023-06-21",
  • "externalCashflowId": "86103c0a-c8f9-4138-a9ef-d8c76fe8c9c8",
  • "processCashflow": "Immediate",
  • "type": "NostroDebit"
}

Response samples

Content type
application/json
{
  • "nostroId": "c1a4485e-ba46-4f37-8d8b-bb815a4a68ae",
  • "currency": "USD",
  • "amount": 1000,
  • "subType": null,
  • "internalComment": "Take a look internal",
  • "valueDate": "2023-06-21",
  • "externalCashflowId": "86103c0a-c8f9-4138-a9ef-d8c76fe8c9c8",
  • "id": "c9d0aa0c-9e8d-4642-8638-6e4d67eaec3c",
  • "type": "NostroDebit",
  • "status": "Cancelled"
}

Cancel payment or adjustment

Authorizations:
CashflowsOAuth2
path Parameters
id
required
string
Example: 6b2c0bba-e6e5-487c-80b1-0966d7869176

The code used to identify the cashflow

Responses

Response samples

Content type
application/json
{
  • "requestId": "29476b9a-c5bb-48a0-86e3-43b95de1e5b6",
  • "errors": [
    ]
}