NAV Navbar
Wallex api logo

Getting Started v1.37.0

Introduction

Welcome to the Wallex API ! Our API allows you to programmatically perform conversions, payments and collections, allowing you to automate your payment processes.

Our API is built by developers for developers making it straightforward to integrate with our systems.

Browse through our documentation and log in to our demo system to check out live responses right here in Developer Center and if you still have any questions, please let us know.

You can reach out to us via email at contact@wallextech.com if you need technical support on Wallex API integration.

Credentials

To start using our API you will require certain credentials that we will use to identify and authorise the use of wallex API.

How to get your Credentials

Please reach out to us at contact@wallextech.com to obtain your credentials. You are suppose to get the following credentials from us to start using the API.

Name Description
X-Api-Key Will be used to identify you on consuming the API.
accessKeyId Will need this to obtain the authorisation token which is used to access restricted resources.
secretAccessKey Will need this to obtain the authorisation token which is used to access restricted resources.

Headers

To successfully communicate with Wallex API, you must provide the following headers in your API requests when necessary:

Name Description
X-Api-Key This header must be presented will every API request that you make.
Authorization This header should be presented when accessing restricted resources.

If the X-Api-Key header wasn’t included in any API request you will be returned a 403 Forbidden as the response.

If the Authorization header wasn’t included in a API request that is trying to access a restricted resource you will be returned a 401 Unauthorized with authentication_failed message.

For the Authorization, you should generate the token by calling our Authentication API.

API Call Rate Limits

By default we allow 5 API requests per second and a Total of 432,000 API requests per day. If you need a customised rate limit for your API calls please contact us at contact@wallextech.com describing your request to us.

Wallex Endpoints

All Wallex endpoints are located on a single domain: https://api.wallex.asia. Though you can access our demo endpoints at: https://api.wallex.rocks.

Postman Collection

For your convenience we also provide postman collection to our API. please use the button below to integrate with your postman app

Run in Postman

Authentication API

Authenticate

Request body:

{
    "accessKeyId": "50afcbd2054d11e79317002618a72855",
    "secretAccessKey": "6D741B8CAA9D224896288FADB8A9DEFD18313A5AD98314D0386660646E92C803"
}

Response:

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZWNoQHh3YXBwLmNvbSIsInNlc3Npb25faWQiOiI0ODMyNjMyMzBiNmJjMjg0YzNkZTExYjZiNjExOTcyMyIsImlhdCI6MTQ5OTgzMTE5N30=.Q4mYfADHT2d72tZZeKsGxy76QsMq43DbCDSxEJle-Ao="
}

HTTP Request

POST /users/v1/authenticate

Body Parameters

The payload for body should be submitted in application/json format.

Parameter Description
accessKeyId
required
string Your access key ID
secretAccessKey
required
string Your secret access key

Response

Returns a token for use with the API. The token must be added as a HTTP header to all API calls in the HTTP Authorization header when your accessing restricted resources. Please contact Wallex for access key ID and secret access key.

Following is an example of a Authorization header that will be returned to you upon successful authentication.

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZWNoQHh3YXBwLmNvbSIsInNlc3Npb25faWQiOiI0ODMyNjMyMzBiNmJjMjg0YzNkZTExYjZiNjExOTcyMyIsImlhdCI6MTQ5OTgzMTE5N30=.Q4mYfADHT2d72tZZeKsGxy76QsMq43DbCDSxEJle-Ao=

Token Expiry

The token issued upon successful authentication will only be valid for 8 Hours from the time it was issued. You have to obtain new token once the token expires. However, you can obtain new token when the old token is not expired.

Logout

Response:

HTTP Request

POST /users/v1/logout

token will be invalidated and will not be usable even if the token is not expired.

Response

HTTP status code 200

Beneficiaries API

A Beneficiary is a company or individual that is targeted be on the receiving end of a Simple Payment. This API allows you to create, delete, and update your beneficiaries. You can also retrieve individual beneficiaries as well as a list of all your beneficiaries.

Beneficiary Requirements

Request body:

{
    "currency": "USD",
    "bankAccountCountry": "SG",
    "beneficiaryCountry": "SG"
}

Response:

{
    "data": [
        {
            "entityType": "individual",
            "address": "^.{1,255}",
            "country": "^[A-z]{2}$",
            "city": "^.{1,255}",
            "firstName": "^.{1,255}",
            "lastName": "^.{1,255}",
            "bankAccount": {
                "currency": "^[A-Z]{3}",
                "bankName": "^.{1,255}",
                "bicSwift": "^[0-9A-Z]{8}$|^[0-9A-Z]{11}$",
                "country": "^[A-Z]{2}",
                "accountNumber": "^[0-9A-Z]{6,16}$"
            }
        },
        {
            "entityType": "company",
            "address": "^.{1,255}",
            "country": "^[A-z]{2}$",
            "city": "^.{1,255}",
            "companyName": "^.{1,255}",
            "bankAccount": {
                "currency": "^[A-Z]{3}",
                "bankName": "^.{1,255}",
                "bicSwift": "^[0-9A-Z]{8}$|^[0-9A-Z]{11}$",
                "country": "^[A-Z]{2}",
                "accountNumber": "^[0-9A-Z]{6,16}$"
            }
        }
    ]
}

Returns the required fields and their respective validation rules to create a beneficiary, based on currency, beneficiary country and bank country.

HTTP Request

POST /beneficiaries/v1/requirements

Optional Parameters

Parameter Description
currency
required
string The currency, e.g USD.
bankAccountCountry
required
string The bank account country, e.g SG.
beneficiaryCountry
required
string The beneficiary country, e.g SG.

Create a Beneficiary

Request body:

{
    "onBehalfOfAccount": "70f1722d-b997-44c2-a2e8-691c1090d1be",
    "country": "SG",
    "bankAccount": {
        "bankName": "Bank Of Singapore",
        "address": "Road 123",
        "currency": "SGD",
        "country": "SG",
        "bankAccountHolderName": "John",
        "accountNumber": "12345678",
        "bicSwift": "UOVBSGSG"
    },
    "intermediaryBank": {
        "bankName": "Bank Name",
        "accountNumber": "87654321",
        "address": "Road 456",
        "bicSwift": "UOVBSGTS"
    },
    "nickname": "JOHN_SG",
    "email": "user@example.com",
    "entityType": "company",
    "city": "Singapore",
    "address": "Road 321",
    "companyName": "Wallex",
    "businessRegistration": "056790815678",
    "nationalIdentificationNumber": "098444416781",
    "region": "KOTA JAKARTA SELATAN",
    "relationship": "NON_RELATED"
}

Response:

{
    "data": {
        "address": "Road 321",
        "businessRegistration": "056790815678",
        "city": "Singapore",
        "companyName": "Wallex",
        "country": "SG",
        "email": "user@example.com",
        "entityType": "company",
        "beneficiaryId": "2ae51d82-b736-11e8-a999-0201da8d0509",
        "nationalIdentificationNumber": "098444416781",
        "nickname": "Wallex - Bank Of Singapore - 12345678",
        "region": "KOTA JAKARTA SELATAN",
        "relationship": "NON_RELATED",
        "type": "bank",
        "bankAccount": {
            "bankName": "Bank Of Singapore",
            "address": "Road 123",
            "currency": "SGD",
            "country": "SG",
            "bankAccountHolderName": "John",
            "accountNumber": "12345678",
            "bicSwift": "UOVBSGSG",
            "iban": null,
            "aba": null,
            "bsbCode": null,
            "sortCode": null,
            "institutionNo": null,
            "bankCode": null,
            "branchName": null,
            "branchCode": null,
            "cnaps": null,
            "clabe": null,
            "routingCode": null
        },
        "intermediaryBank": {
            "bankName": "Bank Name",
            "accountNumber": "87654321",
            "address": "Road 456",
            "bicSwift": "UOVBSGTS"
        }
    }
}

