PUT v1/Pricing/GetCalculatorResult

No documentation available.

Request Information

Parameters (ParameterName * = required)

Name
Description
Sample Value
PaymentMethod
The payment method of the request
CreditCard
DeliveryMethodID
The delivery method of the request
1
PromoCode
The promo code to be applied
K74S87
PromoId
The Id of the promotions usage to be applied
Not available
ShouldCalcAmountFrom
No description available
Not available
StateTo
No description available
Not available
HoldPromoCode
The promo code is holding
Not available
ShouldCalcVariableRates
No description available
Not available
ShouldCalcVariableFees
No description available
Not available
DeliveryMethods
The DMS's enumlist to calculate variable rates
Not available
Version
No description available
Not available
IsRecalculation
Indicates if request is recalculation
Not available
AmountFrom
The send amount (in currency from)
121.87
AmountTo
The receive amount (in currency to)
121.87
AgentToId
The agent ID relating to where the funds will be picked up
489712
AgentToLocationId
The agent location ID relating to where the funds will be picked up
12563211
BankId
The bank ID relating to where the funds will be picked up
12563211
DeliveryMethod
No description available
Not available
ignoreRestrictions
The ignore restrictions param to skip calling restrictions : as we have end point for exchange rate
Not available
PromoRate
No description available
Not available
CountryTo *
The 2-letter country code the customer is sending to
MX
CountryFrom
The 2-letter country code the customer is sending from
MX
CurrencyTo *
The 3-letter currency code that the funds will be paid out in
MXN
CurrencyFrom
The 3-letter currency code that the funds will be paid out in
MXN

Response Information

Response body formats

application/json, text/json

Sample:
{
  "sendAmountLimitsResponse": {
    "minimumSendFromAmount": 1.0,
    "maximumSendFromAmount": 2.0,
    "minimumSendToAmount": 3.0,
    "minimumSendToAmountIsDefaulted": true,
    "maximumSendToAmount": 5.0,
    "maximumSendToAmountIsDefaulted": true,
    "showInlineError": true
  },
  "amountToReceive": 1.0,
  "amountFrom": 1.0,
  "transferFee": 2.0,
  "exchangeRate": 1.0,
  "isInvalidSendAmount": true,
  "decimalPrecision": 4,
  "customerTax": 5.0,
  "validationExceptionMessage": "sample string 6",
  "promoAmount": 7.0,
  "originalCustomerFee": 8.0,
  "isPromoValid": true,
  "transIDAvail": 10,
  "promoRuleId": 11,
  "rateLevel": 12,
  "rateFrom": 13.0,
  "rateTo": 14.0,
  "buyRateFrom": 15.0,
  "buyRateTo": 16.0,
  "buyRate": 17.0,
  "baseRate": 18.0,
  "isReceiveAmountSplit": true,
  "splitExchangeRate1": 1.0,
  "splitReceiveAmount1": 20.0,
  "splitCurrency1": "sample string 21",
  "splitExchangeRate2": 1.0,
  "splitReceiveAmount2": 22.0,
  "splitCurrency2": "sample string 23",
  "variableRates": [
    {
      "value": "sample string 1",
      "exchangeRate": 1.0,
      "payAgentId": 2,
      "payAgentName": "sample string 3",
      "deliveryMethod": "Any"
    },
    {
      "value": "sample string 1",
      "exchangeRate": 1.0,
      "payAgentId": 2,
      "payAgentName": "sample string 3",
      "deliveryMethod": "Any"
    },
    {
      "value": "sample string 1",
      "exchangeRate": 1.0,
      "payAgentId": 2,
      "payAgentName": "sample string 3",
      "deliveryMethod": "Any"
    }
  ],
  "variableFees": [
    {
      "originalCustomerFee": 1.0,
      "customerFee": 1.0,
      "paymentMethod": "Any"
    },
    {
      "originalCustomerFee": 1.0,
      "customerFee": 1.0,
      "paymentMethod": "Any"
    },
    {
      "originalCustomerFee": 1.0,
      "customerFee": 1.0,
      "paymentMethod": "Any"
    }
  ],
  "sendAmountUSD": 1.0,
  "correspondentPayoutFeeCurrency": "sample string 24",
  "correspondentPayoutFeeAmount": 25.0,
  "estimatedAmountToAfterCorrespondentFees": 26.0,
  "payAgentId": 27,
  "payAgentName": "sample string 28",
  "transferFeeUSD": 29.0,
  "rateItemId": 30,
  "exchangeRatePromo": 1.0,
  "calculatedRatePromo": 1.0,
  "isWelcomeRate": true
}

application/xml, text/xml

