Forward Deals

Search forward deals

post/forward-deals/account/{AccountIdentifier}/action/search

Request

Base URL
https://sandbox.preprod.connect.xpansiv.com/app/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/docs/forward-deals/account/:AccountIdentifier/action/search/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

AccountIdentifierstring required

Account identifier

Query parameters

pageinteger

sizeinteger

includestring

Comma-separated values from optional response fields

Request body

programsRefProgram[]

lastUpdatedDateFromstring date-time

lastUpdatedDateTostring date-time

counterpartyNamestring

If this search parameter is passed as ““ then deals with no counterparty identifier specified will be returned.

dealNamestring

Response

List of forward deals

pageinteger required

sizeinteger required

totalPagesinteger required

totalElementsinteger required

Example response

{
  "content": [
    {
      "brokerDetails": {
        "fee": {
          "currency": "USD"
        }
      },
      "forwardTransactions": [
        {
          "contractedDetails": {
            "unitPrice": {
              "currency": "USD"
            },
            "value": {
              "currency": "USD"
            }
          },
          "deliveredDetails": {
            "unitPrice": {
              "currency": "USD"
            },
            "value": {
              "currency": "USD"
            }
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.