Creates a new beneficiary. The parameter requirements will depend on the beneficiary type (wallex/bank), entity type, currency, beneficiary country and bank country. Please call /beneficiaries/v1/requirements prior to this to know which parameters are required.

HTTP Request

POST /beneficiaries/v1/create

Body Parameters: Beneficiary

Parameter Description
onBehalfOfAccount
optional
string The account id that you acted on for this beneficiary
onBehalfOfUser
optional
string The user id that you acted on for this beneficiary
nickname
optional
string The nickname/alias of the beneficiary
email
optional
string The email of the beneficiary (for email notification purpose)
country
required
string The country of the beneficiary
entityType
required
string The entity type, e.g. company or individual

Possible Body Parameters: Beneficiary

Below parameters are from requirements object root property.

Parameter Description
city
conditional
string The city of the beneficiary, for beneficiaries in Indonesia please refer to the list here for valid city names
address
conditional
string The address of the beneficiary
postcode
conditional
string The postcode of the beneficiary
stateOrProvince
conditional
string The state/province of the beneficiary
firstName
conditional
string The first name of the beneficiary, needed for individual
lastName
conditional
string The last name of the beneficiary, needed for individual
companyName
conditional
string The company name of the beneficiary, needed for company
companyNameInChineseCharacters
conditional
string The company name of the beneficiary in chinese characters, needed for company
businessRegistration
conditional
string The company business registration number, needed for company. Change to identificationNumber
nationalIdentificationNumber
conditional
string The user national identification number, needed for individual. Change to identificationNumber
identificationType
conditional
string The user identification type, the complete list can be get from Identification Type
identificationNumber
conditional
string The user identification number respective to identificationType
region
conditional
string The region of the beneficiary, for beneficiaries in Indonesia please refer to the list here for valid region names
relationship
conditional
string The user relationship to beneficiary, please refer to the list here for valid relationship value

Body Parameters: Bank Account

Parameter Description
country
required
string The country of the bank
currency
required
string The currency of the bank account
bankName
required
string The beneficiary bank name
bankAccountHolderName
required
string The beneficiary bank account holder name

Possible Body Parameters: Bank Account

Below parameters are from requirements object bankAccount property.

Parameter Description
address
conditional
string The address of the beneficiary bank
accountNumber
conditional
string The bank account number
bankNameInChineseCharacters
conditional
string The beneficiary bank name in chinese characters
bankAccountHolderNameInChineseCharacters
conditional
string The beneficiary bank account holder name in chinese characters
bicSwift
conditional
string The BIC/SWIFT of the bank account
iban
conditional
string The IBAN of the bank account
cnaps
conditional
string The CNAPS of the bank account
clabe
conditional
string The CLABE of the bank account
aba
conditional
string The ABA of the bank account
sortCode
conditional
string The Sort code of the bank account
bsbCode
conditional
string The BSB code of the bank account
bankCode
conditional
string The bank code of the bank account
branchName
conditional
string The branch name of the bank account
branchCode
conditional
string The branch code of the bank account
institutionNo
conditional
string The institution number
ifscCode
conditional
string The routing code for local payments in India
routingCode
conditional
string The routing code of the bank account

Body Parameters: Intermediary Bank

if there’s a need to pass in intermediaryBank object please refer to the following parameters.

Parameter Description
bankName
optional
string The intermediary bank name
accountNumber
optional
string The intermediary bank account number
address
optional
string The address of the intermediary bank
bicSwift
optional
string The BIC/SWIFT Code of the intermediary bank

Retrieve a Beneficiary

Response:

{
    "data": {
        "address": "Road 321",
        "businessRegistration": "056790815678",
        "city": "Singapore",
        "companyName": "Wallex",
        "country": "SG",
        "email": "user@example.com",
        "entityType": "company",
        "beneficiaryId": "2ae51d82-b736-11e8-a999-0201da8d0509",
        "nationalIdentificationNumber": "098444416781",
        "nickname": "JOHN_SG",
        "region": null,
        "relationship": "NON_RELATED",
        "type": "bank",
        "bankAccount": {
            "bankName": "Bank Of Singapore",
            "address": "Road 123",
            "currency": "SGD",
            "country": "SG",
            "bankAccountHolderName": "John",
            "accountNumber": "12345678",
            "bicSwift": "UOVBSGSG",
            "iban": null,
            "aba": null,
            "bsbCode": null,
            "sortCode": null,
            "institutionNo": null,
            "bankCode": null,
            "branchName": null,
            "branchCode": null,
            "cnaps": null,
            "clabe": null
        },
        "intermediaryBank": {
            "bankName": "Bank Name",
            "accountNumber": "87654321",
            "address": null,
            "bicSwift": "UOVBSGTS"
        }
    }
}

Returns the specified beneficiary of the current user.

HTTP Request

GET /beneficiaries/v1/item/:beneficiaryId

Path Parameters

Parameter Description
beneficiaryId
required
string The ID of the beneficiary

Query Parameters

Parameter Description
onBehalfOfAccount
optional
string The account id that you acted on for this beneficiary
onBehalfOfUser
optional
string The user id that you acted on for this beneficiary

Delete a Beneficiary

Response:

{
    "data": {
        "address": "Road 321",
        "businessRegistration": "056790815678",
        "city": "Singapore",
        "companyName": "Wallex",
        "country": "SG",
        "email": "user@example.com",
        "entityType": "company",
        "beneficiaryId": "2ae51d82-b736-11e8-a999-0201da8d0509",
        "nationalIdentificationNumber": "098444416781",
        "nickname": "JOHN_SG",
        "region": null,
        "relationship": "NON_RELATED",
        "type": "bank",
        "bankAccount": {
            "bankName": "Bank Of Singapore",
            "address": "Road 123",
            "currency": "SGD",
            "country": "SG",
            "bankAccountHolderName": "John",
            "accountNumber": "12345678",
            "bicSwift": "UOVBSGSG",
            "iban": null,
            "aba": null,
            "bsbCode": null,
            "sortCode": null,
            "institutionNo": null,
            "bankCode": null,
            "branchName": null,
            "branchCode": null,
            "cnaps": null,
            "clabe": null
        },
        "intermediaryBank": {
            "bankName": "Bank Name",
            "accountNumber": "87654321",
            "address": null,
            "bicSwift": "UOVBSGTS"
        }
    }
}

Deletes the beneficiary and returns the specified beneficiary object for the last time.

HTTP Request

DELETE /beneficiaries/v1/item/:beneficiaryId

Path Parameters

Parameter Description
beneficiaryId
required
string The ID of the beneficiary

Query Parameters

Parameter Description
onBehalfOfAccount
optional
string The account id that you acted on for this beneficiary
onBehalfOfUser
optional
string The user id that you acted on for this beneficiary

Get All Beneficiaries

Request:

{
    "onBehalfOfAccount": "70f1722d-b997-44c2-a2e8-691c1090d1be"
}

Response:

