{"_id":"5632a5ea49e16d0d0012248b","project":"55b933b3146ef121002158d3","user":"55b932ba8fd1a02b00f496c8","githubsync":"","category":{"_id":"5632a5e749e16d0d0012244d","__v":1,"pages":["5632a5ea49e16d0d00122481","5632a5ea49e16d0d00122482","5632a5ea49e16d0d00122483","5632a5ea49e16d0d00122484","5632a5ea49e16d0d00122485","5632a5ea49e16d0d00122486","5632a5ea49e16d0d00122487","5632a5ea49e16d0d00122488","5632a5ea49e16d0d00122489","5632a5ea49e16d0d0012248a","5632a5ea49e16d0d0012248b","5632a5ea49e16d0d0012248c","5632a5ea49e16d0d0012248d","5632a5ea49e16d0d0012248e","5632a5ea49e16d0d0012248f","5632a5ea49e16d0d00122490","5632a5ea49e16d0d00122491","5632a5ea49e16d0d00122492","5632a5ea49e16d0d00122493","5632a5ea49e16d0d00122494","5632a5ea49e16d0d00122495","5632a5ea49e16d0d00122496","5632a5ea49e16d0d00122497","5632a5ea49e16d0d00122498","5632a5ea49e16d0d00122499","5632a5ea49e16d0d0012249a","5632a5ea49e16d0d0012249b","5632a5ea49e16d0d0012249c","5632a5ea49e16d0d0012249d","5632a5ea49e16d0d0012249e","5632a5ea49e16d0d0012249f","5632a5ea49e16d0d001224a0","5632a5ea49e16d0d001224a1","5632a5ea49e16d0d001224a2","5632a5ea49e16d0d001224a3","5632a5ea49e16d0d001224a4","5632a5ea49e16d0d001224a5","5632a5ea49e16d0d001224a6","5632a5ea49e16d0d001224a7"],"project":"55b933b3146ef121002158d3","version":"5632a5e549e16d0d00122443","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-04T17:34:02.800Z","from_sync":false,"order":12,"slug":"objects","title":"Objects"},"version":{"_id":"5632a5e549e16d0d00122443","__v":6,"project":"55b933b3146ef121002158d3","createdAt":"2015-10-29T23:04:05.701Z","releaseDate":"2015-10-29T23:04:05.701Z","categories":["5632a5e749e16d0d00122444","5632a5e749e16d0d00122445","5632a5e749e16d0d00122446","5632a5e749e16d0d00122447","5632a5e749e16d0d00122448","5632a5e749e16d0d00122449","5632a5e749e16d0d0012244a","5632a5e749e16d0d0012244b","5632a5e749e16d0d0012244c","5632a5e749e16d0d0012244d","5632a5e749e16d0d0012244e","5632a5e749e16d0d0012244f","5632a5e749e16d0d00122450","5632b179df556c0d00cd095b","564e13053b2b4a19000cd69b","59caa9df65accc001a489c95","59cab50965accc001a489d28","59cadd464ab7b70024378e74"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:52:41.380Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":9,"body":"Contains the results of a currency conversion.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis object contains the results of a currency conversion. The currency codes are the 3 digit numeric codes found on the Currency Code list.\nIn order for a merchant account to process multi-currency transactions, the account must be configured to accept transactions in multiple currencies. To determine which currencies a merchant account is authorized to accept, use the [getSupportedCurrencies](/docs/getsupportedcurrencies) method, which will return an array containing the currencies that are supported by the merchant account.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Properties\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"string\",\n    \"0-1\": \"FromCurrency\",\n    \"0-2\": \"Code of currency that transaction amount is being converted from.\",\n    \"1-0\": \"double\",\n    \"1-1\": \"FromAmount\",\n    \"1-2\": \"Amount being converted. This amount is shown in the original currency, before the conversion takes place (FromCurrency).\",\n    \"2-0\": \"string\",\n    \"2-1\": \"Currency\",\n    \"2-2\": \"Code of currency that transaction amount is being converted to.\",\n    \"3-0\": \"double\",\n    \"3-1\": \"Rate\",\n    \"3-2\": \"Conversion rate used.\",\n    \"4-0\": \"double\",\n    \"4-1\": \"Amount\",\n    \"4-2\": \"Amount converted to new currency. This amount is shown in the new currency that the amount has been converted to (Currency).\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\n## PHP \n\nFor directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n$CurrencyConversionObject=$this->client->getTransaction($this->token, $FromCurrency, $ToCurrency, $Amount);\\necho $CurrencyConversionObject->Amount;\\n?>\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim response As eBizCharge.CurrencyConversion = New eBizCharge.CurrencyConversion\\n       response = client.currencyConversion(token, from, convert, amount)\\n       MsgBox(response.Amount)\",\n      \"language\": \"asp\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"eBizCharge.CurrencyConversion response = new eBizCharge.CurrencyConversion();\\n           try\\n           {\\n               response = client.currencyConversion(token, from, to, amount);\\n               MessageBox.Show(string.Concat(response.Amount));\\n           }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]\n## XML \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<currencyConversionReturn xsi:type=\\\"ns1:CurrencyConversion\\\">\\n<Amount xsi:type=\\\"xsd:double\\\">34.19</Amount>\\n<Currency xsi:type=\\\"xsd:string\\\">978</Currency>\\n<FromAmount xsi:type=\\\"xsd:double\\\">50</FromAmount>\\n<FromCurrency xsi:type=\\\"xsd:string\\\">840</FromCurrency>\\n<Rate xsi:type=\\\"xsd:double\\\">0.68383862</Rate>\\n</currencyConversionReturn>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"currencyconversion-1","type":"basic","title":"CurrencyConversion"}

CurrencyConversion


Contains the results of a currency conversion. [block:api-header] { "type": "basic", "title": "Description" } [/block] This object contains the results of a currency conversion. The currency codes are the 3 digit numeric codes found on the Currency Code list. In order for a merchant account to process multi-currency transactions, the account must be configured to accept transactions in multiple currencies. To determine which currencies a merchant account is authorized to accept, use the [getSupportedCurrencies](/docs/getsupportedcurrencies) method, which will return an array containing the currencies that are supported by the merchant account. [block:api-header] { "type": "basic", "title": "Properties" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "string", "0-1": "FromCurrency", "0-2": "Code of currency that transaction amount is being converted from.", "1-0": "double", "1-1": "FromAmount", "1-2": "Amount being converted. This amount is shown in the original currency, before the conversion takes place (FromCurrency).", "2-0": "string", "2-1": "Currency", "2-2": "Code of currency that transaction amount is being converted to.", "3-0": "double", "3-1": "Rate", "3-2": "Conversion rate used.", "4-0": "double", "4-1": "Amount", "4-2": "Amount converted to new currency. This amount is shown in the new currency that the amount has been converted to (Currency)." }, "cols": 3, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to. [block:code] { "codes": [ { "code": "<?php\n$CurrencyConversionObject=$this->client->getTransaction($this->token, $FromCurrency, $ToCurrency, $Amount);\necho $CurrencyConversionObject->Amount;\n?>", "language": "php" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim response As eBizCharge.CurrencyConversion = New eBizCharge.CurrencyConversion\n response = client.currencyConversion(token, from, convert, amount)\n MsgBox(response.Amount)", "language": "asp" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "eBizCharge.CurrencyConversion response = new eBizCharge.CurrencyConversion();\n try\n {\n response = client.currencyConversion(token, from, to, amount);\n MessageBox.Show(string.Concat(response.Amount));\n }", "language": "csharp" } ] } [/block] ## XML [block:code] { "codes": [ { "code": "<currencyConversionReturn xsi:type=\"ns1:CurrencyConversion\">\n<Amount xsi:type=\"xsd:double\">34.19</Amount>\n<Currency xsi:type=\"xsd:string\">978</Currency>\n<FromAmount xsi:type=\"xsd:double\">50</FromAmount>\n<FromCurrency xsi:type=\"xsd:string\">840</FromCurrency>\n<Rate xsi:type=\"xsd:double\">0.68383862</Rate>\n</currencyConversionReturn>", "language": "xml" } ] } [/block]