Getting Started v2
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 present in every API request that you make. |
Authorization | This header should be provided 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 any 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-demo.wallex.asia
.
Users
Signup
Request body:
{
"firstName": "From",
"lastName": "Api",
"email": "from.api2@yopmail.com",
"password": "veryverysecret",
"language": "en",
"countryCode": "SG",
"accountType": "individual"
}
Response:
{
"email": "from.api2@yopmail.com",
"firstName": "From",
"lastName": "Api",
"language": "en",
"countryCode": "SG",
"accountType": "individual"
}
HTTP Request
POST /v2/signup
Body Parameters
Parameter | Description |
---|---|
firstName required |
string Your first nameMaximum 64 characters |
lastName required |
string Your last nameMaximum 64 characters |
email required |
string Your emailMaximum 128 characters |
password optional |
string Your passwordMust contain at least one letter, a number and minimum of 8 characters with no space |
language optional |
string Your preferred language: en or id , defaults to en |
countryCode required |
string Your country, in iso 3166 two letter code , the complete list can be fetched from Country List |
accountType required |
string Can be company or individual |
companyName optional |
string company name when signup as company |
Response
Once the signup is successful, the user will receive a confirmation email, describing the next steps to follow.
Parameter | Description |
---|---|
userId | string The user id, in uuid format |
string email |
|
firstName | string first name |
lastName | string last name |
language | string preferred language |
countryCode | string Your country, in iso 3166 two letter code . The complete list can be fetched from Country List |
accountType | string Can be company or individual , |
companyName | string company name when signup as company |
Get User
Response:
{
"id": "282c5ec7-50c0-4fe9-b586-92cbad1e3458",
"email": "user@example.com",
"firstName": "Wallex",
"lastName": "Asia",
"status": "pendng",
"accountId": "7755ez73a11y99c88d8684433315d680",
"remarks": "description remarks..."
}
Retrieves the user resources.
HTTP Request
GET /v2/users/:userId
Path Parameters
Parameter | Description |
---|---|
userId | string The id of the user |
Response
Property | Description |
---|---|
id | string The user id |
string The email of user |
|
firstName | string The first name of user |
lastName | string The last name of user |
status | string The user status |
accountId | string The ID of account |
remarks optional |
string more info from us regarding the user status if status is rejected or documents_need_resubmission |
Update User Details
Request body:
{
"firstName": "From",
"lastName": "Api",
"countryCode": "SG",
"employmentIndustry": "Banking/Finance/Insurance",
"employmentStatus": "Employed",
"employmentPosition": "Mid-Level/Supervisory/Management",
"nameInChineseCharacters": "名稱"
}
Response:
{
"title": "Mr",
"firstName": "From",
"lastName": "Api",
"mobileCountryCode": null,
"mobileNumber": null,
"formerName": null,
"aliasName": null,
"gender ": "male",
"countryOfBirth": "ID",
"countryOfResidence": "SG",
"countryCode": "SG",
"state": "Singapore",
"city": "Singapore",
"postalCode": "123456789",
"dateOfBirth": "01-04-1970",
"identificationType": "passport",
"identificationNumber": "YC12345",
"issueDate": "20-02-1990",
"expiryDate": "20-02-2000",
"employmentIndustry": "Banking/Finance/Insurance",
"employmentStatus": "Employed",
"employmentPosition": "Mid-Level/Supervisory/Management",
"occupation": "Account Manager",
"status": {
"value": "incomplete",
"missing_fields": ["mobileCountryCode", "mobileNumber", "nationality", "residentialAddress"]
},
"nameInChineseCharacters": "名稱"
}
HTTP Request
PATCH /v2/users/:userId/detail
Path Parameters
Parameter | Description |
---|---|
userId | string The id of the user |
Body Parameters
The payload for body should be submitted in application/json
format.
Set the value as null
to remove the value of a property.
Parameter | Description |
---|---|
title optional |
string The user’s title. Possible values: Mr, Mrs, Miss, Ms, Dr |
firstName optional |
string The user’s first namerequired for kyc screening |
lastName optional |
string The user’s last namerequired for kyc screening |
mobileCountryCode optional |
string The user’s mobile country coderequired for kyc screening |
mobileNumber optional |
string The user’s mobile numberrequired for kyc screening |
formerName optional |
string The user’s former name |
aliasName optional |
string The user’s alias |
gender optional |
string The user’s gender. Possible values: male , female required for kyc screening |
countryOfBirth optional |
string The user’s country of birthrequired for kyc screening |
nationality optional |
string The user’s nationality, in iso 3166 two letter code , the complete list can be fetched from Country Listrequired for kyc screening |
countryOfResidence optional |
string The user’s country of residence, in iso 3166 two letter code , the complete list can be fetched from Country Listrequired for kyc screening |
residentialAddress optional |
string The user’s residential address required for kyc screening |
countryCode optional |
string The country of the users residential address, in iso 3166 two letter code , the complete list can be fetched from Country Listrequired for kyc screening |
state optional |
string The user’s state or province |
city optional |
string The user’s city of residence |
postalCode optional |
string The user’s postal coderequired for kyc screening |
dateOfBirth optional |
string The user’s date of birthformat DD-MM-YYYY required for kyc screening |
identificationType optional |
string The user’s identification type. Possible values: passport , nric required for kyc screening |
identificationNumber optional |
string The user’s identification numberrequired for kyc screening |
issueDate optional |
string The issue date of the identification documentformat DD-MM-YYYY required for kyc screening |
expiryDate optional |
string The expiry date of the identification document, if applicable, for example: passport.format DD-MM-YYYY required for kyc screening if applicable |
employmentIndustry optional |
string user employment industrySee list |
employmentStatus optional |
string user employment statusSee list |
employmentPosition optional |
string user employment positionSee list |
occupation optional |
string user occupation |
nameInChineseCharacters optional |
string name of user in Chinese characters |
Response
Parameter | Description |
---|---|
title | string The user’s title. Possible values: Mr, Mrs, Miss, Ms, Dr |
firstName | string The user’s first name |
lastName | string The user’s last name |
mobileCountryCode | string The user’s mobile country code |
mobileNumber | string The user’s mobile number |
formerName | string The user’s former name |
aliasName | string The user’s alias |
gender | string The user’s gender. Possible values: male , female |
countryOfBirth | string The user’s country of birth |
nationality | string The user’s nationality |
countryOfResidence | string The user’s country of residence |
residentialAddress | string The user’s residential address |
countryCode | string The country of the users residential address, in iso 3166 two letter code |
state | string The user’s state or province |
city | string The user’s city of residence |
postalCode | string The user’s postal code |
dateOfBirth | string The user’s date of birth |
identificationType | string The user’s identification type. Possible values: passport , nric |
identificationNumber | string The user’s identification number |
issueDate | string The issue date of the identification document |
expiryDate | string The expiry date of the identification document, if applicable, for example: passport |
status | string The status of the current submitted user details. Provides additional information about missing fields |
employmentIndustry | string Employment industry |
employmentStatus | string Employment status |
employmentPosition | string Employment position |
occupation | string user occupation |
nameInChineseCharacters | string name of user in Chinese characters |
Get Company
Response:
{
"accountId": "7755ez73a11y99c88d8684433315d680",
"companyName": "Wallex" ,
"countryOfIncorporation": "SG",
"countryOfOperations": "AU",
"businessType": "Engineering",
"companyAddress": "Address 1",
"postalCode": 761711,
"state": "Singapore",
"city": "Singapore",
"registrationNumber": "RIYUF67756181",
"incorporationDate": "19-08-1989"
}
Retrieves the company resources.
HTTP Request
GET /v2/company/:accountId
Path Parameters
Parameter | Description |
---|---|
accountId | string The id of the company |
Response
Property | Description |
---|---|
accountId | string The account id |
companyName | string The name of company |
countryOfIncorporation | string The country of the company, in iso 3166 two letter code |
countryOfOperations | string The company’s country of operation, in iso 3166 two letter code |
businessType | string The business Type of company, the complete list can be get from Business Type |
companyAddress | string The address of company |
postalCode | string The postal code of company |
state | string The state of company |
city | string The city of company |
registrationNumber | string The business registration of company |
incorporationDate | string The incorporation date of company format DD-MM-YYYY |
Update Company Details
Request body:
{
"countryOfIncorporation": "SG",
"countryOfOperations": "AU",
"businessType": "Engineering",
"companyAddress": "Address 1",
"postalCode": 761711,
"state": "Singapore",
"city": "Singapore",
"registrationNumber": "RIYUF67756181",
"incorporationDate": "19-08-1989"
}
Response:
{
"accountId": "7755ez73a11y99c88d8684433315d680",
"companyName": "Wallex" ,
"countryOfIncorporation": "SG",
"countryOfOperations": "AU",
"businessType": "Engineering",
"companyAddress": "Address 1",
"postalCode": 761711,
"state": "Singapore",
"city": "Singapore",
"registrationNumber": "RIYUF67756181",
"incorporationDate": "19-08-1989"
}
HTTP Request
PATCH /v2/company/:accountId
to update more info for company only Pending Phone
and Pending Docs
Path Parameters
Parameter | Description |
---|---|
accountId | string The id of the company |
Body Parameters
The payload for body should be submitted in application/json
format.
Parameter | Description |
---|---|
countryOfIncorporation required |
string The company’s country code, in iso 3166 two letter code , the complete list can be fetched from Country Listrequired for kyc screening |
countryOfOperations required |
string The company’s country of operation, in iso 3166 two letter code , the complete list can be fetched from Country Listrequired for kyc screening |
businessType required |
string The company’s business type, the complete list can be get from Business Typerequired for kyc screening |
companyAddress required |
string The company’s addressrequired for kyc screening |
postalCode required |
string The company’s postal coderequired for kyc screening |
state required |
string The company’s staterequired for kyc screening |
city required |
string The company’s cityrequired for kyc screening |
registrationNumber required |
string The company’s business of registrationrequired for kyc screening |
incorporationDate required |
string The incorporation date of company format DD-MM-YYYY required for kyc screening |
Response
Parameter | Description |
---|---|
accountId | string The account id |
companyName | string The name of company |
countryOfIncorporation | string The country of the company, in iso 3166 two letter code |
countryOfOperations | string The company’s country of operation, in iso 3166 two letter code |
businessType | string The business Type of company |
companyAddress | string The address of company |
postalCode | string The postal code of company |
state | string The state of company |
city | string The city of company |
registrationNumber | string The business registration of company |
incorporationDate | string The incorporation date of company format DD-MM-YYYY |
Retrieve User Details
Response:
{
"title": "Mr",
"firstName": "From",
"lastName": "Api",
"mobileCountryCode": null,
"mobileNumber": null,
"formerName": null,
"aliasName": null,
"gender ": "male",
"countryOfBirth": "ID",
"countryOfResidence": "SG",
"countryCode": "SG",
"state": "Singapore",
"city": "Singapore",
"postalCode": "123456789",
"dateOfBirth": "01-04-1970",
"identificationType": "passport",
"identificationNumber": "YC12345",
"issueDate": "20-02-1990",
"expiryDate": "20-02-2000",
"employmentIndustry": "Banking/Finance/Insurance",
"employmentStatus": "Employed",
"employmentPosition": "Mid-Level/Supervisory/Management",
"occupation": "Account Manager",
"status": {
"value": "incomplete",
"missing_fields": ["mobileCountryCode", "mobileNumber", "nationality", "residentialAddress"]
},
"nameInChineseCharacters": "名稱"
}
HTTP Request
GET /v2/users/:userId/detail
Response
Parameter | Description |
---|---|
title | string The user’s title. Possible values: Mr, Mrs, Miss, Ms, Dr |
firstName | string The user’s first namerequired for kyc screening |
lastName | string The user’s last namerequired for kyc screening |
mobileCountryCode | string The user’s mobile country coderequired for kyc screening |
mobileNumber | string The user’s mobile numberrequired for kyc screening |
formerName | string The user’s former name |
aliasName | string The user’s alias |
gender | string The user’s gender. Possible values: male , female required for kyc screening |
countryOfBirth | string The user’s country of birthrequired for kyc screening |
nationality | string The user’s nationalityrequired for kyc screening |
countryOfResidence | string The user’s country of residencerequired for kyc screening |
residentialAddress | string The user’s residential addressrequired for kyc screening |
countryCode | string The country of the users residential address, in iso 3166 two letter code required for kyc screening |
state | string The user’s state or province |
city | string The user’s city of residence |
postalCode | string The user’s postal coderequired for kyc screening |
dateOfBirth | string The user’s date of birthformat DD-MM-YYYY required for kyc screening |
identificationType | string The user’s identification type. Possible values: passport , nric required for kyc screening |
identificationNumber | string The user’s identification numberrequired for kyc screening |
issueDate | string The issue date of the identification documentformat DD-MM-YYYY required for kyc screening |
expiryDate | string The expiry date of the identification document, if applicable, for example: passportformat DD-MM-YYYY required for kyc screening |
status | string The status of the current submitted user details. Provides additional information about missing fields |
employmentIndustry | string user employment industry |
employmentStatus | string user employment status |
employmentPosition | string user employment position |
occupation | string user occupation |
nameInChineseCharacters | string name of user in Chinese characters |
Create Document
Request body:
{
"documentType": "passport",
"documentName": "MyPassport.pdf"
}
Response:
{
"id": "282c5ec7-50c0-4fe9-b586-92cbad1e3458",
"documentType": "passport",
"documentName": "MyPassport.pdf",
"uploadURL": "https://wallex-files-dev.s3.ap-southeast-1.amazonaws.com/wallex/1/a7a11768-303f-4e56-934c-c53e649603f8/MyPassport.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"
}
Creates a document entry.
HTTP Request
POST /v2/users/:userId/documents
Path Parameters
Parameter | Description |
---|---|
userId | string The id of the user who is the owner of this document |
Body Parameters
Parameter | Description |
---|---|
documentType | string The type of the document, possible values are: national_identity company_proof company_address_proof nric passport ktp employment_pass s_pass work_permit photo bank_statement utility_bill phone_bill tax_bill family_card identity_report fdw |
documentName | string The name of file associated with the document |
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 |
---|---|
id | string The document id |
documentType | string The type of the document, national_identity company_proof company_address_proof nric passport ktp employment_pass s_pass work_permit photo bank_statement utility_bill phone_bill tax_bill family_card fdw |
documentName | string The name of file associated with the document |
uploadUrl | string The URL to upload the document file. The URL is valid only for 5 minutes. |
Retrieve Document
Response:
{
"id": "282c5ec7-50c0-4fe9-b586-92cbad1e3458",
"documentType": "passport",
"documentName": "MyPassport.pdf",
"downloadURL": "https://wallex-files-dev.s3.ap-southeast-1.amazonaws.com/wallex/1/a7a11768-303f-4e56-934c-c53e649603f8/MyPassport.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"
}
Retrieves a document entry.
HTTP Request
GET /v2/users/:userId/documents/:documentId
Path Parameters
Parameter | Description |
---|---|
userId | string The id of the user who is the owner of this document |
documentId | string The id of the document |
Response
Property | Description |
---|---|
id | string The document id |
documentType | string The type of the document |
documentName | string The name of file associated with the document |
downloadUrl | string The URL to download the document file. The URL is valid only for 5 minutes. |
Update Document
Request body:
{
"documentType": "nric",
"documentName": "MyNRIC.pdf"
}
Response:
{
"id": "282c5ec7-50c0-4fe9-b586-92cbad1e3458",
"documentType": "nric",
"documentName": "MyNRIC.pdf",
"uploadURL": "https://wallex-files-dev.s3.ap-southeast-1.amazonaws.com/wallex/1/a7a11768-303f-4e56-934c-c53e649603f8/MyNRIC.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"
}
Updates a document entry. This endpoints allows the client to change an existing document entry, in which case a new upload URL will be generated.
HTTP Request
PATCH /v2/users/:userId/documents/:documentId
Path Parameters
Parameter | Description |
---|---|
userId | string The id of the user who is the owner of this document |
documentId | string The id of the document |
Body Parameters
Parameter | Description |
---|---|
documentType optional |
string The type of the document, national_identity company_proof company_address_proof nric passport ktp employment_pass s_pass work_permit photo bank_statement utility_bill phone_bill tax_bill family_card fdw |
documentName optional |
string The name of file associated with the document |
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 |
---|---|
id | string The document id |
documentType | string The type of the document, either nric or passport |
documentName | string The name of file associated with the document |
uploadUrl | string The URL to download the document file. The URL is valid only for 5 minutes. |
Delete Document
Response:
{
"documentId": "fa7de24a-dac1-4953-b54e-fbe943d20ca7",
"documentType": "passport",
"documentName": "MyPassport.pdf"
}
Deletes the specified document.
HTTP Request
DELETE /v2/users/:userId/documents/:documentId
Path Parameters
Parameter | Description |
---|---|
userId required |
string The type of the document, national_identity company_proof company_address_proof nric passport ktp employment_pass s_pass work_permit photo bank_statement utility_bill phone_bill tax_bill family_card fdw |
documentId required |
string The id of the document |
Response
Property | Description |
---|---|
documentId | string The document id |
documentType | string The type of the document, either nric or passport |
documentName | string The name of file associated with the document |
List Documents
Response:
{
"value": [
{
"id": "282c5ec7-50c0-4fe9-b586-92cbad1e3458",
"documentType": "passport",
"documentName": "MyPassport.pdf",
"downloadURL": "https://wallex-files-dev.s3.ap-southeast-1.amazonaws.com/wallex/1/a7a11768-303f-4e56-934c-c53e649603f8/MyPassport.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"
},
{
"id": "ca2c43c7-e0c3-bfeb-f588-92cbad1e3458",
"documentType": "nric",
"documentName": "MyNRIC.pdf",
"downloadURL": "https://wallex-files-dev.s3.ap-southeast-1.amazonaws.com/wallex/1/a7a11768-303f-4e56-934c-c53e649603f8/MyNRIC.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"
}
]
}
Retrieves a list of all documents.
HTTP Request
GET /v2/users/:userId/documents
Path Parameters
Parameter | Description |
---|---|
userId required |
string The id of the user who is the owner of this document |
Response
Property | Description |
---|---|
value | array Array of document entries |
id | string The document id |
documentType | string The type of the document, either nric or passport |
documentName | string The name of file associated with the document |
downloadUrl | string The URL to download the document file. The URL is valid only for 5 minutes. |
Employment Statuses
This listing can be used for supporting data in user detail request
Employment Statuses |
---|
Employed |
Unemployed |
Student |
Self-Employed |
Employment Industries
This listing can be used for supporting data in user detail request
Employment Industries |
---|
Advertising/Media/Communications |
Administration/Clerical/Facilities Svc |
Agriculture/Manufacturing |
Banking/Finance/Insurance |
Construction |
Government/Civil Servant |
Personal Care Services |
Domestic Helper/Child Care |
Education/Teaching |
Hotel/Restaurant |
Information Technology |
Transportation/Shipping |
Military/Law Enforcement |
Automotive Repairs and Sales |
Medical & Health |
Real Estate/Property |
Retail/Sales |
Tourism/Airlines/Maritime |
Arts/Entertainment and Recreation |
Mining/Oil and Gas/Energy |
Water/Utilities/Waste Management |
Science |
Employment Positions
This listing can be used for supporting data in user detail request
Employment Positions |
---|
Entry Level |
Mid-Level/Supervisory/Management |
Senior Level/Executive |
Owner |
User Notifications
We support user notifications via webhook
Payload :
{
"resource": "user",
"resourceId": "282c5ec7-50c0-4fe9-b586-92cbad1e3458",
"status": "approved"
}
Payload
Property | Description |
---|---|
resource | string The resource : default is user |
resourceId | string The ID of user |
status | string The status of user |
Status values:
pending_phone
pending_docs
pending_approval
approved
rejected
documents_need_resubmission
pending_verification
inactive
KYC Screening
Response:
{
"userId": "e26fda80-c845-11e8-8910-8541dfd4ff96",
"status": "approved"
}
Creates a screening.
HTTP Request
POST /v2/users/:userId/screen
Body Parameters
none
Response
Property | Description |
---|---|
userId | string id of users |
status | string status of the screening |
Status Value
pending_phone
pending_docs
pending_approval
approved
rejected
documents_need_resubmission
pending_verification
inactive
Business Type
This listing can be used for business type in company update payload
Business Type |
---|
Accounting/Audit/Consulting |
Agriculture |
Antiques & Artpiece |
Banking/Financial/Insurance |
Construction & Development |
Education |
Engineering |
Entertainment & Recreation |
Food & Beverages |
Forestry & Logging |
Government Bodies |
Hotel & Lodging |
Information Technology |
Legal & Judiciary |
Logistics |
Manufacturing |
Media & Communications |
Medical & Healthcare |
Mining & Quarrying |
Money Lending |
Non-Profit Organisation |
Oil & Gas |
Pawnshop |
Professional Services Firm |
Real Estate |
Trading/Retail/Wholesale |
Transportation |
Utilities |
Travel/Tourism |
Unknown - Unknown |
Others |
Funding
Get a Funding
Response:
{
"id" : "75569d30-692c-4518-a8c4-0a0219f308e7",
"balanceId" : "2fcb0f63-1d31-11e9-9f08-06655537f802",
"accountId" : "32258c6f-ae0f-11e9-9f08-06655537f802",
"currency" : "IDR",
"amount" : 100000,
"reference" : "180607-00164",
"status" : "pending"
}
Returns the specified funding of the current user.
HTTP Request
GET /v2/fundings/:fundingId
Query Parameters
Property | Description |
---|---|
fundingId required |
string The ID of funding |
Response
Property | Description |
---|---|
id | string The ID of funding |
balanceId | string The ID of balances |
accountId | string The ID of accounts |
currency | string Currency code |
amount | number The amount to funding, i.e. 100000 |
reference | string The reference for funding |
status | string The status of funding |
List Fundings
List of funding transactions
Response:
{
"value":[
{
"id" : "75569d30-692c-4518-a8c4-0a0219f308e7",
"balanceId" : "2fcb0f63-1d31-11e9-9f08-06655537f802",
"accountId" : "32258c6f-ae0f-11e9-9f08-06655537f802",
"currency" : "IDR",
"amount" : 30000,
"reference" : "180607-00164",
"status" : "failed"
},
{
"id" : "eca069e4-f1f9-4b35-95eb-5ca946299de2",
"balanceId" : "2fcb0f63-1d31-11e9-9f08-06655537f802",
"accountId" : "32258c6f-ae0f-11e9-9f08-06655537f802",
"currency" : "IDR",
"amount" : 100000,
"reference" : "180607-00164",
"status" : "completed"
}
]
}
HTTP Request
GET /v2/fundings
Query Parameters
Property | Description |
---|---|
pagination[page] optional |
number page number |
status optional |
string filter by funding status completed or pending |
Response
Property | Description |
---|---|
id | string The ID of funding |
balanceId | string Balance Id |
accountID | string The ID of accounts |
currency | string Currency code |
amount | number The amount to funding, i.e. 30000 |
reference | string The reference for funding |
status | string The status of funding |
Funding Notification
Payload:
{
"fundingId": "eca069e4-f1f9-4b35-95eb-5ca946299de2",
"resource": "funding",
"status": "completed",
}
Notification of funding transactions
Status value
awaiting_funds
pending
completed
failed
Payload
Property | Description |
---|---|
fundingId | string ID of funding |
resource | string Name of the resource (funding) |
status | string The status of funding |
Refund
Get a Refund
Response:
{
"id": "253afa96-72cd-4adb-b7f1-c6203ab3ada3",
"resource": "simple_payment",
"resourceId": "8e3ced9e-cac5-11e9-a32f-2a2ae2dbcce4",
"currency": "IDR",
"amount": 100000,
"remarks": "refund remarks"
}
Returns the specified refund of the current user.
HTTP Request
GET /v2/refunds/:refundId
Query Parameters
Property | Description |
---|---|
refundId required |
string The ID of refund |
Response
Property | Description |
---|---|
id | string The ID of refund |
resource | string The name of the related resource. eg: simple_payment |
resourceId | string The ID of the related resource |
currency | string Currency code |
amount | string The amount to refund, i.e. 100000 |
remarks | string The remarks for refund |
List Refunds
List of refund transactions
Response:
{
"value": [
{
"id": "253afa96-72cd-4adb-b7f1-c6203ab3ada3",
"resource": "simple_payment",
"resourceId": "8e3ce56a-cac5-11e9-a32f-2a2ae2dbcce4",
"currency": "IDR",
"amount": 100000,
"remarks": "refund remarks"
},
{
"id": "28028318-c060-43f0-9df2-d08da68beacd",
"resourceId": "8e3ce68c-cac5-11e9-a32f-2a2ae2dbcce4",
"resource": "simple_payment",
"currency": "IDR",
"amount": 100000,
"remarks": "other refund remarks"
}
]
}
HTTP Request
GET /v2/refunds
Response
Property | Description |
---|---|
id | string The ID of refund |
resource | string The name of the related resource. eg: simple_payment |
resourceId | string The ID of the related resource |
currency | string Currency code |
amount | string The amount to refund, i.e. 100000 |
remarks | string The remarks for refund |
Refund Notification
Payload:
{
"refundId": "483b4698c23a11e99f0806655537f802",
"resource": "simple_payment",
"status": "completed"
}
Notification of refund transactions
Status value
pending
completed
failed
Payload
Property | Description |
---|---|
refundId | string The ID of refund |
resource | string The name of the related resource. eg: simple_payment |
status | string The status of refund |