{
    "data": [
        {
            "address": "Road 321",
            "businessRegistration": "056790815678",
            "city": "Singapore",
            "companyName": "Wallex",
            "country": "SG",
            "email": "user@example.com",
            "entityType": "company",
            "beneficiaryId": "2ae51d82-b736-11e8-a999-0201da8d0509",
            "nickname": "JOHN_SG",
            "region": null,
            "relationship": "NON_RELATED",
            "type": "bank",
            "bankAccount": {
                "bankName": "Bank Of Singapore",
                "address": "Road 123",
                "currency": "SGD",
                "country": "SG",
                "bankAccountHolderName": "John",
                "accountNumber": "12345678",
                "bicSwift": "UOVBSGSG",
                "iban": null,
                "aba": null,
                "bsbCode": null,
                "sortCode": null,
                "institutionNo": null,
                "bankCode": null,
                "branchName": null,
                "branchCode": null,
                "cnaps": null,
                "clabe": null
            }
        },
        {
            "address": "Road 321",
            "businessRegistration": "056790815678",
            "city": "Singapore",
            "companyName": "Wallex",
            "country": "SG",
            "email": "user@example.com",
            "entityType": "company",
            "beneficiaryId": "41111ab2-b738-11e8-a999-0201da8d0509",
            "nickname": "JOHN_SG",
            "region": null,
            "relationship": "NON_RELATED",
            "type": "bank",
            "paymentTypes": "priority",
            "bankAccount": {
                "bankName": "Bank Of Singapore",
                "address": "Road 123",
                "currency": "SGD",
                "country": "SG",
                "bankAccountHolderName": "John",
                "accountNumber": "12345678",
                "bicSwift": "UOVBSGSG",
                "iban": null,
                "aba": null,
                "bsbCode": null,
                "sortCode": null,
                "institutionNo": null,
                "bankCode": null,
                "branchName": null,
                "branchCode": null,
                "cnaps": null,
                "clabe": null
            },
            "intermediaryBank": {
                "bankName": "Bank Name",
                "accountNumber": "87654321",
                "address": null,
                "bicSwift": "UOVBSGTS"
            }
        }
    ]
}

Returns all the beneficiaries of the currency users, in an array of beneficiary objects.

HTTP Request

POST /beneficiaries/v1/find

Body Parameters

Parameter Description
onBehalfOfAccount
optional
string The account id that you acted on for this beneficiary
onBehalfOfUser
optional
string The user id that you acted on for this beneficiary

Identification Type

This listing can be used for identification type in payload

Identification Type Meaning
COMPANY_REGISTRATION_NUMBER Company / Business Registration Number
INTERNATIONAL_PASSPORT International Passport
NATIONAL_ID National ID
TAX_ID Tax ID

Currencies API

Rates: Retrieve Single Rates

This will provide you with one single currency pair and the respective rates that are supported by Wallex. These rates are refreshed every minute.

Response:

{
    "data": {
        "currencyPair": "IDRSGD",
        "bid": 0.000096,
        "ask": 0.000097
    }
}

HTTP Request

GET /currencies/v1/rates/:currencyPair

Path Parameters

Parameter Description
currencyPair
required
string The currency pair to retrieve, i.e. “IDRSGD”.

Currencies: Retrieve All Supported Currencies

This will provide you with all the currencies that are supported by Wallex.

Response:

{
    "data": [
        {
            "code": "AED",
            "decimalPlaces": 2,
            "name": "United Arab Emirates Dirham"
        },
        {
            "code": "AUD",
            "decimalPlaces": 2,
            "name": "Australian Dollar"
        }
    ]
}

HTTP Request

GET /currencies/v1/supported

Currencies: Supported Currency Pairs

This will provide you with all the currency pairs that are supported by Wallex.

Response:

[
    "AUDBDT",
    "AUDCAD",
    "AUDCHF",
    "AUDCNY",
    "AUDEUR",
    "AUDGBP",
    "AUDHKD",
    "AUDIDR",
    "AUDINR",
    "AUDJPY",
    "AUDKHR",
]

HTTP Request

GET /currencies/v1/pairs

Conversions API

Get a Conversion Quote

Get a quote/rates for a given currency pair, with specific amount and buy/sell side.

Request body:

{
    "onBehalfOfAccount": "70f1722d-b997-44c2-a2e8-691c1090d1be",
    "buyCurrency": "IDR",
    "sellCurrency": "SGD",
    "fixedSide": "buy",
    "amount": 1000
}

Response:

{
    "data": {
        "currencyPair": "SGDIDR",
        "buyCurrency": "IDR",
        "sellCurrency": "SGD",
        "buyAmount": 1000,
        "sellAmount": 0.1,
        "rate": 10876,
        "fixedSide": "buy",
        "totalAmount": 0.1,
        "quoteId": "319cbdea-611c-4054-bcc1-694cbcd2114a",
        "totalFees": 0
    }
}

HTTP Request

POST /conversions/v1/quote

Body Parameters

Parameter Description
onBehalfOfAccount
optional
string The account id that you acted on for this conversion
onBehalfOfUser
optional
string The user id that you acted on for this conversion
buyCurrency
required
string Your buy currency, i.e. “IDR”
sellCurrency
required
string Your sell currency, i.e. “SGD”
fixedSide
required
string Which side to fixed, “buy” or “sell”
amount
required
numberThe amount to convert, i.e. 1000

Response

Property Description
settlementCutOffTime
depreceated
string settlement cut off time
currencyPair string currency pair
buyCurrency string conversion buy currency
sellCurrency string conversion sell currency
buyAmount number buy amount
sellAmount number sell amount
rate number rate
fixedSide string fixed side
totalFees number fee amount
totalAmount number total amount
quoteId string quote id

Create a Conversion

Request body:

{
    "onBehalfOfAccount": "70f1722d-b997-44c2-a2e8-691c1090d1be",
    "quoteId": "319cbdea-611c-4054-bcc1-694cbcd2114a",
    "referenceId": "X-123",
    "uniqueReferenceId": true
}

Response:

{
    "data": {
        "conversionId": "137d4263-5ad7-4d94-9ab3-cd6c98f9b680",
        "referenceId": "X-123",
        "status": "completed",
        "currencyPair": "SGDIDR",
        "buyCurrency": "IDR",
        "sellCurrency": "SGD",
        "fixedSide": "buy",
        "buyAmount": 1000,
        "sellAmount": 0.1,
        "totalAmount": 0.1,
        "rate": 10876,
        "createdAt": "2018-09-20T03:23:23Z",
        "totalFees": 0,
        "fundingCutoffTime": "2018-09-20T15:23:23Z"
    }
}

Creates a conversion.

HTTP Request

POST /conversions/v1/create

Body Parameters

Parameter Description
onBehalfOfAccount
optional
string The account id that you acted on for this conversion
onBehalfOfUser
optional
string The user id that you acted on for this conversion
quoteId
required
string The quote Id from /quote endpoint
referenceId
optional
string Identifier / description of the transaction in your system
uniqueReferenceId
optional
boolean Check unique identifier / description of the transaction in your system

Response

Property Description
id
depreceated
string conversion id. Change to conversionId
conversionId string conversion id
username
depreceated
string conversion user name
conversionDate
depreceated
string conversion date
referenceId string reference id
status string conversion status
currencyPair string The currency pair to retrieve, i.e. “IDRSGD”.
buyCurrency string conversion buy currency
sellCurrency string conversion sell currency
fixedSide string fixed side
buyAmount number buy amount
sellAmount number sell amount
totalAmount number total amount
rate number conversion rate
createdAt string date the conversion created
totalFees number fee amount
fundingCutoffTime string date the funding cut off time

Listing Conversions

Request body:

{
    "onBehalfOfAccount": "70f1722d-b997-44c2-a2e8-691c1090d1be",
    "startDate": "2019-05-07T08:59:49Z",
    "endDate": "2021-06-07T08:59:49Z",
    "referenceId": "X-123"
}

Response body:

