Convert amount

GET https://{domainname}/client/v1/{customerId}/services/convert/amount

Services

Request

Using the convert amount API you can ask our system to convert an amount from one currency into another currency. We will use the rate set configured for your account to perform the conversion.

All amount fields in our API are in cents with each amount having 2 decimals, regardless of the actual decimal places the currency has. So JPY has no decimals in it currency, but you will need to add two zeros as cents.

Query parameters

Query parameters for this method

Property	Type	Required	Repeat	Details
source	string	yes	no	read close
close Description Three-letter ISO currency code representing the source currency
target	string	yes	no	read close
close Description Three-letter ISO currency code representing the target currency
amount	integer	yes	no	read close
close Description Amount to be converted in cents and always having 2 decimals

Request example

SDK: Swift

This scenario you will probably use the most

import IngenicoConnectKit

let clientSessionId = "<clientSessionId from Create Session>"
let customerId = "<customerId from Create Session>"
let baseURL = "<clientApiUrl from Create Session>"
let assetBaseURL = "<assetUrl from Create Session>"
let appIdentifier = "<your app name>"

let session = Session(clientSessionId: clientSessionId, customerId: customerId,
                      baseURL: baseURL, assetBaseURL: assetBaseURL, appIdentifier: appIdentifier)

let amountInCents = 100
let source: CurrencyCode = .EUR
let target: CurrencyCode = .USD

session.convert(amountInCents: amountInCents, source: source, target: target, success: { convertedAmountInCents in
    // Process converted amount in cents.
}, failure: { error in
    Macros.DLog(message: "Error while converting amount: \(error.localizedDescription)")
})

Responses

Please find below an overview of the possible responses.

Response 200 - OKConvertAmount

The response contains the converted amount

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
convertedAmount	integer	no	read close
close Description Converted amount in cents

Response example

SDK: Swift

This scenario you will probably use the most

```
{
    "convertedAmount" : 138
}
```

Response 400 - Bad requestErrorResponse

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
errorId	string	yes	read close
close Description Unique reference, for debugging purposes, of this error response
errors	array of object	yes	read close
close Description List of one or more errors
items	object	no	read close
close SDK Object type APIError
category	string	no	read close
close Description Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values: CONNECT\_PLATFORM\_ERROR - indicating that a functional error has occurred in the Connect platform. PAYMENT\_PLATFORM\_ERROR - indicating that a functional error has occurred in the Payment platform. IO\_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
code	string	yes	read close
close Description Error code
httpStatusCode	integer	no	read close
close Description HTTP status code for this error that can be used to determine the type of error
id	string	no	read close
close Description ID of the error. This is a short human-readable message that briefly describes the error.
message	string	no	read close
close Description Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
propertyName	string	no	read close
close Description Returned only if the error relates to a value that was missing or incorrect. Contains a location path to the value as a JSonata query. Some common examples: a.b selects the value of property b of root property a, a[1] selects the first element of the array in root property a, a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
requestId	string	no	read close
close Description ID of the request that can be used for debugging purposes

Response example

SDK: Swift

This scenario you will probably use the most

{
    "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092",
    "errors" : [
        {
            "code" : "20000000",
            "propertyName" : "bankAccountBban.accountNumber",
            "message" : "PARAMETER_NOT_FOUND_IN_REQUEST"
        }
    ]
}