Sample:
<CalculatorResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DataModels">
  <_x003C_AmountFrom_x003E_k__BackingField>1</_x003C_AmountFrom_x003E_k__BackingField>
  <_x003C_AmountToReceive_x003E_k__BackingField>1</_x003C_AmountToReceive_x003E_k__BackingField>
  <_x003C_BaseRate_x003E_k__BackingField>18</_x003C_BaseRate_x003E_k__BackingField>
  <_x003C_BuyRateFrom_x003E_k__BackingField>15</_x003C_BuyRateFrom_x003E_k__BackingField>
  <_x003C_BuyRateTo_x003E_k__BackingField>16</_x003C_BuyRateTo_x003E_k__BackingField>
  <_x003C_BuyRate_x003E_k__BackingField>17</_x003C_BuyRate_x003E_k__BackingField>
  <_x003C_CalculatedRatePromo_x003E_k__BackingField>1</_x003C_CalculatedRatePromo_x003E_k__BackingField>
  <_x003C_CorrespondentPayoutFeeAmount_x003E_k__BackingField>25</_x003C_CorrespondentPayoutFeeAmount_x003E_k__BackingField>
  <_x003C_CorrespondentPayoutFeeCurrency_x003E_k__BackingField>sample string 24</_x003C_CorrespondentPayoutFeeCurrency_x003E_k__BackingField>
  <_x003C_CustomerTax_x003E_k__BackingField>5</_x003C_CustomerTax_x003E_k__BackingField>
  <_x003C_DecimalPrecision_x003E_k__BackingField>4</_x003C_DecimalPrecision_x003E_k__BackingField>
  <_x003C_EstimatedAmountToAfterCorrespondentFees_x003E_k__BackingField>26</_x003C_EstimatedAmountToAfterCorrespondentFees_x003E_k__BackingField>
  <_x003C_ExchangeRatePromo_x003E_k__BackingField>1</_x003C_ExchangeRatePromo_x003E_k__BackingField>
  <_x003C_ExchangeRate_x003E_k__BackingField>1</_x003C_ExchangeRate_x003E_k__BackingField>
  <_x003C_IsInvalidSendAmount_x003E_k__BackingField>true</_x003C_IsInvalidSendAmount_x003E_k__BackingField>
  <_x003C_IsPromoValid_x003E_k__BackingField>true</_x003C_IsPromoValid_x003E_k__BackingField>
  <_x003C_IsReceiveAmountSplit_x003E_k__BackingField>true</_x003C_IsReceiveAmountSplit_x003E_k__BackingField>
  <_x003C_IsWelcomeRate_x003E_k__BackingField>true</_x003C_IsWelcomeRate_x003E_k__BackingField>
  <_x003C_OriginalCustomerFee_x003E_k__BackingField>8</_x003C_OriginalCustomerFee_x003E_k__BackingField>
  <_x003C_PayAgentId_x003E_k__BackingField>27</_x003C_PayAgentId_x003E_k__BackingField>
  <_x003C_PayAgentName_x003E_k__BackingField>sample string 28</_x003C_PayAgentName_x003E_k__BackingField>
  <_x003C_PromoAmount_x003E_k__BackingField>7</_x003C_PromoAmount_x003E_k__BackingField>
  <_x003C_PromoRuleId_x003E_k__BackingField>11</_x003C_PromoRuleId_x003E_k__BackingField>
  <_x003C_RateFrom_x003E_k__BackingField>13</_x003C_RateFrom_x003E_k__BackingField>
  <_x003C_RateItemId_x003E_k__BackingField>30</_x003C_RateItemId_x003E_k__BackingField>
  <_x003C_RateLevel_x003E_k__BackingField>12</_x003C_RateLevel_x003E_k__BackingField>
  <_x003C_RateTo_x003E_k__BackingField>14</_x003C_RateTo_x003E_k__BackingField>
  <_x003C_SendAmountLimitsResponse_x003E_k__BackingField>
    <_x003C_MaximumSendFromAmount_x003E_k__BackingField>2</_x003C_MaximumSendFromAmount_x003E_k__BackingField>
    <_x003C_MaximumSendToAmountIsDefaulted_x003E_k__BackingField>true</_x003C_MaximumSendToAmountIsDefaulted_x003E_k__BackingField>
    <_x003C_MaximumSendToAmount_x003E_k__BackingField>5</_x003C_MaximumSendToAmount_x003E_k__BackingField>
    <_x003C_MinimumSendFromAmount_x003E_k__BackingField>1</_x003C_MinimumSendFromAmount_x003E_k__BackingField>
    <_x003C_MinimumSendToAmountIsDefaulted_x003E_k__BackingField>true</_x003C_MinimumSendToAmountIsDefaulted_x003E_k__BackingField>
    <_x003C_MinimumSendToAmount_x003E_k__BackingField>3</_x003C_MinimumSendToAmount_x003E_k__BackingField>
    <_x003C_ShowInlineError_x003E_k__BackingField>true</_x003C_ShowInlineError_x003E_k__BackingField>
  </_x003C_SendAmountLimitsResponse_x003E_k__BackingField>
  <_x003C_SendAmountUSD_x003E_k__BackingField>1</_x003C_SendAmountUSD_x003E_k__BackingField>
  <_x003C_SplitCurrency1_x003E_k__BackingField>sample string 21</_x003C_SplitCurrency1_x003E_k__BackingField>
  <_x003C_SplitCurrency2_x003E_k__BackingField>sample string 23</_x003C_SplitCurrency2_x003E_k__BackingField>
  <_x003C_SplitExchangeRate1_x003E_k__BackingField>1</_x003C_SplitExchangeRate1_x003E_k__BackingField>
  <_x003C_SplitExchangeRate2_x003E_k__BackingField>1</_x003C_SplitExchangeRate2_x003E_k__BackingField>
  <_x003C_SplitReceiveAmount1_x003E_k__BackingField>20</_x003C_SplitReceiveAmount1_x003E_k__BackingField>
  <_x003C_SplitReceiveAmount2_x003E_k__BackingField>22</_x003C_SplitReceiveAmount2_x003E_k__BackingField>
  <_x003C_TransIDAvail_x003E_k__BackingField>10</_x003C_TransIDAvail_x003E_k__BackingField>
  <_x003C_TransferFeeUSD_x003E_k__BackingField>29</_x003C_TransferFeeUSD_x003E_k__BackingField>
  <_x003C_TransferFee_x003E_k__BackingField>2</_x003C_TransferFee_x003E_k__BackingField>
  <_x003C_ValidationExceptionMessage_x003E_k__BackingField>sample string 6</_x003C_ValidationExceptionMessage_x003E_k__BackingField>
  <_x003C_VariableFees_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DataModels.Pricing">
    <d2p1:VariableFeeResponse>
      <d2p1:CustomerFee>1</d2p1:CustomerFee>
      <d2p1:OriginalCustomerFee>1</d2p1:OriginalCustomerFee>
      <d2p1:PaymentMethod>Any</d2p1:PaymentMethod>
    </d2p1:VariableFeeResponse>
    <d2p1:VariableFeeResponse>
      <d2p1:CustomerFee>1</d2p1:CustomerFee>
      <d2p1:OriginalCustomerFee>1</d2p1:OriginalCustomerFee>
      <d2p1:PaymentMethod>Any</d2p1:PaymentMethod>
    </d2p1:VariableFeeResponse>
    <d2p1:VariableFeeResponse>
      <d2p1:CustomerFee>1</d2p1:CustomerFee>
      <d2p1:OriginalCustomerFee>1</d2p1:OriginalCustomerFee>
      <d2p1:PaymentMethod>Any</d2p1:PaymentMethod>
    </d2p1:VariableFeeResponse>
  </_x003C_VariableFees_x003E_k__BackingField>
  <_x003C_VariableRates_x003E_k__BackingField>
    <VariableRatesResponse>
      <_x003C_DeliveryMethod_x003E_k__BackingField>Any</_x003C_DeliveryMethod_x003E_k__BackingField>
      <_x003C_ExchangeRate_x003E_k__BackingField>1</_x003C_ExchangeRate_x003E_k__BackingField>
      <_x003C_PayAgentId_x003E_k__BackingField>2</_x003C_PayAgentId_x003E_k__BackingField>
      <_x003C_PayAgentName_x003E_k__BackingField>sample string 3</_x003C_PayAgentName_x003E_k__BackingField>
      <_x003C_Value_x003E_k__BackingField>sample string 1</_x003C_Value_x003E_k__BackingField>
    </VariableRatesResponse>
    <VariableRatesResponse>
      <_x003C_DeliveryMethod_x003E_k__BackingField>Any</_x003C_DeliveryMethod_x003E_k__BackingField>
      <_x003C_ExchangeRate_x003E_k__BackingField>1</_x003C_ExchangeRate_x003E_k__BackingField>
      <_x003C_PayAgentId_x003E_k__BackingField>2</_x003C_PayAgentId_x003E_k__BackingField>
      <_x003C_PayAgentName_x003E_k__BackingField>sample string 3</_x003C_PayAgentName_x003E_k__BackingField>
      <_x003C_Value_x003E_k__BackingField>sample string 1</_x003C_Value_x003E_k__BackingField>
    </VariableRatesResponse>
    <VariableRatesResponse>
      <_x003C_DeliveryMethod_x003E_k__BackingField>Any</_x003C_DeliveryMethod_x003E_k__BackingField>
      <_x003C_ExchangeRate_x003E_k__BackingField>1</_x003C_ExchangeRate_x003E_k__BackingField>
      <_x003C_PayAgentId_x003E_k__BackingField>2</_x003C_PayAgentId_x003E_k__BackingField>
      <_x003C_PayAgentName_x003E_k__BackingField>sample string 3</_x003C_PayAgentName_x003E_k__BackingField>
      <_x003C_Value_x003E_k__BackingField>sample string 1</_x003C_Value_x003E_k__BackingField>
    </VariableRatesResponse>
  </_x003C_VariableRates_x003E_k__BackingField>
</CalculatorResponse>