{
    "data": [
        {
            "conversionId": "47bcb20f-56ad-4b38-a897-a9e300ff7840",
            "referenceId": "X-123",
            "status": "awaiting_funds",
            "currencyPair": "EURSGD",
            "buyCurrency": "EUR",
            "sellCurrency": "SGD",
            "fixedSide": "buy",
            "buyAmount": 1000,
            "sellAmount": 0.1,
            "totalAmount": 0.1,
            "rate": 10876,
            "createdAt": "2018-12-20T16:31:44Z",
            "totalFees": 0,
            "fundingCutoffTime": "2018-12-21T04:31:44Z"
        },
        {
            "conversionId": "1dcc1524-bf27-4916-8c90-c4a1b15ec879",
            "referenceId": "X-123",
            "status": "completed",
            "currencyPair": "EURSGD",
            "buyCurrency": "EUR",
            "sellCurrency": "SGD",
            "fixedSide": "buy",
            "buyAmount": 1000,
            "sellAmount": 0.1,
            "totalAmount": 0.1,
            "rate": 10876,
            "createdAt": "2018-12-20T16:31:44Z",
            "totalFees": 0,
            "fundingCutoffTime": "2018-12-21T04:31:44Z"
        }
    ]
}

HTTP Request

POST /conversions/v1/find

Body Parameters

Parameter Description
onBehalfOfAccount
optional
string The account id that you acted on for this conversion
onBehalfOfUser
optional
string The user id that you acted on for this conversion
startDate
optional
string filtering records greater than or equal to startDate
example: 2019-05-07T08:59:49Z
this dates is treated as UTC time
endDate
optional
string filtering records less than endDate
example: 2019-05-07T08:59:49Z
this dates is treated as UTC time
referenceId
optional
string filtering records by referenceId

Response

Property Description
id
depreceated
string conversion id. Change to conversionId
conversionId string conversion id
username
depreceated
string conversion user name
conversionDate
depreceated
string conversion date
referenceId string reference id
status string conversion status
currencyPair string The currency pair to retrieve, i.e. “IDRSGD”.
buyCurrency string conversion buy currency
sellCurrency string conversion sell currency
fixedSide string fixed side
buyAmount number buy amount
sellAmount number sell amount
totalAmount number total amount
rate number conversion rate
createdAt string date the conversion created
totalFees number fee amount
fundingCutoffTime string date the funding cut off time

Retrieve a Conversion

Response body:

{
    "data": {
        "conversionId": "137d4263-5ad7-4d94-9ab3-cd6c98f9b680",
        "referenceId": "X-123",
        "status": "completed",
        "currencyPair": "SGDIDR",
        "buyCurrency": "IDR",
        "sellCurrency": "SGD",
        "fixedSide": "buy",
        "buyAmount": 1000,
        "sellAmount": 0.1,
        "totalAmount": 0.1,
        "rate": 10876,
        "createdAt": "2018-09-20T03:23:23Z",
        "totalFees": 0,
        "fundingCutoffTime": "2018-09-20T15:23:23Z"
    }
}

HTTP Request

get /conversions/v1/item/:conversionId

Path Parameters

Parameter Description
conversionId
required
string The ID of the conversion

Query Parameters

Parameter Description
onBehalfOfAccount
optional
string The account id that you acted on for this conversion
onBehalfOfUser
optional
string The user id that you acted on for this conversion

Response

Property Description
id
depreceated
string conversion id. Change to conversionId
conversionId string conversion id
username
depreceated
string conversion user name
conversionDate
depreceated
string conversion date
referenceId string reference id
status string conversion status
currencyPair string The currency pair to retrieve, i.e. “IDRSGD”.
buyCurrency string conversion buy currency
sellCurrency string conversion sell currency
fixedSide string fixed side
buyAmount number buy amount
sellAmount number sell amount
totalAmount number total amount
rate number conversion rate
createdAt string date the conversion created
totalFees number fee amount
fundingCutoffTime string date the funding cut off time

Conversion Fund

Request:

{
    "conversionId": "137d4263-5ad7-4d94-9ab3-cd6c98f9b680",
    "onBehalfOfAccount": "70f1722d-b997-44c2-a2e8-691c1090d1be"
}

Response:

{
    "data": {
        "conversionId": "137d4263-5ad7-4d94-9ab3-cd6c98f9b680",
        "referenceId": "X-123",
        "status": "awaiting_funds",
        "currencyPair": "SGDIDR",
        "buyCurrency": "IDR",
        "sellCurrency": "SGD",
        "fixedSide": "buy",
        "buyAmount": 1000,
        "sellAmount": 0.1,
        "totalAmount": 0.1,
        "rate": 10876,
        "createdAt": "2018-09-20T03:23:23Z",
        "totalFees": 0,
        "fundingCutoffTime": "2018-09-20T15:23:23Z"
    }
}

Fund the conversion using balance available on your Wallex wallet

HTTP Request

POST /conversions/v1/fund

Body Parameters

Property Description
conversionId string The ID of the conversion
onBehalfOfAccount
optional
string The account id that you acted on for this conversion
onBehalfOfUser
optional
string The user id that you acted on for this conversion

Response

Property Description
id
depreceated
string conversion id. Change to conversionId
conversionId string conversion id
username
depreceated
string conversion user name
conversionDate
depreceated
string conversion date
referenceId string reference id
status string conversion status
currencyPair string The currency pair to retrieve, i.e. “IDRSGD”.
buyCurrency string conversion buy currency
sellCurrency string conversion sell currency
fixedSide string fixed side
buyAmount number buy amount
sellAmount number sell amount
totalAmount number total amount
rate number conversion rate
createdAt string date the conversion created
totalFees number fee amount
fundingCutoffTime string date the funding cut off time

Conversion Status Notification

Update your conversion status when the requirements are met or unmet

Payload:

{
    "resource": "conversion",
    "status": "completed",
    "resourceId": "e26fda80-c845-11e8-8910-8541dfd4ff96"
}

Payload

Property Description
resource string The resource of conversion
resourceId string The ID of resource
status string The status of conversion

Status values:

Simple Payments API

Supported Local Payments Currencies

Get list of supported local currencies, the array values is a combination from currency and beneficiary receiver country. AUD-AU means Australian Dollar for Australian beneficiaries

Response:

{
    "data": [
        "AUD-AU",
        "CAD-CA",
        "CZK-CZ",
        "DKK-DK",
        "EUR-FI",
        "EUR-AT",
        "EUR-PT",
        "EUR-BE"
    ]
}

HTTP Request

GET /simple-payments/v1/supported-local-currencies

Get a Simple Payment Quote

Get a quote/rates for a simple payment with given currency pair, and amount. If beneficiary ID is provided, charges will be calculated accordingly.

Request body:

{
    "onBehalfOfAccount": "70f1722d-b997-44c2-a2e8-691c1090d1be",
    "beneficiaryId": "c66c34d7-9212-4ca9-9195-4beb4c360a2d",
    "sellCurrency": "USD",
    "buyCurrency": "SGD",
    "amount": 1000,
    "partner": {
        "fee": 2,
        "markup": 0.01
    },
    "paymentChannel": "SWIFT-OUR"
}

Response:

{
    "data": {
        "currencyPair": "USDSGD",
        "buyCurrency": "SGD",
        "sellCurrency": "USD",
        "buyAmount": 1000,
        "sellAmount": 781.92,
        "fixedSide": "buy",
        "rate": 1.2789,
        "beneficiaryId": "ccb11375-91b8-46c5-8685-ede6781028bd",
        "partnerRate": "1.2918",
        "partnerBuyAmount": "1000",
        "partnerSellAmount": "774.11",
        "partnerPaymentFee": 3,
        "expiresAt": "2020-08-24T03:46:14Z",
        "quoteId": "e0399f4c-a42d-493c-a04d-c3ca71c86395",
        "conversionFee": 7.82,
        "paymentFee": 2,
        "totalFee": 9.82,
        "totalAmount": 794.74,
        "paymentChannel": "OUR",
        "bankCharges": 2,
        "supportingDocumentsRequired": false
    }
}

HTTP Request

POST /simple-payments/v1/quote

Body Parameters

