POST api/Deals

No documentation available.

Request Information

Parameters

Name	Description	Additional information
model	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "DealHeaderID": 1,
  "RateQuoteID": "sample string 2",
  "ValueDate": "sample string 3",
  "BuyCurrency": "sample string 4",
  "BuyAmount": 5.0,
  "SellCurrency": "sample string 6",
  "SellAmount": 7.0,
  "CustomerRate": 8.0,
  "IncomingWire": 9,
  "Disbursements": [
    {
      "BeneficiaryPaymentID": 1,
      "Instrument": "sample string 2",
      "BeneficiaryID": 3,
      "BeneficiaryBankAccountID": 4,
      "ValueDate": "2026-01-31T07:14:39.7058541+00:00",
      "SellAmount": 6.0,
      "PaymentReference": "sample string 7",
      "WireItemFee": 8.0,
      "WireItemFeeCurrencyID": "sample string 9",
      "InterfaceBalanceAccountId": "sample string 10",
      "Comments": "sample string 11",
      "Attachments": [
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        }
      ],
      "DeliveryMethod": "sample string 12"
    },
    {
      "BeneficiaryPaymentID": 1,
      "Instrument": "sample string 2",
      "BeneficiaryID": 3,
      "BeneficiaryBankAccountID": 4,
      "ValueDate": "2026-01-31T07:14:39.7058541+00:00",
      "SellAmount": 6.0,
      "PaymentReference": "sample string 7",
      "WireItemFee": 8.0,
      "WireItemFeeCurrencyID": "sample string 9",
      "InterfaceBalanceAccountId": "sample string 10",
      "Comments": "sample string 11",
      "Attachments": [
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        }
      ],
      "DeliveryMethod": "sample string 12"
    },
    {
      "BeneficiaryPaymentID": 1,
      "Instrument": "sample string 2",
      "BeneficiaryID": 3,
      "BeneficiaryBankAccountID": 4,
      "ValueDate": "2026-01-31T07:14:39.7058541+00:00",
      "SellAmount": 6.0,
      "PaymentReference": "sample string 7",
      "WireItemFee": 8.0,
      "WireItemFeeCurrencyID": "sample string 9",
      "InterfaceBalanceAccountId": "sample string 10",
      "Comments": "sample string 11",
      "Attachments": [
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        }
      ],
      "DeliveryMethod": "sample string 12"
    }
  ],
  "LockedSide": "sample string 10",
  "Settlements": [
    {
      "IncomingPaymentID": 1,
      "Amount": 2.0,
      "CurrencyID": "sample string 3",
      "DealHeaderID": 4,
      "Instrument": "sample string 5",
      "CustomerBankAccountID": 6,
      "Status": "sample string 7",
      "UpdateToken": "sample string 8",
      "DeliveryMethod": "sample string 9"
    },
    {
      "IncomingPaymentID": 1,
      "Amount": 2.0,
      "CurrencyID": "sample string 3",
      "DealHeaderID": 4,
      "Instrument": "sample string 5",
      "CustomerBankAccountID": 6,
      "Status": "sample string 7",
      "UpdateToken": "sample string 8",
      "DeliveryMethod": "sample string 9"
    },
    {
      "IncomingPaymentID": 1,
      "Amount": 2.0,
      "CurrencyID": "sample string 3",
      "DealHeaderID": 4,
      "Instrument": "sample string 5",
      "CustomerBankAccountID": 6,
      "Status": "sample string 7",
      "UpdateToken": "sample string 8",
      "DeliveryMethod": "sample string 9"
    }
  ],
  "ExternalMessage": "sample string 11",
  "Status": "sample string 12"
}

application/xml, text/xml

Sample:

<SaveSpotRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/e2eMobileAPI.Models.Requests">
  <BuyAmount>5</BuyAmount>
  <BuyCurrency>sample string 4</BuyCurrency>
  <CustomerRate>8</CustomerRate>
  <DealHeaderID>1</DealHeaderID>
  <Disbursements xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessEntities">
    <d2p1:Disbursement>
      <d2p1:_x003C_Attachments_x003E_k__BackingField>
        <d2p1:Attachment>
          <d2p1:Data>sample string 3</d2p1:Data>
          <d2p1:Description>sample string 2</d2p1:Description>
          <d2p1:Name>sample string 1</d2p1:Name>
        </d2p1:Attachment>
        <d2p1:Attachment>
          <d2p1:Data>sample string 3</d2p1:Data>
          <d2p1:Description>sample string 2</d2p1:Description>
          <d2p1:Name>sample string 1</d2p1:Name>
        </d2p1:Attachment>
        <d2p1:Attachment>
          <d2p1:Data>sample string 3</d2p1:Data>
          <d2p1:Description>sample string 2</d2p1:Description>
          <d2p1:Name>sample string 1</d2p1:Name>
        </d2p1:Attachment>
      </d2p1:_x003C_Attachments_x003E_k__BackingField>
      <d2p1:_x003C_BeneficiaryBankAccountID_x003E_k__BackingField>4</d2p1:_x003C_BeneficiaryBankAccountID_x003E_k__BackingField>
      <d2p1:_x003C_BeneficiaryID_x003E_k__BackingField>3</d2p1:_x003C_BeneficiaryID_x003E_k__BackingField>
      <d2p1:_x003C_BeneficiaryPaymentID_x003E_k__BackingField>1</d2p1:_x003C_BeneficiaryPaymentID_x003E_k__BackingField>
      <d2p1:_x003C_Comments_x003E_k__BackingField>sample string 11</d2p1:_x003C_Comments_x003E_k__BackingField>
      <d2p1:_x003C_DeliveryMethod_x003E_k__BackingField>sample string 12</d2p1:_x003C_DeliveryMethod_x003E_k__BackingField>
      <d2p1:_x003C_Instrument_x003E_k__BackingField>sample string 2</d2p1:_x003C_Instrument_x003E_k__BackingField>
      <d2p1:_x003C_InterfaceBalanceAccountId_x003E_k__BackingField>sample string 10</d2p1:_x003C_InterfaceBalanceAccountId_x003E_k__BackingField>
      <d2p1:_x003C_PaymentReference_x003E_k__BackingField>sample string 7</d2p1:_x003C_PaymentReference_x003E_k__BackingField>
      <d2p1:_x003C_SellAmount_x003E_k__BackingField>6</d2p1:_x003C_SellAmount_x003E_k__BackingField>
      <d2p1:_x003C_ValueDate_x003E_k__BackingField>2026-01-31T07:14:39.7058541+00:00</d2p1:_x003C_ValueDate_x003E_k__BackingField>
      <d2p1:_x003C_WireItemFeeCurrencyID_x003E_k__BackingField>sample string 9</d2p1:_x003C_WireItemFeeCurrencyID_x003E_k__BackingField>
      <d2p1:_x003C_WireItemFee_x003E_k__BackingField>8</d2p1:_x003C_WireItemFee_x003E_k__BackingField>
    </d2p1:Disbursement>
    <d2p1:Disbursement>
      <d2p1:_x003C_Attachments_x003E_k__BackingField>
        <d2p1:Attachment>
          <d2p1:Data>sample string 3</d2p1:Data>
          <d2p1:Description>sample string 2</d2p1:Description>
          <d2p1:Name>sample string 1</d2p1:Name>
        </d2p1:Attachment>
        <d2p1:Attachment>
          <d2p1:Data>sample string 3</d2p1:Data>
          <d2p1:Description>sample string 2</d2p1:Description>
          <d2p1:Name>sample string 1</d2p1:Name>
        </d2p1:Attachment>
        <d2p1:Attachment>
          <d2p1:Data>sample string 3</d2p1:Data>
          <d2p1:Description>sample string 2</d2p1:Description>
          <d2p1:Name>sample string 1</d2p1:Name>
        </d2p1:Attachment>
      </d2p1:_x003C_Attachments_x003E_k__BackingField>
      <d2p1:_x003C_BeneficiaryBankAccountID_x003E_k__BackingField>4</d2p1:_x003C_BeneficiaryBankAccountID_x003E_k__BackingField>
      <d2p1:_x003C_BeneficiaryID_x003E_k__BackingField>3</d2p1:_x003C_BeneficiaryID_x003E_k__BackingField>
      <d2p1:_x003C_BeneficiaryPaymentID_x003E_k__BackingField>1</d2p1:_x003C_BeneficiaryPaymentID_x003E_k__BackingField>
      <d2p1:_x003C_Comments_x003E_k__BackingField>sample string 11</d2p1:_x003C_Comments_x003E_k__BackingField>
      <d2p1:_x003C_DeliveryMethod_x003E_k__BackingField>sample string 12</d2p1:_x003C_DeliveryMethod_x003E_k__BackingField>
      <d2p1:_x003C_Instrument_x003E_k__BackingField>sample string 2</d2p1:_x003C_Instrument_x003E_k__BackingField>
      <d2p1:_x003C_InterfaceBalanceAccountId_x003E_k__BackingField>sample string 10</d2p1:_x003C_InterfaceBalanceAccountId_x003E_k__BackingField>
      <d2p1:_x003C_PaymentReference_x003E_k__BackingField>sample string 7</d2p1:_x003C_PaymentReference_x003E_k__BackingField>
      <d2p1:_x003C_SellAmount_x003E_k__BackingField>6</d2p1:_x003C_SellAmount_x003E_k__BackingField>
      <d2p1:_x003C_ValueDate_x003E_k__BackingField>2026-01-31T07:14:39.7058541+00:00</d2p1:_x003C_ValueDate_x003E_k__BackingField>
      <d2p1:_x003C_WireItemFeeCurrencyID_x003E_k__BackingField>sample string 9</d2p1:_x003C_WireItemFeeCurrencyID_x003E_k__BackingField>
      <d2p1:_x003C_WireItemFee_x003E_k__BackingField>8</d2p1:_x003C_WireItemFee_x003E_k__BackingField>
    </d2p1:Disbursement>
    <d2p1:Disbursement>
      <d2p1:_x003C_Attachments_x003E_k__BackingField>
        <d2p1:Attachment>
          <d2p1:Data>sample string 3</d2p1:Data>
          <d2p1:Description>sample string 2</d2p1:Description>
          <d2p1:Name>sample string 1</d2p1:Name>
        </d2p1:Attachment>
        <d2p1:Attachment>
          <d2p1:Data>sample string 3</d2p1:Data>
          <d2p1:Description>sample string 2</d2p1:Description>
          <d2p1:Name>sample string 1</d2p1:Name>
        </d2p1:Attachment>
        <d2p1:Attachment>
          <d2p1:Data>sample string 3</d2p1:Data>
          <d2p1:Description>sample string 2</d2p1:Description>
          <d2p1:Name>sample string 1</d2p1:Name>
        </d2p1:Attachment>
      </d2p1:_x003C_Attachments_x003E_k__BackingField>
      <d2p1:_x003C_BeneficiaryBankAccountID_x003E_k__BackingField>4</d2p1:_x003C_BeneficiaryBankAccountID_x003E_k__BackingField>
      <d2p1:_x003C_BeneficiaryID_x003E_k__BackingField>3</d2p1:_x003C_BeneficiaryID_x003E_k__BackingField>
      <d2p1:_x003C_BeneficiaryPaymentID_x003E_k__BackingField>1</d2p1:_x003C_BeneficiaryPaymentID_x003E_k__BackingField>
      <d2p1:_x003C_Comments_x003E_k__BackingField>sample string 11</d2p1:_x003C_Comments_x003E_k__BackingField>
      <d2p1:_x003C_DeliveryMethod_x003E_k__BackingField>sample string 12</d2p1:_x003C_DeliveryMethod_x003E_k__BackingField>
      <d2p1:_x003C_Instrument_x003E_k__BackingField>sample string 2</d2p1:_x003C_Instrument_x003E_k__BackingField>
      <d2p1:_x003C_InterfaceBalanceAccountId_x003E_k__BackingField>sample string 10</d2p1:_x003C_InterfaceBalanceAccountId_x003E_k__BackingField>
      <d2p1:_x003C_PaymentReference_x003E_k__BackingField>sample string 7</d2p1:_x003C_PaymentReference_x003E_k__BackingField>
      <d2p1:_x003C_SellAmount_x003E_k__BackingField>6</d2p1:_x003C_SellAmount_x003E_k__BackingField>
      <d2p1:_x003C_ValueDate_x003E_k__BackingField>2026-01-31T07:14:39.7058541+00:00</d2p1:_x003C_ValueDate_x003E_k__BackingField>
      <d2p1:_x003C_WireItemFeeCurrencyID_x003E_k__BackingField>sample string 9</d2p1:_x003C_WireItemFeeCurrencyID_x003E_k__BackingField>
      <d2p1:_x003C_WireItemFee_x003E_k__BackingField>8</d2p1:_x003C_WireItemFee_x003E_k__BackingField>
    </d2p1:Disbursement>
  </Disbursements>
  <ExternalMessage>sample string 11</ExternalMessage>
  <IncomingWire>9</IncomingWire>
  <LockedSide>sample string 10</LockedSide>
  <RateQuoteID>sample string 2</RateQuoteID>
  <SellAmount>7</SellAmount>
  <SellCurrency>sample string 6</SellCurrency>
  <Settlements xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessEntities">
    <d2p1:IncomingPayment>
      <d2p1:Amount>2</d2p1:Amount>
      <d2p1:CurrencyID>sample string 3</d2p1:CurrencyID>
      <d2p1:CustomerBankAccountID>6</d2p1:CustomerBankAccountID>
      <d2p1:DealHeaderID>4</d2p1:DealHeaderID>
      <d2p1:DeliveryMethod>sample string 9</d2p1:DeliveryMethod>
      <d2p1:IncomingPaymentID>1</d2p1:IncomingPaymentID>
      <d2p1:Instrument>sample string 5</d2p1:Instrument>
      <d2p1:Status>sample string 7</d2p1:Status>
      <d2p1:UpdateToken>sample string 8</d2p1:UpdateToken>
    </d2p1:IncomingPayment>
    <d2p1:IncomingPayment>
      <d2p1:Amount>2</d2p1:Amount>
      <d2p1:CurrencyID>sample string 3</d2p1:CurrencyID>
      <d2p1:CustomerBankAccountID>6</d2p1:CustomerBankAccountID>
      <d2p1:DealHeaderID>4</d2p1:DealHeaderID>
      <d2p1:DeliveryMethod>sample string 9</d2p1:DeliveryMethod>
      <d2p1:IncomingPaymentID>1</d2p1:IncomingPaymentID>
      <d2p1:Instrument>sample string 5</d2p1:Instrument>
      <d2p1:Status>sample string 7</d2p1:Status>
      <d2p1:UpdateToken>sample string 8</d2p1:UpdateToken>
    </d2p1:IncomingPayment>
    <d2p1:IncomingPayment>
      <d2p1:Amount>2</d2p1:Amount>
      <d2p1:CurrencyID>sample string 3</d2p1:CurrencyID>
      <d2p1:CustomerBankAccountID>6</d2p1:CustomerBankAccountID>
      <d2p1:DealHeaderID>4</d2p1:DealHeaderID>
      <d2p1:DeliveryMethod>sample string 9</d2p1:DeliveryMethod>
      <d2p1:IncomingPaymentID>1</d2p1:IncomingPaymentID>
      <d2p1:Instrument>sample string 5</d2p1:Instrument>
      <d2p1:Status>sample string 7</d2p1:Status>
      <d2p1:UpdateToken>sample string 8</d2p1:UpdateToken>
    </d2p1:IncomingPayment>
  </Settlements>
  <Status>sample string 12</Status>
  <ValueDate>sample string 3</ValueDate>
</SaveSpotRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

text/html

Sample:

{
  "DealHeaderID": 1,
  "RateQuoteID": "sample string 2",
  "ValueDate": "sample string 3",
  "BuyCurrency": "sample string 4",
  "BuyAmount": 5.0,
  "SellCurrency": "sample string 6",
  "SellAmount": 7.0,
  "CustomerRate": 8.0,
  "IncomingWire": 9,
  "Disbursements": [
    {
      "<BeneficiaryPaymentID>k__BackingField": 1,
      "<Instrument>k__BackingField": "sample string 2",
      "<BeneficiaryID>k__BackingField": 3,
      "<BeneficiaryBankAccountID>k__BackingField": 4,
      "<ValueDate>k__BackingField": "2026-01-31T07:14:39.7058541+00:00",
      "<SellAmount>k__BackingField": 6.0,
      "<PaymentReference>k__BackingField": "sample string 7",
      "<WireItemFee>k__BackingField": 8.0,
      "<WireItemFeeCurrencyID>k__BackingField": "sample string 9",
      "<InterfaceBalanceAccountId>k__BackingField": "sample string 10",
      "<Comments>k__BackingField": "sample string 11",
      "<Attachments>k__BackingField": [
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        }
      ],
      "<DeliveryMethod>k__BackingField": "sample string 12"
    },
    {
      "<BeneficiaryPaymentID>k__BackingField": 1,
      "<Instrument>k__BackingField": "sample string 2",
      "<BeneficiaryID>k__BackingField": 3,
      "<BeneficiaryBankAccountID>k__BackingField": 4,
      "<ValueDate>k__BackingField": "2026-01-31T07:14:39.7058541+00:00",
      "<SellAmount>k__BackingField": 6.0,
      "<PaymentReference>k__BackingField": "sample string 7",
      "<WireItemFee>k__BackingField": 8.0,
      "<WireItemFeeCurrencyID>k__BackingField": "sample string 9",
      "<InterfaceBalanceAccountId>k__BackingField": "sample string 10",
      "<Comments>k__BackingField": "sample string 11",
      "<Attachments>k__BackingField": [
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        }
      ],
      "<DeliveryMethod>k__BackingField": "sample string 12"
    },
    {
      "<BeneficiaryPaymentID>k__BackingField": 1,
      "<Instrument>k__BackingField": "sample string 2",
      "<BeneficiaryID>k__BackingField": 3,
      "<BeneficiaryBankAccountID>k__BackingField": 4,
      "<ValueDate>k__BackingField": "2026-01-31T07:14:39.7058541+00:00",
      "<SellAmount>k__BackingField": 6.0,
      "<PaymentReference>k__BackingField": "sample string 7",
      "<WireItemFee>k__BackingField": 8.0,
      "<WireItemFeeCurrencyID>k__BackingField": "sample string 9",
      "<InterfaceBalanceAccountId>k__BackingField": "sample string 10",
      "<Comments>k__BackingField": "sample string 11",
      "<Attachments>k__BackingField": [
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Data": "sample string 3"
        }
      ],
      "<DeliveryMethod>k__BackingField": "sample string 12"
    }
  ],
  "LockedSide": "sample string 10",
  "Settlements": [
    {
      "IncomingPaymentID": 1,
      "Amount": 2.0,
      "CurrencyID": "sample string 3",
      "DealHeaderID": 4,
      "Instrument": "sample string 5",
      "CustomerBankAccountID": 6,
      "Status": "sample string 7",
      "UpdateToken": "sample string 8",
      "DeliveryMethod": "sample string 9"
    },
    {
      "IncomingPaymentID": 1,
      "Amount": 2.0,
      "CurrencyID": "sample string 3",
      "DealHeaderID": 4,
      "Instrument": "sample string 5",
      "CustomerBankAccountID": 6,
      "Status": "sample string 7",
      "UpdateToken": "sample string 8",
      "DeliveryMethod": "sample string 9"
    },
    {
      "IncomingPaymentID": 1,
      "Amount": 2.0,
      "CurrencyID": "sample string 3",
      "DealHeaderID": 4,
      "Instrument": "sample string 5",
      "CustomerBankAccountID": 6,
      "Status": "sample string 7",
      "UpdateToken": "sample string 8",
      "DeliveryMethod": "sample string 9"
    }
  ],
  "ExternalMessage": "sample string 11",
  "Status": "sample string 12"
}