Currency Solutions Online Trading Platform API (1.4.1)
Download OpenAPI specification:Download
Currency Solutions Online Trading Platform can be used to book currency online in a simple manner
All requests to API (except getToken request) should have Authorization
header containing valid authorisation JWT token.
If you are the Service Provider all requests of your API users should have X-Provider-Hash
header containing valid security hash provided by you (if required).
API host for test environment:
https://op-api-demo.currencysolutions.co.uk/
API host for live environment:
https://op-api.currencysolutions.co.uk/
API users:
To obtain the API JWT token please write to it@currencysolutions.com specifying your details and environment you need the token for.
If you are the Service Provider please additionaly send us the security hash you would like to use for all of your API users requests.
Online Platform users:
First you have to obtain guest JWT token with your session data performing getToken request.
Having guest token you can get the valid JWT token by login request.
List of requests required to buy a currency online:
- Authorise to the systems with Authorization request (or use your API token).
- Get list of buy and sell currencies.
- Get currency exchange quote by Get Quote request.
- Book quote whithing expire time by Book Quote request.
- Get list of existing beneficiaries.
- Get list of reasons for transfer.
- Send out money by Send Out request.
Get list of buy currencies
Get list of currencies available to buy by authorised user
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 403
{- "content": {
- "data": {
- "USD": "USD - US Dollar",
- "GBP": "GBP - Pound Sterling"
}
}
}
Get list of sell currencies
Get list of currencies available to sell by authorised user
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 403
{- "content": {
- "data": {
- "USD": "USD - US Dollar",
- "GBP": "GBP - Pound Sterling"
}
}
}
Reasons for transfer list
List of reasons for transfer
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 403
{- "content": [
- {
- "data": {
- "206": "Savings",
- "207": "Mortgage",
- "208": "Send to family"
}
}
]
}
Book quote
Before using this method you have to get a quote performing get quote request. Book currency exchange quote. All quote data is stored on server and can be retrieved by quoted currencies before quote has been expired.
query Parameters
buyCurrency required | string Buy Currency which was used on getQuote request |
sellCurrency required | string Sell Currency which was used on getQuote request |
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 400
- 403
- 412
{- "content": {
- "data": {
- "currency": "EUR",
- "amount": 200,
- "sellCurrency": "GBP",
- "sellAmount": 179.76,
- "payAmount": 189.76,
- "rate": 1.1126,
- "tradeId": 248213,
- "tradeSignedId": "CS248213LV",
- "paymentId": 185735
}
}
}
Get a currency quote
Get a quote for currency exchange
query Parameters
buyCurrency required | number Currency that client wants to buy |
buyAmount required | string Amount that client wants to buy. Required unless sellAmount is provided |
sellCurrency required | string Currency that client wants to sell |
sellAmount required | number Amount that client wants to sell. Required unless buyAmount is provided |
date | string [Optional] The value date of the exchange (YYYY-MM-DD) |
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 403
- 412
{- "content": {
- "data": {
- "rate": 1.0722,
- "ratePair": "GBP\\/EUR",
- "invertedRate": 0.9327,
- "invertedRatePair": "EUR\\/GBP",
- "sellCurrency": "GBP",
- "sellAmount": 145.03,
- "buyCurrency": "EUR",
- "buyAmount": 155.5,
- "gbpValue": 137.77,
- "fees": {
- "transfer": 10
}, - "payAmount": 155.03,
- "status": "ACTIVE",
- "message": null,
- "timeout": 240,
- "expectedValueDate": "2017-07-21",
- "expectedValueDateBankTransfer": "2017-07-20",
- "bookTradeAllowed": true,
- "registerAllowed": false,
- "paymentMethods": [ ]
}
}
}
Send out
Provide the details of beneficiary for money transfer
query Parameters
id required | integer ID of created transfer template available from Book Quote request |
beneficiaryId | integer ID of existing beneficiary used for transfer |
currency required | string Transfer currency. Should be equal to buy currency. |
amount required | number Transfer amount |
destinationCountryId | string Two letter code of destination country. Required if no beneficiary ID provided. |
name | string The name of beneficiary. Required if no beneficiary ID provided. |
accountNumber | string Beneficiary account number. Required if no beneficiary ID provided. |
bankIdentifier | string Beneficiary bank identifier (Sort Code/SWIFT). Required if no beneficiary ID provided. |
countryId | string Two letter code of beneficiary country. Required for some currencies/countries. |
thirdParty | boolean Is beneficiary a third party? Required if no beneficiary ID provided. |
reference1 required | string Transfer reference |
reason required | number Reason for transfer ID. See result of get reasons request |
otherReason | string Other reason text. Required if other reason choosen. |
intermediaryBank | string Intermediary bank identifier (Sort Code/SWIFT). Required for some currencies/countries. |
address1 | string First line of beneficiary address. Required for some currencies/countries. |
address2 | string Second line of beneficiary address. Required for some currencies/countries. |
transitCode | string Transit code. Required for some currencies/countries. |
ifscCode | string IFSC code. Required for some currencies/countries. |
bsbCode | string BSB code. Required for some currencies/countries. |
mobileReference | string Mobile phone confirmation reference. Used if user confirmed his mobile phone. |
phoneCode | string Mobile phone country code. Used if user confirmed his mobile phone. |
mobile | string Mobile phone number without country code. Used if user confirmed his mobile phone. |
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 403
- 412
{- "content": {
- "data": {
- "result": true,
- "message": "Send out successfully created",
- "documentsRequired": false
}
}
}
Authorization
Send POST request to authorize user via login and password. Before using this method you have to obtain guest JWT token with your session data performing getToken request.
Notice: API users can use API JWT token. No additional authorization required.
query Parameters
email required | string Valid email address |
password required | string Password |
header Parameters
Authorization | string Guest iClaus session JWT Token (if available) |
Responses
Response samples
- 200
- 401
- 412
{- "content": {
- "data": {
- "token": "eyJ0eXAiOiJKV1QiLCJhbGci..."
}
}
}
Get beneficiaries list
Get all client beneficiaries
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 403
{- "count": "1",
- "items": [
- {
- "id": "123",
- "name": "Mr Smith",
- "accountNumber": "GB19LOYD3096456470709943",
- "bankIdentifier": "RBS",
- "intermediaryBank": "BOFAUS3NXXX",
- "address1": "SE1 2BG, 35 Hobbs Court",
- "address2": "2 Jacob Street",
- "countryId": "GB",
- "destinationCountryId": "FR",
- "reference": "For the property",
- "confirmed": 0,
- "currency": "GBP",
- "thirdParty": "0",
- "transitCode": "",
- "ifscCode": "",
- "bsbCode": ""
}
], - "page": "1",
- "per_page": "10"
}
Create a beneficiary
query Parameters
name required | string Name of beneficiary |
accountNumber required | string Beneficiary account number |
bankIdentifier required | string Bank identifier |
intermediaryBank | string Intermediary bank |
address1 required | string Address line 1 |
address2 required | string Address line 2 |
countryId required | string Country short code |
destinationCountryId required | string Destination country code |
reference | string Beneficiary reference |
currency required | string Currency code |
transitCode required | string Transit code |
ifscCode required | string IFSC code |
bsbCode required | string BSB code |
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 403
- 412
{- "id": "123",
- "name": "Mr Smith",
- "accountNumber": "GB19LOYD3096456470709943",
- "bankIdentifier": "RBS",
- "intermediaryBank": "BOFAUS3NXXX",
- "address1": "SE1 2BG, 35 Hobbs Court",
- "address2": "2 Jacob Street",
- "countryId": "GB",
- "destinationCountryId": "FR",
- "reference": "For the property",
- "confirmed": 0,
- "currency": "GBP",
- "thirdParty": "0",
- "transitCode": "",
- "ifscCode": "",
- "bsbCode": ""
}
Update beneficiary by id
query Parameters
name required | string Name of beneficiary |
accountNumber required | string Beneficiary account number |
bankIdentifier required | string Bank identifier |
intermediaryBank | string Intermediary bank |
address1 required | string Address line 1 |
address2 required | string Address line 2 |
countryId required | string Country short code |
destinationCountryId required | string Destination country code |
reference | string Beneficiary reference |
currency required | string Currency code |
transitCode required | string Transit code |
ifscCode required | string IFSC code |
bsbCode required | string BSB code |
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 403
{- "id": "123",
- "name": "Mr Smith",
- "accountNumber": "GB19LOYD3096456470709943",
- "bankIdentifier": "RBS",
- "intermediaryBank": "BOFAUS3NXXX",
- "address1": "SE1 2BG, 35 Hobbs Court",
- "address2": "2 Jacob Street",
- "countryId": "GB",
- "destinationCountryId": "FR",
- "reference": "For the property",
- "confirmed": 0,
- "currency": "GBP",
- "thirdParty": "0",
- "transitCode": "",
- "ifscCode": "",
- "bsbCode": ""
}
Client registration
Request Body schema: application/jsonrequired
Client basic information
title required | string Client's title |
firstName required | string Client's first name |
lastName required | string Client's last name |
phoneCode required | string Client's phone code |
mobile required | string Client's mobile phone number |
mobileStatus | string Client's mobile verification status |
string Client's email | |
emailConfirmed | bool Enum: true false Is client's email confirmed? |
buyAmount required | number Amount that client wants to buy |
buyCurrency required | string Currency that client wants to buy |
transferFundsTo | string Transfer funds to country |
reasonForTransfer | string Reason for transfer |
enquiryId | int Enquiry id (if present) or null |
object (Address) | |
object (Address) | |
birthDate required | string Client's date of birth. Format: YYYY-MM-DD |
birthPlace | string Client's country code of birth |
nationality | string Client's nationality code |
occupation | string Client's occupation |
question1 | string Secret question 1 |
answer1 | string Answer for secret question 1 |
question2 | string Secret question 2 |
answer2 | string Answer for secret question 2 |
password | string Password |
heardAboutUs | string Heard about us |
heardAboutUsDetails | string Heard about us details |
Responses
Request samples
- Payload
{- "title": "Mr",
- "firstName": "Alexander",
- "lastName": "Ivanov",
- "phoneCode": "44",
- "mobile": "7490223344",
- "mobileStatus": "",
- "email": "some@email.com",
- "emailConfirmed": true,
- "buyAmount": "100",
- "buyCurrency": "EUR",
- "transferFundsTo": "RU",
- "reasonForTransfer": "Want to buy house in Italy",
- "enquiryId": "1234",
- "currentAddress": {
- "country": "UK",
- "postCode": "SE1 2BG",
- "addressLine1": "Currency Solutions Ltd, Unit 35",
- "addressLine2": "Hobbs Court, 2 Jacob Street",
- "city": "London"
}, - "previousAddress": {
- "country": "UK",
- "postCode": "SE1 2BG",
- "addressLine1": "Currency Solutions Ltd, Unit 35",
- "addressLine2": "Hobbs Court, 2 Jacob Street",
- "city": "London"
}, - "birthDate": "1984-12-31",
- "birthPlace": "UK",
- "nationality": "GB",
- "occupation": "Programmer",
- "question1": "",
- "answer1": "",
- "question2": "",
- "answer2": "",
- "password": "",
- "heardAboutUs": "",
- "heardAboutUsDetails": ""
}
Response samples
- 200
{- "result": {
- "id": "registration id",
- "clientId": "New created client id",
- "showAwaitingDocuments": "Whether KYC passed or not"
}
}
Validate basic information
Request Body schema: application/jsonrequired
Validate client's basic information
title required | string Client's title |
firstName required | string Client's first name |
lastName required | string Client's last name |
phoneCode required | string Client's phone code |
mobile required | string Client's mobile phone number |
mobileStatus | string Client's mobile verification status |
string Client's email | |
emailConfirmed | bool Enum: true false Is client's email confirmed? |
buyAmount required | number Amount that client wants to buy |
buyCurrency required | string Currency that client wants to buy |
transferFundsTo | string Transfer funds to country |
reasonForTransfer | string Reason for transfer |
enquiryId | int Enquiry id (if present) or null |
Responses
Request samples
- Payload
{- "title": "Mr",
- "firstName": "Alexander",
- "lastName": "Ivanov",
- "phoneCode": "44",
- "mobile": "7490223344",
- "mobileStatus": "",
- "email": "some@email.com",
- "emailConfirmed": true,
- "buyAmount": "100",
- "buyCurrency": "EUR",
- "transferFundsTo": "RU",
- "reasonForTransfer": "Want to buy house in Italy",
- "enquiryId": "1234"
}
Response samples
- 200
- 412
{- "message": "validation success"
}
Validate basic information
Request Body schema: application/jsonrequired
Validate client's personal details
title required | string Client's title |
firstName required | string Client's first name |
lastName required | string Client's last name |
phoneCode required | string Client's phone code |
mobile required | string Client's mobile phone number |
mobileStatus | string Client's mobile verification status |
string Client's email | |
emailConfirmed | bool Enum: true false Is client's email confirmed? |
buyAmount required | number Amount that client wants to buy |
buyCurrency required | string Currency that client wants to buy |
transferFundsTo | string Transfer funds to country |
reasonForTransfer | string Reason for transfer |
enquiryId | int Enquiry id (if present) or null |
Responses
Request samples
- Payload
{- "title": "Mr",
- "firstName": "Alexander",
- "lastName": "Ivanov",
- "phoneCode": "44",
- "mobile": "7490223344",
- "mobileStatus": "",
- "email": "some@email.com",
- "emailConfirmed": true,
- "buyAmount": "100",
- "buyCurrency": "EUR",
- "transferFundsTo": "RU",
- "reasonForTransfer": "Want to buy house in Italy",
- "enquiryId": "1234"
}
Response samples
- 200
- 412
{- "message": "validation success"
}
Validate basic information
Request Body schema: application/jsonrequired
Validate corporate details
object (Company) | |
id | integer Client's registration id |
clientId | integer Client's id |
kycStatus | string Status of KYC check |
sanctions | bool is PEP or has sanctions |
object (BasicInformation) | |
object (PersonalDetails) | |
object (Security) | |
authFlag | integer Auth flag |
createClient | integer Create client |
dealerId | integer Dealer id |
remoteaddr | string Remote IP |
status | string Status |
heardAboutUs | string Heard about us |
keywords | string Keywords |
source | string Source |
httpreferer | string HTTP Referer |
contact | string Contact |
Responses
Request samples
- Payload
{- "company": {
- "name": "Currency Solutions",
- "type": "1",
- "number": "123456",
- "industrySector": "",
- "description": "Some description about company",
- "website": "www.currencysolutions.co.uk",
- "address": {
- "country": "UK",
- "postCode": "SE1 2BG",
- "addressLine1": "Currency Solutions Ltd, Unit 35",
- "addressLine2": "Hobbs Court, 2 Jacob Street",
- "city": "London"
}, - "correspondenceAddress": {
- "country": "UK",
- "postCode": "SE1 2BG",
- "addressLine1": "Currency Solutions Ltd, Unit 35",
- "addressLine2": "Hobbs Court, 2 Jacob Street",
- "city": "London"
}
}, - "id": "",
- "clientId": "",
- "kycStatus": "",
- "sanctions": null,
- "basicInformation": {
- "title": "Mr",
- "firstName": "Alexander",
- "lastName": "Ivanov",
- "phoneCode": "44",
- "mobile": "7490223344",
- "mobileStatus": "",
- "email": "some@email.com",
- "emailConfirmed": true,
- "buyAmount": "100",
- "buyCurrency": "EUR",
- "transferFundsTo": "RU",
- "reasonForTransfer": "Want to buy house in Italy",
- "enquiryId": "1234"
}, - "personal": {
- "currentAddress": {
- "country": "UK",
- "postCode": "SE1 2BG",
- "addressLine1": "Currency Solutions Ltd, Unit 35",
- "addressLine2": "Hobbs Court, 2 Jacob Street",
- "city": "London"
}, - "previousAddress": {
- "country": "UK",
- "postCode": "SE1 2BG",
- "addressLine1": "Currency Solutions Ltd, Unit 35",
- "addressLine2": "Hobbs Court, 2 Jacob Street",
- "city": "London"
}, - "birthDate": "1984-12-31",
- "birthPlace": "UK",
- "nationality": "GB",
- "occupation": "Programmer"
}, - "security": {
- "question1": "",
- "answer1": "",
- "question2": "",
- "answer2": "",
- "password": "",
- "heardAboutUs": "",
- "heardAboutUsDetails": ""
}, - "authFlag": "",
- "createClient": "",
- "dealerId": "",
- "remoteaddr": "",
- "status": "",
- "heardAboutUs": "",
- "keywords": "",
- "source": "",
- "httpreferer": "",
- "contact": ""
}
Response samples
- 200
- 412
{- "message": "validation success"
}
Validate security details
Request Body schema: application/jsonrequired
Validate security details
question1 | string Secret question 1 |
answer1 | string Answer for secret question 1 |
question2 | string Secret question 2 |
answer2 | string Answer for secret question 2 |
password | string Password |
heardAboutUs | string Heard about us |
heardAboutUsDetails | string Heard about us details |
Responses
Request samples
- Payload
{- "question1": "",
- "answer1": "",
- "question2": "",
- "answer2": "",
- "password": "",
- "heardAboutUs": "",
- "heardAboutUsDetails": ""
}
Response samples
- 200
- 412
{- "message": "validation success"
}
Postcode lookup
Get addresses by postcode
query Parameters
postcode required | string Postcode |
country required | string Country short code |
Responses
Response samples
- 200
- 412
{- "addressline1": [
- "Flat 1, Bassi Apartments 30A"
], - "addressline2": [
- "Turner Street"
], - "buildingname": [
- "Bassi Apartments 30A"
], - "county": [
- "Greater London"
], - "postcode": [
- "E5 12AS"
], - "posttown": [
- "London"
], - "premise": [
- "Flat 1, Bassi Apartments 30A"
], - "street": [
- "Turner Street"
], - "subbuildingname": [
- "Flat 1"
], - "summaryline": [
- "Flat 1, Bassi Apartments 30A, Turner Street, London, Greater London, E1 2AS"
]
}
Get trade history
Get all client's trades
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 403
{- "content": {
- "data": {
- "count": 0,
- "items": [
- {
- "id": 1,
- "signedId": "CS196323",
- "type": "Spot",
- "clientBuyAmount": 1500,
- "availableAmount": 0,
- "buyCurrency": "GBP",
- "clientSellAmount": 1000,
- "sellCurrency": "USD",
- "clientRate": 1.2,
- "currencyPair": "GBP-EUR",
- "date": "2016-08-16 00:00:00",
- "valueDate": "2016-08-18 00:00:00",
- "optionDate": "string",
- "status": "Settled",
- "transferId": 0
}
], - "page": "1",
- "per_page": "10"
}
}
}
Get transfer list
Get client all transfers
path Parameters
per_page required | integer Items count |
page required | integer Page number |
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 403
[- {
- "id": 0,
- "amount": "5000",
- "currency": "USD",
- "paymentId": 0,
- "beneficiaryId": 0,
- "date": "string",
- "countryId": "string",
- "status": "",
- "transferOption": "SHA",
- "reference1": "string",
- "reference2": "string",
- "reference3": "string",
- "reason": 0,
- "note": "string",
- "beneficiary": [
- {
- "id": "123",
- "name": "Mr Smith",
- "accountNumber": "GB19LOYD3096456470709943",
- "bankIdentifier": "RBS",
- "intermediaryBank": "BOFAUS3NXXX",
- "address1": "SE1 2BG, 35 Hobbs Court",
- "address2": "2 Jacob Street",
- "countryId": "GB",
- "destinationCountryId": "FR",
- "reference": "For the property",
- "confirmed": 0,
- "currency": "GBP",
- "thirdParty": "0",
- "transitCode": "",
- "ifscCode": "",
- "bsbCode": ""
}
], - "trade": [
- {
- "id": 1,
- "signedId": "CS196323",
- "type": "Spot",
- "clientBuyAmount": 1500,
- "availableAmount": 0,
- "buyCurrency": "GBP",
- "clientSellAmount": 1000,
- "sellCurrency": "USD",
- "clientRate": 1.2,
- "currencyPair": "GBP-EUR",
- "date": "2016-08-16 00:00:00",
- "valueDate": "2016-08-18 00:00:00",
- "optionDate": "string",
- "status": "Settled",
- "transferId": 0
}
]
}
]
Get transfer by ID
Get transfer by id
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 403
{- "id": 0,
- "amount": "5000",
- "currency": "USD",
- "paymentId": 0,
- "beneficiaryId": 0,
- "date": "string",
- "countryId": "string",
- "status": "",
- "transferOption": "SHA",
- "reference1": "string",
- "reference2": "string",
- "reference3": "string",
- "reason": 0,
- "note": "string",
- "beneficiary": [
- {
- "id": "123",
- "name": "Mr Smith",
- "accountNumber": "GB19LOYD3096456470709943",
- "bankIdentifier": "RBS",
- "intermediaryBank": "BOFAUS3NXXX",
- "address1": "SE1 2BG, 35 Hobbs Court",
- "address2": "2 Jacob Street",
- "countryId": "GB",
- "destinationCountryId": "FR",
- "reference": "For the property",
- "confirmed": 0,
- "currency": "GBP",
- "thirdParty": "0",
- "transitCode": "",
- "ifscCode": "",
- "bsbCode": ""
}
], - "trade": [
- {
- "id": 1,
- "signedId": "CS196323",
- "type": "Spot",
- "clientBuyAmount": 1500,
- "availableAmount": 0,
- "buyCurrency": "GBP",
- "clientSellAmount": 1000,
- "sellCurrency": "USD",
- "clientRate": 1.2,
- "currencyPair": "GBP-EUR",
- "date": "2016-08-16 00:00:00",
- "valueDate": "2016-08-18 00:00:00",
- "optionDate": "string",
- "status": "Settled",
- "transferId": 0
}
]
}
Send out
Provide the details of beneficiary for money transfer
query Parameters
id required | integer ID of created transfer template available from Book Quote request |
beneficiaryId | integer ID of existing beneficiary used for transfer |
currency required | string Transfer currency. Should be equal to buy currency. |
amount required | number Transfer amount |
destinationCountryId | string Two letter code of destination country. Required if no beneficiary ID provided. |
name | string The name of beneficiary. Required if no beneficiary ID provided. |
accountNumber | string Beneficiary account number. Required if no beneficiary ID provided. |
bankIdentifier | string Beneficiary bank identifier (Sort Code/SWIFT). Required if no beneficiary ID provided. |
countryId | string Two letter code of beneficiary country. Required for some currencies/countries. |
thirdParty | boolean Is beneficiary a third party? Required if no beneficiary ID provided. |
reference1 required | string Transfer reference |
reason required | number Reason for transfer ID. See result of get reasons request |
otherReason | string Other reason text. Required if other reason choosen. |
intermediaryBank | string Intermediary bank identifier (Sort Code/SWIFT). Required for some currencies/countries. |
address1 | string First line of beneficiary address. Required for some currencies/countries. |
address2 | string Second line of beneficiary address. Required for some currencies/countries. |
transitCode | string Transit code. Required for some currencies/countries. |
ifscCode | string IFSC code. Required for some currencies/countries. |
bsbCode | string BSB code. Required for some currencies/countries. |
mobileReference | string Mobile phone confirmation reference. Used if user confirmed his mobile phone. |
phoneCode | string Mobile phone country code. Used if user confirmed his mobile phone. |
mobile | string Mobile phone number without country code. Used if user confirmed his mobile phone. |
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 403
- 412
{- "content": {
- "data": {
- "result": true,
- "message": "Send out successfully created",
- "documentsRequired": false
}
}
}
Authorization
Send POST request to authorize user via login and password. Before using this method you have to obtain guest JWT token with your session data performing getToken request.
Notice: API users can use API JWT token. No additional authorization required.
query Parameters
email required | string Valid email address |
password required | string Password |
header Parameters
Authorization | string Guest iClaus session JWT Token (if available) |
Responses
Response samples
- 200
- 401
- 412
{- "content": {
- "data": {
- "token": "eyJ0eXAiOiJKV1QiLCJhbGci..."
}
}
}
User details
Request current logged user details
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 403
{- "content": {
- "data": {
- "user": {
- "id": 0,
- "regId": 0,
- "clientId": 0,
- "name": "string",
- "email": "string",
- "phoneCode": 0,
- "phoneNumber": 0,
- "profileType": "string",
- "clientSignedId": "string"
}, - "cardPaymentAccess": null
}
}
}
Get list of currencies
Get full list of all available currencies with additional data
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
{- "content": {
- "data": {
- "EUR": {
- "name": "EUR - Euro",
- "card": "false",
- "sell": "true",
- "buy": "true"
}, - "GBP": {
- "name": "GBP - Pound Sterling",
- "card": "true",
- "sell": "true",
- "buy": "true"
}
}
}
}
Countries list
Fetch list of countries
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
{- "content": [
- {
- "data": {
- "country_list": {
- "GB": "United Kingdom",
- "NL": "Netherlands"
}
}
}
]
}
Address required countries list
List of the countries where address is required
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 403
{- "content": [
- {
- "data": [
- "FR",
- "NL",
- "CZ"
]
}
]
}
Security questions list
List of security questions
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
{- "content": [
- {
- "data": {
- "1": "What was your childhood nickname?",
- "2": "What is the name of your favourite childhood friend?"
}
}
]
}
Reasons for transfer list
List of reasons for transfer
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 403
{- "content": [
- {
- "data": {
- "206": "Savings",
- "207": "Mortgage",
- "208": "Send to family"
}
}
]
}
Industry types list
List of industry types
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
{- "content": [
- {
- "data": {
- "1": "Banking",
- "5": "Automotive",
- "20": "Aerospace",
- "21": "Asset"
}
}
]
}
Occupations list
List of occupations
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
{- "content": [
- {
- "data": {
- "1": "Accountant",
- "2": "Administrative",
- "3": "Agent",
- "4": "Auditor",
- "5": "Builder"
}
}
]
}
Get statement list
Get all statements
path Parameters
currency required | string Currency for which statements are required |
bankDateFrom required | string Statement start date. A month from now by default |
bankDateTo required | string Statement end date. Current date by default |
Responses
Response samples
- 200
- 403
{- "data": [
- "[transactionId=>2481777,bankDate=>2016-08-18 00:00:00,description=>Fx-trade 196578,debit=>,credit=>45997.4,balance=>45997.4]"
]
}
Book quote
Before using this method you have to get a quote performing get quote request. Book currency exchange quote. All quote data is stored on server and can be retrieved by quoted currencies before quote has been expired.
query Parameters
buyCurrency required | string Buy Currency which was used on getQuote request |
sellCurrency required | string Sell Currency which was used on getQuote request |
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 400
- 403
- 412
{- "content": {
- "data": {
- "currency": "EUR",
- "amount": 200,
- "sellCurrency": "GBP",
- "sellAmount": 179.76,
- "payAmount": 189.76,
- "rate": 1.1126,
- "tradeId": 248213,
- "tradeSignedId": "CS248213LV",
- "paymentId": 185735
}
}
}
Get a currency quote
Get a quote for currency exchange
query Parameters
buyCurrency required | number Currency that client wants to buy |
buyAmount required | string Amount that client wants to buy. Required unless sellAmount is provided |
sellCurrency required | string Currency that client wants to sell |
sellAmount required | number Amount that client wants to sell. Required unless buyAmount is provided |
date | string [Optional] The value date of the exchange (YYYY-MM-DD) |
header Parameters
Authorization required | string JWT Auth Token |
X-Provider-Hash | string Security Hash (Service Providers only) |
Responses
Response samples
- 200
- 403
- 412
{- "content": {
- "data": {
- "rate": 1.0722,
- "ratePair": "GBP\\/EUR",
- "invertedRate": 0.9327,
- "invertedRatePair": "EUR\\/GBP",
- "sellCurrency": "GBP",
- "sellAmount": 145.03,
- "buyCurrency": "EUR",
- "buyAmount": 155.5,
- "gbpValue": 137.77,
- "fees": {
- "transfer": 10
}, - "payAmount": 155.03,
- "status": "ACTIVE",
- "message": null,
- "timeout": 240,
- "expectedValueDate": "2017-07-21",
- "expectedValueDateBankTransfer": "2017-07-20",
- "bookTradeAllowed": true,
- "registerAllowed": false,
- "paymentMethods": [ ]
}
}
}