Parameter Description
onBehalfOfAccount
optional
string The account id that you acted on for this payment
onBehalfOfUser
optional
string The user id that you acted on for this payment
beneficiaryId
required
string or null the beneficiary id to do simple payment later in the simple payment request
beneficiaryId used here must match the simple payment request using this quote.
sellCurrency
required
string Your sell currency, i.e. “SGD”
buyCurrency
required
string Your buy currency, i.e. “IDR”
amount
required
number The amount to pay, i.e. 1000.
fixedSide
optional
string which side of currency your amount we should keep. we will calculate the other side (default as sell if not present)
partner
optional
Object of fee and markup which used to add custom partner fee and markup, if not set, will find into custom partner fee and markup configuration for certain partner.

This params or fee/markup configuration only applied to ultimate partner

the fee value unit is following sellCurrency example: fee 2 means 2 SGD if sellCurrency SGD

the markup value is in pecentage unit
paymentChannel
optional
string possible values are LOCAL, SWIFT-SHA, SWIFT-OUR. if not set, then channel will be decided by Wallex
includeFee
optional
boolean Indicates if include fee for calculate totalAmount (default as true if not present)

Response

Property Description
currencyPair string The currency pair
buyCurrency string The client buy currency
sellCurrency string The client sell currency
buyAmount number The client buy amount
sellAmount number The client sell amount
fixedSide string The fixed side
rate number The client rate
beneficiaryId string The ID of the beneficiary
partnerRate number This field has value consist clientRate added with markup value from partner params or from markup configuration
partnerBuyAmount number When fixed side is buy, the value will be same with clientBuyAmount

When fixed side is sell, the value will higher than clientBuyAmount
partnerSellAmount number When fixed side is sell, the value will be same with clientSellAmount

When fixed side is buy, the value will be lower than clientSellAmount
partnerPaymentFee number This field has value that reflected to partner profit or value that wallex need to charge to partner
midMarketRate
depreceated
number The mid market rate
feeRate
depreceated
number The wallex fee rate
expiresAt string The maximum time for this quote is available to use
quoteId string The quote ID
conversionFee number The conversion fee
conversionFeeRate
depreceated
number The conversion fee rate
paymentFee number The payment fee
totalFee number Total fee
paymentFeeRate
depreceated
number The payment fee rate
totalFeeRate
depreceated
number The total fee rate
totalAmount number Total amount
paymentChannel string The payment channel
bankCharges number Bank charges amount (applied if using SWIFT-OUR), calculated in sellCurrency
conversionDate
depreceated
string The conversion date
setlementCutOffTime
depreceated
string The settlement cut off time
supportingDocumentsRequired boolean Indicates if supporting documents are required or not for the transaction

Request Upload URL

To request an url for uploading files to simple payment

HTTP Request

POST /simple-payments/v1/get-upload-url

Request body:

{
    "fileName": "invoice.pdf",
    "contentLength": 12000,
    "contentType": "application/pdf"
}

Response:

{
    "data": {
        "uploadUrl": "https://wallex-files-dev.s3.ap-southeast-1.amazonaws.com/wallex/1/a7a11768-303f-4e56-934c-c53e649603f8/invoice.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=ASIA36PECD57ZT7DNHHK%2F20190402%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20190402T100353Z&X-Amz-Expires=900&X-Amz-Security-Token=FQoGZXIvYXdzEPf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDE0YbCXMucNWNffJ5yL3ASrrrUZQ%2Fd5nPtKHaaF%2FSJj%2FzcKiFo7JU9qAwKz928gZnneBSTIR1E6ekaMCVHobYurQI7B2lo6UflYfciFUmAiUd%2B1hX0hwFpOqsWASpYBgXOtb52uq8wfU%2BSkzmGPAxk%2BEOLQzqOxV%2BQ9K9S3NhBAqzgotivrS9lmhkP4AK7PAD7P5Du1aX%2BB0YwXt0DZ3TF3OJFeWk2FsMkcnKLey2h6DxgJ18fi6N60uakX6zF1hC4GjQ44wAkjgvtgEmc7OsEfACC2ZewxXa2x2%2F6TRxmBxipM4e2vkQl%2BWsCsaYQVrnNguVW%2F6M2u59ywxFJeO3vF1K%2FrkVkAohOqL5QU%3D&X-Amz-SignedHeaders=host%3Bx-amz-storage-class&X-Amz-Signature=5619defcde541c696e153c40da7f0509219d98ff9308054e9e5fd04054697710",
        "fileId": "a7a11768-303f-4e56-934c-c53e649603f8"
    }
}

Body Parameters

Parameter Description
fileName
required
string File name to be uploaded
contentType
optional
string MIME type of file name to be uploaded
contentLength
optional
number File size in bytes (Maximum size 10 Mb)

Response

Property Description
uploadUrl string The URL of uploaded file
fileId string The ID of uploaded file

File upload

To upload the files using url generated from wallex please follow this configuration.

HTTP Request

PUT https://urlgeneratedfromwallex.com

Header Value
x-amz-storage-class
required
string STANDARD
Content-Type
required
string MIME type of the file to be uploaded, e.g. application/pdf, image/png, image/jpeg, etc.

Body

the file need to be uploaded directly as binary

Create a Simple Payment

Request body:

{
    "onBehalfOfAccount": "70f1722d-b997-44c2-a2e8-691c1090d1be",
    "fundingSource": "SALARY_WAGES",
    "paymentReference": "Payment Reference",
    "quoteId": "5595393c-9294-4a60-a1e7-97fb4981b9a3",
    "purposeOfTransfer": "OTH",
    "purposeOfTransferDescription": "Your own custom purpose",
    "files": [
        "d37673e3-341f-453f-9fa9-521e4ba21c2d",
    ],
    "referenceId": "PFEE TEST",
    "uniqueReferenceId": true
}

Response:

{
    "data": {
        "simplePaymentId": "3909da4e-26c4-4b31-924f-f9c8b4f471a4",
        "totalAmount": 1010,
        "status": "awaiting_funds",
        "buyAmount": 5049.97,
        "buyCurrency": "CNY",
        "sellAmount": 1005.15,
        "sellCurrency": "SGD",
        "currencyPair": "SGDCNY",
        "fixedSide": "buy",
        "rate": 5.0241,
        "totalFee": 4.85,
        "createdAt": "2020-09-01T07:38:27Z",
        "completedAt": null,
        "reference": "200901-SIM-3909DA4E",
        "referenceId": "PFEE TEST",
        "paymentReference": "DWMW003067",
        "failureReason": null,
        "fundingSource": "SALARY_WAGES",
        "purposeOfTransfer": "GDDS",
        "beneficiary": {
            "address": "Road 321",
            "city": "Singapore",
            "country": "SG",
            "email": "user@example.com",
            "firstName": null,
            "beneficiaryId": "ccb11375-91b8-46c5-8685-ede6781028bd",
            "lastName": null,
            "nickname": "JOHN_SG",
            "type": "bank",
            "bankAccount": {
                "accountNumber": "987654321",
                "bankAccountHolderName": "John",
                "bicSwift": "UOVBSGSG",
                "country": "SG",
                "currency": "SGD"
            }
        },
        "fundingReference": "K4XRJK",
        "fundingCutoffTime": "2020-09-01T19:38:27Z"
    }
}

Creates a new simple payment. Please call /simple-payments/v1/quote prior to this call to get the quote ID.

HTTP Request

POST /simple-payments/v1/create

Body Parameters

Parameter Description
onBehalfOfAccount
optional
string The account id that you acted on for this payment
onBehalfOfUser
optional
string The user id that you acted on for this payment
fundingSource
required
string The source of funding, the complete list can be get from Funding Source
paymentReference
required
string The reference for the payment
quoteId
required
string The quote Id from /quote endpoint
purposeOfTransfer
required
string The purpose of transfer, the complete list can be get from Purpose of Transfer
purposeOfTransferDescription
optional
string Additional info of purpose code
files
conditional
array Array of file id to be included in the simple payment, files are required if supportingDocumentsRequired is true when getting Simple Payment Quote
referenceId
optional
string Identifier / description of the transaction in your system
uniqueReferenceId
optional
boolean Check unique identifier / description of the transaction in your system
senderUserId
optional
string The sender user id for this payment
fundingMethod
optional
string Available values:
- BANK_TRANSFER
- PAYNOW
fundingBankAccountNumber
optional
string Numeric value only,
Only required when fundingMethod is BANK_TRANSFER
fundingCountry
optional
string Country to fund the simple payment, required for Indonesia beneficiary

Response

Property Description
simplePaymentId string The ID of simple payment
totalAmount number The amount of payment
status string The status of payment
buyAmount number Amount of buy
buyCurrency string The buy currency
sellAmount number Amount of sell
sellCurrency string The sell currency
currencyPair string The currency pair of payment
fixedSide string The fixed side
rate number The client rate of payment
totalFee number Total fee
beneficiaryName
depreceated
string The beneficiary name
createdAt string The date simple payment created
completedAt string The date simple payment completed
settlementDate
depreceated
string The date simple payment settled
reference string The reference of simple payment
referenceId string reference id
paymentReference string The payment reference
paymentDate
depreceated
string The payment date
failureReason string The failure reason
fundingSource string The source of funding
purposeOfTransfer string The purpose of transaction
beneficiary object The beneficiary info
fundingReference string 6 digit code for your reference to fund the simple payment
fundingCutoffTime string Date the funding cut off time
fundingCountry string Country to fund the simple payment

Retrieve a Simple Payment

Response:

{
    "data": {
        "simplePaymentId": "3909da4e-26c4-4b31-924f-f9c8b4f471a4",
        "totalAmount": 1010,
        "status": "awaiting_funds",
        "buyAmount": 5049.97,
        "buyCurrency": "CNY",
        "sellAmount": 1005.15,
        "sellCurrency": "SGD",
        "currencyPair": "SGDCNY",
        "fixedSide": "buy",
        "rate": 5.0241,
        "totalFee": 4.85,
        "createdAt": "2020-09-01T07:38:27Z",
        "completedAt": null,
        "reference": "200901-SIM-3909DA4E",
        "referenceId": "PFEE TEST",
        "paymentReference": "DWMW003067",
        "failureReason": null,
        "fundingSource": "SALARY_WAGES",
        "purposeOfTransfer": "GDDS",
        "beneficiary": {
            "address": "Road 321",
            "city": "Singapore",
            "country": "SG",
            "email": "user@example.com",
            "firstName": null,
            "beneficiaryId": "ccb11375-91b8-46c5-8685-ede6781028bd",
            "lastName": null,
            "nickname": "JOHN_SG",
            "type": "bank",
            "bankAccount": {
                "accountNumber": "987654321",
                "bankAccountHolderName": "John",
                "bicSwift": "UOVBSGSG",
                "country": "SG",
                "currency": "SGD"
            }
        },
        "fundingReference": "K4XRJK",
        "fundingCutoffTime": "2020-09-01T19:38:27Z"
    }
}

Returns the specified simple payment of the current user.

HTTP Request

GET /simple-payments/v1/item/:simplePaymentId

Path Parameters

Parameter Description
simplePaymentId
required
string The ID of the simple payment

Query Parameters

Property Description
onBehalfOfAccount
optional
string The account id that you acted on for this payment
onBehalfOfUser
optional
string The user id that you acted on for this payment

Response

Property Description
simplePaymentId string The ID of simple payment
totalAmount number The amount of payment
status string The status of payment
buyAmount number Amount of buy
buyCurrency string The buy currency
sellAmount number Amount of sell
sellCurrency string The sell currency
currencyPair string The currency pair of payment
fixedSide string The fixed side
rate number The client rate of payment
totalFee number Total fee
beneficiaryName
depreceated
string The beneficiary name
createdAt string The date simple payment created
completedAt string The date simple payment completed
settlementDate
depreceated
string The date simple payment settled
reference string The reference of simple payment
referenceId string reference id
paymentReference string The payment reference
paymentDate
depreceated
string The payment date
failureReason string The failure reason
fundingSource string The source of funding
purposeOfTransfer string The purpose of transaction
beneficiary object The beneficiary info
fundingReference string 6 digit code for your reference to fund the simple payment
fundingCutoffTime string date the funding cut off time

Get All Simple Payments

Request:

{
    "onBehalfOfAccount": "70f1722d-b997-44c2-a2e8-691c1090d1be",
    "startDate": "2019-05-07T08:59:49Z",
    "endDate": "2021-06-07T08:59:49Z",
    "referenceId": "X-123",
    "status": [
      "awaiting_funds"
    ]
}

Response:

{
    "data": [
        {
            "simplePaymentId": "a510e853-b7dd-11e8-a999-0201da8d0509",
            "totalAmount": 3202.09,
            "status": "awaiting_funds",
            "buyAmount": 2000,
            "buyCurrency": "EUR",
            "sellAmount": 3185.8,
            "sellCurrency": "SGD",
            "currencyPair": "EURSGD",
            "fixedSide": "buy",
            "rate": 1.5929,
            "totalFee": 16.29,
            "createdAt": "2018-08-31T15:30:23Z",
            "completedAt": null,
            "reference": "180831-SIM-C6D59BD1",
            "referenceId": "X-123",
            "paymentReference": "Payemnt Reference",
            "failureReason": null,
            "fundingSource": "SALARY_WAGES",
            "purposeOfTransfer": "GDDS",
            "beneficiary": {
                "address": "Road 321",
                "city": "Singapore",
                "country": "SG",
                "email": "user@example.com",
                "firstName": null,
                "beneficiaryId": "ccb11375-91b8-46c5-8685-ede6781028bd",
                "lastName": null,
                "nickname": "JOHN_SG",
                "type": "bank",
                "bankAccount": {
                    "accountNumber": "987654321",
                    "bankAccountHolderName": "John",
                    "bicSwift": "UOVBSGSG",
                    "country": "SG",
                    "currency": "SGD"
                }
            },
            "fundingReference": "F3UBY8",
            "fundingCutoffTime": "2018-09-01T03:30:23Z"
        },
        {
            "simplePaymentId": "a510e853-b7dd-11e8-a999-0201da8d0509",
            "totalAmount": 3202.09,
            "status": "awaiting_funds",
            "buyAmount": 2000,
            "buyCurrency": "EUR",
            "sellAmount": 3185.8,
            "sellCurrency": "SGD",
            "currencyPair": "EURSGD",
            "fixedSide": "buy",
            "rate": 1.5929,
            "totalFee": 16.29,
            "createdAt": "2018-08-31T15:30:23Z",
            "completedAt": null,
            "reference": "180831-SIM-C6D59BD1",
            "referenceId": "X-123",
            "paymentReference": "Payemnt Reference",
            "failureReason": null,
            "fundingSource": "SALARY_WAGES",
            "purposeOfTransfer": "GDDS",
            "beneficiary": {
                "address": "Road 321",
                "city": "Singapore",
                "country": "SG",
                "email": "user@example.com",
                "firstName": null,
                "beneficiaryId": "ccb11375-91b8-46c5-8685-ede6781028bd",
                "lastName": null,
                "nickname": "JOHN_SG",
                "type": "bank",
                "bankAccount": {
                    "accountNumber": "987654321",
                    "bankAccountHolderName": "John",
                    "bicSwift": "UOVBSGSG",
                    "country": "SG",
                    "currency": "SGD"
                }
            },
            "fundingReference": "F3UBY8",
            "fundingCutoffTime": "2018-09-01T03:30:23Z"
        }
    ]
}

Returns all the simple payments of the currency users, in an array of simple payment objects.

HTTP Request

POST /simple-payments/v1/find

Body Parameters

Parameter Description
onBehalfOfAccount
optional
string The account id that you acted on for this payment
onBehalfOfUser
optional
string The user id that you acted on for this payment
startDate
optional
string filtering records greater than or equal to startDate
example: 2019-05-07T08:59:49Z
this dates is treated as UTC time
endDate
optional
string filtering records less than endDate
example: 2019-05-07T08:59:49Z
this dates is treated as UTC time
referenceId
optional
string filtering records by referenceId
status
optional
array filtering records by status.
available value: awaiting_funds, processing, completed, rejected, failed

Response

Property Description
data array Array of simple payments
simplePaymentId string The ID of simple payment
totalAmount number The amount of payment
status string The status of payment
buyAmount number Amount of buy
buyCurrency string The buy currency
sellAmount number Amount of sell
sellCurrency string The sell currency
currencyPair string The currency pair of payment
fixedSide string The fixed side
rate number The client rate of payment
totalFee number Total fee
beneficiaryName
depreceated
string The beneficiary name
createdAt string The date simple payment created
completedAt string The date simple payment completed
settlementDate
depreceated
string The date simple payment settled
reference string The reference of simple payment
referenceId string reference id
paymentReference string The payment reference
paymentDate
depreceated
string The payment date
failureReason string The failure reason
fundingSource string The source of funding
purposeOfTransfer string The purpose of transaction
beneficiary object The beneficiary info
fundingReference string 6 digit code for your reference to fund the simple payment
fundingCutoffTime string date the funding cut off time

Simple Payment Fund

Request:

{
    "simplePaymentId": "48c2c36a-d193-450f-9228-a2b425c6ca20",
    "onBehalfOfAccount": "70f1722d-b997-44c2-a2e8-691c1090d1be"
}

Response:

{
    "data": {
        "simplePaymentId": "a510e853-b7dd-11e8-a999-0201da8d0509",
        "totalAmount": 0.1,
        "status": "processing",
        "buyAmount": 1000,
        "buyCurrency": "IDR",
        "sellAmount": 0.1,
        "sellCurrency": "SGD",
        "currencyPair": "SGDIDR",
        "fixedSide": "buy",
        "rate": 10898,
        "totalFee": 0,
        "createdAt": "2018-09-25T00:36:17Z",
        "completedAt": null,
        "reference": "180925-SIM-03D82001",
        "referenceId": "X-123",
        "paymentReference": "Payment Reference",
        "failureReason": null,
        "fundingSource": "SALARY_WAGES",
        "purposeOfTransfer": "GDDS",
        "beneficiary": {
            "address": "Road 321",
            "city": "Singapore",
            "country": "SG",
            "email": "user@example.com",
            "firstName": null,
            "beneficiaryId": "ccb11375-91b8-46c5-8685-ede6781028bd",
            "lastName": null,
            "nickname": "JOHN_SG",
            "type": "bank",
            "bankAccount": {
                "accountNumber": "987654321",
                "bankAccountHolderName": "John",
                "bicSwift": "UOVBSGSG",
                "country": "SG",
                "currency": "SGD"
            }
        },
        "fundingReference": "F3UBY8",
        "fundingCutoffTime": "2018-09-25T12:36:17Z"
    }
}

Fund the simple payment using balance available on your Wallex wallet

HTTP Request

POST /simple-payments/v1/fund

Body Parameters

Property Description
simplePaymentId string id of simple payments to be funded

Query Parameters

Property Description
onBehalfOfAccount
optional
string The account id that you acted on for this payment
onBehalfOfUser
optional
string The user id that you acted on for this payment

Response

Property Description
simplePaymentId string The ID of simple payment
totalAmount number The amount of payment
status string The status of payment
buyAmount number Amount of buy
buyCurrency string The buy currency
sellAmount number Amount of sell
sellCurrency string The sell currency
currencyPair string The currency pair of payment
fixedSide string The fixed side
rate number The client rate of payment
totalFee number Total fee
beneficiaryName
depreceated
string The beneficiary name
createdAt string The date simple payment created
completedAt string The date simple payment completed
settlementDate
depreceated
string The date simple payment settled
reference string The reference of simple payment
referenceId string reference id
paymentReference string The payment reference
paymentDate
depreceated
string The payment date
failureReason string The failure reason
fundingSource string The source of funding
purposeOfTransfer string The purpose of transaction
beneficiary object The beneficiary info
fundingReference string 6 digit code for your reference to fund the simple payment
fundingCutoffTime string date the funding cut off time

Retrieve Proof of Payment Document

Response:

{
  "data": [
    {
      "documentType": "invoice",
      "url": "https://urlgeneratedfromwallex.com"
    },
    {
      "documentType": "mt103",
      "url": "https://urlgeneratedfromwallex.com"
    },
    {
      "documentType": "payment-confirmation",
      "url": "https://urlgeneratedfromwallex.com"
    }
  ]
}

Call this API to retrieve the proof of a completed payment in the form of an invoice, mt103 and payment-confirmation document .

HTTP Request

GET /simple-payments/v1/item/:simplePaymentId/get-proof-of-payment

Path Parameters

Parameter Description
simplePaymentId
required
string The id of the simple payment

Query Parameters

Parameter Description
onBehalfOfAccount
optional
string The account id that you acted on for this payment
onBehalfOfUser
optional
string The user id that you acted on for this payment
documentType
optional
string The type of the document. Possible values: invoice, mt103, payment-confirmation

Response

Property Description
documentType string The type of the document
url string The URL to download the document file. The URL is valid only for 5 minutes.

Funding Source

This listing can be used for funding source in payload

Funding Source Meaning
SALARY_WAGES Salary Wages
INVESTMENTS Invesments
PERSONAL_SAVINGS Personal Savings
PERSONAL_WEALTH Personal Wealth
RETIREMENT_FUNDS Retirement Funds
FAMILY_FRIEND_CO_WORKER Family , Friend and Co-worker
BUSINESS_OWNER_OR_SHAREHOLDER Business Owner or Shareholder
LOAN_FACILITY Loan Facility
COMPANY_BANK_ACCOUNT Company Bank Account
THIRD_PARTY Third Party
PERSONAL_ACCOUNT Personal Account
OTHER Other

Purpose of Transfer

This listing can be used for purpose of transfer in payload

Code Name Description
ADCS
depreceated
Advisory Donation Copyright Services Payments for donation, sponsorship, advisory, intellectual and other copyright services.
ADVA Advance Payment Transaction is an advance payment.
AGRT Agricultural Transfer Transaction is related to the agricultural domain.
ALLW Allowance Transaction is the payment of allowances.
ALMY Alimony Payment Transaction is the payment of alimony.
BEXP Business Expenses Transaction is related to a payment of business expenses.
BONU Bonus Payment Transaction is related to payment of a bonus.
CAFI Custodian Management fee In-house Transaction is related to custodian management fee In-house.
CFEE Cancellation Fee Transaction is related to a payment of cancellation fee.
CHAR Charity Payment Transaction is a payment for charity reasons.
COMM Commission Transaction is payment of commission.
CSLP Company Social Loan Payment To Bank Transaction is a payment by a company to a bank for financing social loans to employees.
DIVD Dividend Transaction is payment of dividends.
EDUC Education Transaction is related to a payment of study/tuition fees.
FCPM Late Payment of Fees & Charges Transaction is late payment of fees & charges.
FEES
depreceated
Payment of Fees Payment of fees/charges.
GDDS Purchase Sale Of Goods Transaction is related to purchase and sale of goods.
GOVT Government Payment Transaction is a payment to or from a government department.
HREC Housing Related Contribution Transaction is a contribution by an employer to the housing expenditures (purchase, construction, renovation) of the employees within a tax free fringe benefit system.
INTC Intra Company Payment Transaction is an intra-company payment, ie, a payment between two companies belonging to the same group.
IVPT
depreceated
Invoice Payment Transaction is the payment for invoices.
INVS Investment & Securities Transaction is a payment for investment & securities.
LFEE Lending Fees Transaction is a payment for lending fees.
LICF License Fee Transaction is a payment for license fees.
LOAN Loan Transaction is related to transfer of loan to borrower.
LOAR Loan Repayment Transaction is related to repayment of loan to lender.
MAFC Medical Aid Fund Contribution Transaction is contribution to medical aid fund.
MDCS Medical Services Transaction is a payment for medical care services.
OFEE Opening Fee Transaction is a payment for opening fees.
OTHR
depreceated
Other Other payment purpose.
PAYR Payroll Transaction is related to the payment of payroll.
RELG Rental Lease General Transaction is for general rental/lease.
RENT Rent Transaction is related to rent.
RINP Recurring Installment Payment Transaction is related to a payment of a recurring installment made at regular intervals.
SAVG Savings Transfer to savings/retirement account.
SCVE Purchase Sale Of Services Transaction is related to purchase and sale of services.
SERV Service Charges Transaction is related to service charges charged by a service provider.
SUBS Subscription Transaction is related to a payment of information or entertainment services either in printed or electronic form.
SUPP Supplier Payment Transaction is related to a payment to a supplier.
TAXS Tax Payment Transaction is the payment of taxes.
UBIL Utilities Transaction is for the payment to common utility provider that provide gas, water and/or electricity.
VIEW Vision Care Transaction is a payment for vision care services.
WX01 Family Support/Living Expenses Transaction is a payment for family support / living expenses.
WX04 Friends Transaction is a payment for friends.
WX05 Travel Expenses Transaction is related to a payment of travel expenses.
WX07 Advertising Services Transaction is related to a payment of advertising service.
WX08 Legal fees Transaction is related to a payment of legal fees.
WX09 Expenses Reimbursements Transaction is related to a payment of expenses reimbursements.
WX11 Bank Loan Fees Transaction is related to a payment of Bank Loan Fees.
WX12 Inter Company Payment Transaction is a payment for inter company.
WX13 Invoice Payment - Goods Transaction is the payment for goods invoices.
WX14 Invoice Payment - Services Transaction is the payment for services invoices.

Simple Payment Status Notification

Update your payment status when the requirements are met or unmet

Payload:

{
    "resource": "simple_payment",
    "status": "processing",
    "resourceId": "e26fda80-c845-11e8-8910-8541dfd4ff96",
    "reason": null
}

Payload

Property Description
resource string The resource of payments
resourceId string The ID of resource
status string The status of payment
reason string The reason of rejected and failed status

Status values:

Balances API

Get All Balances

Request:

{
    "onBehalfOfAccount": "70f1722d-b997-44c2-a2e8-691c1090d1be"
}

Response:

{
    "data": [
        {
            "id": "2fcb0f63-1d31-11e9-9f08-06655537f802",
            "amount": 0,
            "currency": "SGD",
            "currencyName": "Singapore Dollar"
        },
        {
            "id": "2fcbe920-1d31-11e9-9f08-06655537f802",
            "amount": 100,
            "currency": "USD",
            "currencyName": "US Dollar"
        },
        {
            "id": "2fccb0da-1d31-11e9-9f08-06655537f802",
            "amount": 110,
            "currency": "JPY",
            "currencyName": "Japanese Yen"
        },
        {
            "id": "2fcd7c29-1d31-11e9-9f08-06655537f802",
            "amount": 0,
            "currency": "IDR",
            "currencyName": "Indonesian Rupiah"
        }
    ]
}

Get all balances

GET /balances/v1/find

Query Parameters

Parameter Description
onBehalfOfAccount
optional
string The account id that you acted on for this balance
onBehalfOfUser
optional
string The user id that you acted on for this balance

Response Body

Parameter Description
id string balance id
amount number current balance
currency string currency code
currencyName string currency name

Get Balances by Currency

Response:

{
    "data": {
        "id": "04b07631-708b-11e9-99ce-065f88b5bfa2",
        "amount": 622487034,
        "currency": "IDR",
        "currencyName": "Indonesian Rupia"
    }
}

Get your current balances by currency

HTTP Request

GET /balances/v1/item/:currency

URL Parameters

Parameter Description
currency
required
string currency code, i.e. “IDR”

Query Parameters

Parameter Description
onBehalfOfAccount
optional
string The account id that you acted on for this balance
onBehalfOfUser
optional
string The user id that you acted on for this balance

Response Body

Parameter Description
id string balance id
amount number current balance
currency string currency code
currencyName string currency name

Get Balances History

Request:

{
    "onBehalfOfAccount": "70f1722d-b997-44c2-a2e8-691c1090d1be",
    "startDate": "2014-07-21T17:00:00Z",
    "endDate": "2019-07-23T02:39:00Z"
}

Response:

{
    "data": [
        {
            "id": "8fa76a1db55011e78ce406141bd54fa5",
            "balanceId": "513080fe-89e3-11e6-9e92-026b39b3bdb9",
            "amountBefore": 12409921.23,
            "amountAfter": 12409757.81,
            "currency": "SGD",
            "totalAmount": 0,
            "transactionId": null,
            "transactionType": "",
            "date": "2017-10-20T04:38:47Z"
        }
    ]
}

POST /balances/v1/history

Body Parameters

Parameter Description
onBehalfOfAccount
optional
string The account id that you acted on for this balance
onBehalfOfUser
optional
string The user id that you acted on for this balance
startDate
optional
string filtering records greater than or equal to startDate
example: 2019-05-07T08:59:49Z
this dates is treated as UTC time
endDate
optional
string filtering records less than endDate
example: 2019-05-07T08:59:49Z
this dates is treated as UTC time

Response Body

Parameter Description
id string history id
amountBefore number amount before
amountAfter number amount after
currency string currency
transactionId number transaction id that affected the balance
transactionType string transaction type that affected the balance
date string transaction date that affected the balance
balanceId string balance id
totalAmount number total amount

Errors

Error Code Reference

Following is the error code reference for Wallex API

Error Code Meaning
400 Bad Request – Please check your request
401 Unauthorized – Your Authorisation header is not present or it has already expired
403 Forbidden – You may have missed out the X-Api-Key in your request header
500 Internal Server Error – We had a problem with our server. Try again later.
503 Service Unavailable – We’re temporarily offline for maintenance. Please try again later.

Error Message

Following is the error message reference for Wallex API

Response:

{
    "error_code":"token_expired",
    "message":"Token Expired",
    "errors": [
        {
            "error_code":"token_expired",
            "message":"Token Expired"
        }
    ]
}

Payload

Property Description
error_code string The code of error
message string The message of error
errors string The array from errors

Changelog

vNext

v1.37.0

v1.36.0

v1.35.0

v1.34.0

v1.33.0

v1.32.0

v1.31.0

v1.30.0

v1.29.0

v1.28.0

v1.27.0

v1.26.0

v1.25.0

v1.24.0

v1.23.0

v1.22.0

v1.21.0

v1.20.0

v1.19.0

v1.18.0

v1.17.0

v1.16.0

v1.15.0

v1.14.0

v1.13.0

v1.12.0

v1.11.0

v1.10.0

v1.9.0

v1.8.0

v1.7.0

v1.6.0

v1.5.0

v1.4.0

v1.3.0

v1.2.0

v1.1.0