NAV Navbar
Wallex api logo

Mulai

Pengantar

Selamat datang di Wallex API! API Kami memungkinkan Anda untuk melakukan konversi, pembayaran, dan pengumpulan secara terprogram, memungkinkan Anda untuk mengotomatiskan proses pembayaran Anda.

API kami dibuat oleh pengembang untuk pengembang sehingga mudah diintegrasikan dengan sistem kami.

Jelajahi dokumentasi kami dan masuk ke sistem demo kami untuk mengetahui tanggapan langsung di sini di Pusat Pengembang dan jika Anda masih memiliki pertanyaan, silakan beri tahu kami.

Anda dapat menghubungi kami melalui email di cs.id@wallextech.com jika Anda memerlukan dukungan teknis mengenai integrasi Wallex API.

Kredensial

Untuk mulai menggunakan API kami, Anda akan memerlukan kredensial tertentu yang akan kami gunakan untuk mengidentifikasi dan mengizinkan penggunaan wallex API.

Cara mendapatkan Kredensial Anda

Silakan hubungi kami di cs.id@wallextech.com untuk mendapatkan kredensial Anda. Anda seharusnya mendapatkan kredensial berikut dari kami untuk mulai menggunakan API.

Nama Keterangan
X-Api-Key Akan digunakan untuk mengidentifikasi Anda saat menggunakan API.
accessKeyId Akan membutuhkan ini untuk mendapatkan token otorisasi yang digunakan untuk mengakses sumber daya yang dibatasi.
secretAccessKey Akan membutuhkan ini untuk mendapatkan token otorisasi yang digunakan untuk mengakses sumber daya terbatas.

Agar berhasil berkomunikasi dengan Wallex API, Anda harus memberikan headers berikut dalam permintaan API Anda bila perlu:

Nama Keterangan
X-Api-Key Header ini harus ditampilkan setiap permintaan API yang Anda buat.
Authorization Header ini harus ditampilkan saat mengakses sumber daya yang dibatasi.

Jika header X-Api-Key tidak disertakan dalam permintaan API apa pun, Anda akan mendapatkan 403 Forbidden sebagai respons.

Jika Authorization header tidak disertakan dalam permintaan API yang mencoba mengakses sumber daya terbatas, Anda akan kembali ke 401 Unauthorized dengan pesan authentication_failed.

Untuk Otorisasi, Anda harus membuat token dengan memanggil API Otentikasi kami.

Batas Tarif Panggilan API

Secara default, kami mengizinkan 5 permintaan API per detik dan Total 432.000 permintaan API per hari. Jika Anda membutuhkan batas tarif khusus untuk panggilan API Anda, silakan hubungi kami di cs.id@wallextech.com jelaskan permintaan anda ke kami.

Wallex Endpoints

Seluruh Wallex endpoints terletak di satu domain:
https://api-id.wallex.asia. Meskipun Anda dapat mengakses demo endpoint kami di: https://api.wallex.rocks.

API Autentikasi

Autentikasi

Request body:

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

Response:

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

Permintaan HTTP

POST /users/v1/authenticate

Body Parameter

Payload untuk badan harus diserahkan dalam format application/json

Parameter Deskripsi
accessKeyId
wajib
string ID kunci akses Anda
secretAccessKey
wajib
string Kunci akses rahasia Anda

Respons

Mengembalikan token untuk digunakan dengan API. Token harus harus ditambahkan sebagai header HTTP ke semua panggilan API di header HTTP Authorization saat Anda mengakses sumber daya yang dibatasi. Silakan hubungi Wallex untuk ID kunci akses dan kunci akses rahasia.

Berikut ini contoh Authorization header yang akan dikembalikan kepada Anda setelah otentikasi berhasil.

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZWNoQHh3YXBwLmNvbSIsInNlc3Npb25faWQiOiI0ODMyNjMyMzBiNmJjMjg0YzNkZTExYjZiNjExOTcyMyIsImlhdCI6MTQ5OTgzMTE5N30=.Q4mYfADHT2d72tZZeKsGxy76QsMq43DbCDSxEJle-Ao=

Kedaluwarsa Token

Token yang dikeluarkan setelah otentikasi berhasil hanya akan berlaku selama 8 Jam sejak dikeluarkan. Anda harus mendapatkan token baru setelah token kedaluwarsa. Namun, Anda dapat memperoleh token baru saat token lama tidak kedaluwarsa.

Keluar

Response:

Permintaan HTTP

POST /users/v1/logout

token akan menjadi tidak valid dan tidak dapat digunakan meskipun token tersebut tidak kedaluwarsa.

Tanggapan

Kode status HTTP 200

API Penerima

Penerima adalah perusahaan atau individu yang ditargetkan menjadi penerima akhir Pengiriman Dana. API ini memungkinkan Anda untuk membuat, menghapus, dan memperbarui penerima Anda. Anda juga dapat mengambil penerima individu serta daftar semua penerima Anda.

Persyaratan Penerima

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}$"
            }
        }
    ]
}

Mengembalikan bidang yang diperlukan dan aturan validasinya masing-masing untuk membuat penerima, berdasarkan mata uang, negara penerima, dan negara asal bank.

Permintaan HTTP

POST /beneficiaries/v1/requirements

Parameter Opsional

Parameter Keterangan
currency
wajib
string Mata uang, contoh USD.
bankAccountCountry
wajib
string Negara asal Akun bank, contoh SG.
beneficiaryCountry
wajib
string Negara penerima, contoh SG.

Membuat Penerima

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"
        }
    }
}

Membuat penerima baru. Persyaratan parameter akan tergantung pada jenis penerima (wallex/bank), jenis entitas, mata uang, negara penerima dan negara asal bank. Harap mengakses /beneficiaries/v1/requirements sebelumnya untuk mengetahui parameter mana yang diperlukan

Permintaan HTTP

POST /beneficiaries/v1/create

Body Parameters: Penerima

Parameter Deskripsi
onBehalfOfAccount
opsional
string akun yang Anda gunakan untuk menerima ini
onBehalfOfUser
opsional
string ID pengguna yang Anda gunakan untuk penerima ini
nickname
opsional
string Nama panggilan/alias penerima manfaat
email
opsional
string Email penerima (untuk tujuan pemberitahuan email)
country
wajib
string Negara penerima
entityType
wajib
string Jenis entitas, contoh perusahaan atau individu

Body Parameter yang memungkinkan: Penerima

Parameter di bawah ini berasal dari persyaratan objek root properti.

Parameter Deskripsi
city
bersyarat
string Kota penerima, bagi penerima di Indonesia silakan lihat daftar di sini untuk nama kota yang valid
address
bersyarat
string Alamat penerima
postcode
bersyarat
string Kode pos penerima
stateOrProvince
bersyarat
string negara bagian atau provinsi penerima
firstName
bersyarat
string Nama depan penerima, diperlukan untuk individu
lastName
bersyarat
string Nama belakang penerima, diperlukan untuk individu
companyName
bersyarat
string Nama perusahaan penerima, diperlukan untuk perusahaan
companyNameInChineseCharacters
bersyarat
string Nama perusahaan penerima dalam karakter cina, diperlukan untuk perusahaan
businessRegistration
bersyarat
string Nomor pendaftaran bisnis perusahaan, diperlukan untuk perusahaan
nationalIdentificationNumber
bersyarat
string Nomor identifikasi nasional pengguna, diperlukan untuk individu
identificationType
bersyarat
string Jenis identifikasi pengguna, daftar lengkapnya bisa didapat di sini
identificationNumber
bersyarat
string Nomor identifikasi pengguna masing-masing untuk identificationType
region
bersyarat
string Wilayah penerima, untuk penerima di Indonesia silakan lihat daftar di sini untuk nama wilayah yang valid
relationship
bersyarat
string Hubungan pengguna dengan penerima, silakan lihat daftar di sini untuk nilai hubungan yang valid

Body Parameter: Akun Bank

Parameter Keterangan
country
wajib
string Negara bank
currency
wajib
string Mata uang rekening bank
bankName
wajib
string Nama bank penerima
bankAccountHolderName
wajib
string Nama pemegang rekening bank penerima

Kemungkinan Body Parameter: Akun Bank

Parameter di bawah ini berasal dari objek persyaratan properti bankAccount.

Parameter Deskripsi
address
bersyarat
string Alamat bank penerima
accountNumber
bersyarat
string Nomor rekening bank
bankNameInChineseCharacters
bersyarat
string Nama bank penerima dalam karakter Cina
bankAccountHolderNameInChineseCharacters
bersyarat
string Nama pemegang rekening bank penerima dalam karakter Cina
bicSwift
bersyarat
string BIC/SWIFT dari rekening bank
iban
bersyarat
string IBAN dari akun bank
cnaps
bersyarat
string CNAPS dari akun bank
clabe
bersyarat
string CLABE dari akun bank
aba
bersyarat
string ABA dari akun bank
sortCode
bersyarat
string Sort Code dari akun bank
bsbCode
bersyarat
string BSB Code dari akun bank
bankCode
bersyarat
string Kode bank dari akun bank
branchName
bersyarat
string Nama cabang dari akun bank
branchCode
bersyarat
string Kode cabang dari akun bank
institutionNo
bersyarat
string Nomor institusi
ifscCode
bersyarat
string Kode perutean (routing code) untuk pembayaran lokal di India
routingCode
bersyarat
string Kode perutean rekening bank

Body Parameter: Bank perantara

jika ada kebutuhan untuk meneruskan objek intermediaryBank, silakan lihat parameter berikut.

Parameter Keterangan
bankName
opsional
string Nama bank perantara
accountNumber
opsional
string Nomor rekening bank perantara
address
opsional
string Alamat bank perantara
bicSwift
opsional
string Kode BIC/SWIFT bank perantara

Mengambil Penerima

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"
        }
    }
}

Mengembalikan penerima yang ditentukan dari pengguna saat ini.

Permintaan HTTP

GET /beneficiaries/v1/item/:beneficiaryId

Path Parameters

Parameter Keterangan
beneficiaryId
wajib
string ID penerima

Query Parameters

Parameter Deskripsi
onBehalfOfAccount
opsional
string ID akun yang Anda gunakan untuk penerima ini
onBehalfOfUser
opsional
string ID pengguna yang Anda gunakan untuk penerima ini

Hapus Penerima

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"
        }
    }
}

Menghapus penerima dan mengembalikan objek penerima yang ditentukan untuk terakhir kalinya.

Permintaan HTTP

DELETE /beneficiaries/v1/item/:beneficiaryId

Path Parameters

Parameter Keterangan
beneficiaryId
required
string ID penerima

Query Parameters

Parameter Deskripsi
onBehalfOfAccount
opsional
string ID akun yang Anda gunakan untuk penerima ini
onBehalfOfUser
opsional
string ID pengguna yang Anda gunakan untuk penerima ini

Mengambil Semua Penerima

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"
            }
        }
    ]
}

Mengembalikan semua penerima manfaat dari pengguna mata uang, dalam Himpunan objek penerima

Permintaan HTTP

POST /beneficiaries/v1/find

Body Parameters

Parameter Keterangan
onBehalfOfAccount
optional
string ID akun yang Anda gunakan untuk penerima ini
onBehalfOfUser
optional
string ID pengguna yang Anda gunakan untuk penerima ini

Jenis Identifikasi

Daftar berikut ini dapat digunakan untuk payload jenis identifikasi

Jenis Identifikasi Deskripsi
COMPANY_REGISTRATION_NUMBER Nomor Pendaftaran Perusahaan/Bisnis
INTERNATIONAL_PASSPORT Paspor internasional
NATIONAL_ID ID Nasional
TAX_ID ID pajak

API Mata Uang

Tarif: Dapatkan Tarif Tunggal

Ini akan memberi Anda satu pasangan mata uang tunggal dan tarif masing-masing yang didukung oleh Wallex. Tarif ini diperbarui setiap menit.

Response:

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

Permintaan HTTP

GET /currencies/v1/rates/:currencyPair

Path Parameters

Parameter Keterangan
currencyPair
required
string Pasangan mata uang yang akan diambil, yaitu “IDRSGD”.

Mata Uang: Ambil Semua Mata Uang yang Didukung

Ini akan memberi Anda semua mata uang yang didukung oleh Wallex.

Response:

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

Permintaan HTTP

GET /currencies/v1/supported

Mata Uang: Pasangan Mata Uang yang Didukung

Ini akan memberi Anda semua pasangan mata uang yang didukung oleh Wallex.

Response:

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

Permintaan HTTP

GET /currencies/v1/pairs

API Pengiriman Dana

Mendukung pembayaran mata uang lokal

Dapatkan daftar mata uang lokal yang didukung, nilai array adalah kombinasi dari mata uang dan negara penerima. AUD-AU berarti Dolar Australia untuk penerima Australia

Response:

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

Permintann HTTP

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

Dapatkan Penawaran Pengiriman Dana

Dapatkan penawaran/tarif untuk pengiriman dana dengan pasangan mata uang tertentu, dan jumlah. Jika ID penerima diberikan, biaya akan dihitung sesuai dengan itu.

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
    }
}

Permintaan HTTP

POST /simple-payments/v1/quote

Body Parameter

Parameter Keterangan
onBehalfOfAccount
opsional
string ID akun yang Anda gunakan untuk pembayaran ini
onBehalfOfUser
opsional
string ID pengguna yang Anda gunakan untuk pembayaran ini
beneficiaryId
wajib
string atau null ID penerima untuk melakukan pengiriman dana kemudian dalam permintaan pengiriman dana
beneficiaryId yang digunakan di sini harus sesuai dengan permintaan pengiriman dana menggunakan penawaran ini.
sellCurrency
wajib
string Jual mata uang, jual mata uang anda contoh SGD
buyCurrency
wajib
string beli mata uang beli mata uang anda contoh IDR
amount
wajib
number Jumlah yang harus dibayar contoh 1000
fixedSide
opsional
string sisi mana dari jumlah mata uang anda yang harus kami simpan. Kami akan menghitung sisi lain (bawaan sebagai buy jika tidak ada)
paymentChannel
opsional
string nilai yang mungkin adalah LOCAL, SWIFT-SHA, SWIFT-OUR. jika tidak disetel, maka saluran akan ditentukan oleh Wallex
includeFee
opsional
boolean Menunjukkan jika termasuk biaya untuk menghitung totalAmount (nilai default true jika tidak ada)

Response

Properti Keterangan
currencyPair string Pasangan mata uang
buyCurrency string Klien membeli mata uang
sellCurrency string Klien menjual mata uang
buyAmount number Jumlah beli klien
sellAmount number Jumlah jual klien
fixedSide string Sisi pasti
rate number Tarif klien
beneficiaryId string ID dari penerima
expiresAt string Waktu maksimum untuk penawaran ini tersedia untuk digunakan
quoteId string ID penawaran
conversionFee number Biaya konversi
paymentFee number Biaya pembayaran
totalFee number Total tarif biaya
totalAmount number Jumlah total
paymentChannel string Saluran pembayaran
bankCharges number Jumlah biaya bank (berlaku jika menggunakan SWIFT-OUR), dihitung dalam sellCurrency
supportingDocumentsRequired boolean Menunjukkan apakah dokumen pendukung diperlukan atau tidak untuk transaksi

Minta URL Unggah

Untuk meminta url guna mengunggah file ke pengiriman dana

Permintaan HTTP

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 Keterangan
fileName
wajib
string Nama file yang akan diunggah
contentType
opsional
string Jenis MIME dari nama file yang akan diunggah
contentLength
opsional
number ukuran file dalam byte (ukuran maksimum 10 Mb)

Response

Properti Keterangan
uploadUrl string URL file yang diunggah
fileId string ID file yang diunggah

Unggah Berkas

Untuk mengunggah berkas menggunakan url yang dihasilkan dari wallex, ikuti konfigurasi ini.

Permintaan HTTP

PUT https://urlgeneratedfromwallex.com

Tajuk Nilai
x-amz-storage-class
wajib
string STANDARD
Content-Type
wajib
string Tipe MIME file yang akan diunggah, misalkan application/pdf, image/png, image/jpeg, dll.

Body

Berkas perlu diunggah langsung sebagai biner

Buat Pengiriman Dana

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"
    }
}

Membuat pengiriman dana baru. Harap memanggil /simple-payments/v1/quote sebelum panggilan ini untuk mendapatkan ID Penawaran.

Permintaan HTTP

POST /simple-payments/v1/create

Body Parameters

Parameter Keterangan
onBehalfOfAccount
opsional
string ID akun yang Anda gunakan untuk pembayaran ini
onBehalfOfUser
opsional
string ID pengguna yang Anda gunakan untuk pembayaran ini
fundingSource
wajib
string Sumber pendanaan, daftar lengkap dapat diperoleh dari Sumber Dana
paymentReference
wajib
string Referensi untuk pembayaran
quoteId
wajib
string ID penawaran dari /quote endpoint
purposeOfTransfer
wajib
string daftar lengkap bisa didapatkan dari Tujuan Transfer
purposeOfTransferDescription
opsional
string Info tambahan dari kode tujuan
files
wajib
array Array ID file yang akan disertakan dalam Pengiriman Dana, file diperlukan jika supportingDocumentsRequired bernilai benar (true) ketika mendapatkan Quote Pengiriman Dana. Array id file yang akan disertakan dalam pengiriman dana, file diperlukan jika supportingDocumentsRequired bernilai true ketika mendapatkan Penawaran pengiriman dana
referenceId
opsional
string Pengenal / deskripsi transaksi di sistem Anda
uniqueReferenceId
opsional
boolean Periksa pengidentifikasi / deskripsi unik transaksi di sistem Anda
senderUserId
opsional
string ID penggirim untuk pembayaran ini
fundingMethod
opsional
string Nilai yang tersedia: BANK_TRANSFER
fundingBankAccountNumber
opsional
string Hanya nilai numerik
fundingCountry
opsional
string Negara untuk mendanai pengiriman dana, yang diperlukan untuk penerima Indonesia

Response

Properti Keterangan
simplePaymentId string ID pengiriman dana
totalAmount number Jumlah pembayaran
status string Status pembayaran
buyAmount number Jumlah pembelian
buyCurrency string Beli mata uang
sellAmount number Jumlah jual
sellCurrency string Jual mata uang
currencyPair string Pasangan mata uang dari pembayaran
fixedSide string Sisi pasti
rate number Tarif Pembayaran kliean
totalFee number Total biaya
createdAt string Tanggal pengiriman dana dibuat
completedAt string Tanggal pengiriman dana selesai
reference string Referensi pengiriman dana
referenceId string ID referensi
paymentReference string Referensi pembayaran
failureReason string Alasan kegagalan
fundingSource string Sumber dana
purposeOfTransfer string Tujuan transaksi
beneficiary object Info penerima
fundingReference string 6 digit kode untuk referensi anda guna mendanai pengiriman dana
fundingCutoffTime string Tanggal batas waktu pendanaan
fundingCountry string Negara untuk mendanai pengiriman dana

Ambil Pengiriman Dana

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"
    }
}

Mengembalikan pembayaran yang ditentukan dari pengguna saat ini.

Permintaan HTTP

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

Path Parameters

Parameter Keterangan
simplePaymentId
wajib
string ID Pengiriman Dana

Query Parameters

Properti Keterangan
onBehalfOfAccount
opsional
string ID akun yang Anda gunakan untuk pembayaran ini
onBehalfOfUser
opsional
string ID pengguna yang Anda gunakan untuk pembayaran ini

Response

Properti Keterangan
simplePaymentId string ID pengiriman dana
totalAmount number Total pembayaran
status string Status pengiriman dana
buyAmount number Jumlah beli
buyCurrency string Mata uang pembelian
sellAmount number Jumlah jual
sellCurrency string Mata uang penjualan
currencyPair string Pasangan mata uang pembayaran
fixedSide string Sisi pasti
rate number Tarif pembayaran klien
totalFee number Total biaya
createdAt string Tanggal pengiriman dana dibuat
completedAt string Tanggal pengiriman dana selesai
reference string referensi pengiriman dana
referenceId string ID referensi
paymentReference string Referensi pembayaran
failureReason string Alasan kegagalan
fundingSource string Sumber pendanaan
purposeOfTransfer string Tujuan transaksi
beneficiary object Info penerima
fundingReference string 6 digit kode untuk referensi anda guna mendanai pengiriman dana
fundingCutoffTime string Tanggal batas waktu pendanaan

Dapatkan Semua Pengiriman Dana

Request:

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

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"
        }
    ]
}

Mengembalikan semua pengiriman dana dari pengguna mata uang, dalam serangkaian objek pengiriman dana.

Permintaan HTTP

POST /simple-payments/v1/find

Body Parameter

Parameter Keterangan
onBehalfOfAccount
opsional
string ID akun yang Anda gunakan untuk pembayaran ini
onBehalfOfUser
opsional
string ID pengguna yang Anda gunakan untuk pembayaran ini
startDate
opsional
string pemfilteran catatan lebih besar dari atau sama ke startDate
contoh: 05-07-2019T08:59:49Z
tanggal ini diperlakukan sebagai waktu UTC
endDate
opsional
string pemfilteran catatan kurang dari endDate
contoh: 07-05-2019T08:59:49Z
tanggal ini diperlakukan sebagai waktu UTC
referenceId
opsional
string memfilter catatan berdasarkan referenceId
status
opsional
string filtering records by status.
available value: awaiting_funds, processing, completed, rejected, failed

Response

Properti Keterangan
data array Berbagai pengiriman dana
simplePaymentId string ID dari pengiriman dana
totalAmount number Jumlah pembayaran
status string Status
buyAmount number Jumlah beli
buyCurrency string Mata uang pembelian
sellAmount number Jumlah jual
sellCurrency string Mata uang penjualan
currencyPair string Pasangan mata uang untuk pembayaran
fixedSide string Sisi pasti
rate number Tarif pembayaran klien
totalFee number Total biaya
createdAt string Tanggal pengiriman dana dibuat
completedAt string Tanggal pengiriman dana selesai
reference string Referensi pembayara sederhana
referenceId string ID referensi
paymentReference string Referensi pembayaran
failureReason string Alasan kegagalan
fundingSource string Sumber pendanaan
purposeOfTransfer string Tujuan transaksi
beneficiary object Info penerima
fundingReference string 6 digit kode untuk referensi anda guna mendanai pengiriman dana
fundingCutoffTime string Tanggal batas waktu pendanaan

Ambil Bukti Dokumen Pembayaran

Response:

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

Permintaan HTTP

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

Path Parameters

Parameter Keterangan
simplePaymentId
wajib
string ID Pengiriman Dana

Query Parameters

Parameter Keterangan
onBehalfOfAccount
opsional
string ID akun yang Anda gunakan untuk pembayaran ini
onBehalfOfUser
opsional
string ID pengguna yang Anda gunakan untuk pembayaran ini
documentType
opsional
string Jenis dokumen. Nilai yang mungkin:invoice

Response

Properti Keterangan
documentType string Jenis dokumen
url string URL untuk mengunduh file dokumen. URL hanya valid selama 5 menit.

Sumber Pendanaan

Daftar ini dapat digunakan untuk sumber pendanaan dalam payload

Sumber Pendanaan Keterangan
SALARY_WAGES Gaji/Upah
SOF_BORROWED_FUNDS_OR_LOAN Dana yang dipinjam/Pinjaman
Pension/Government/Welfare Dana Pensiun/Pemerintah/Kesejahteraan
INVESTMENTS Investasi
RETIREMENT_FUNDS Dana Pensiun
LOAN_FACILITY Fasilitas Pinjaman
COMPANY_BANK_ACCOUNT Rekening Bank Perusahaan
Personal Wealth/Personal Savings/Personal Account Kekayaan Pribadi/Tabungan Pribadi/Akun Pribadi
INHERITANCE Warisan

Tujuan Transfer

Daftar ini dapat digunakan untuk tujuan transfer di payload. Untuk lebih lengkap, silahkan kunjungi tautan berikut.

Pemberitahuan Status Pengiriman Dana

Perbarui status pembayaran Anda ketika persyaratan terpenuhi atau tidak terpenuhi

Payload:

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

Payload

Properti Keterangan
resource string Sumber daya pembayaran
resourceId string ID sumber daya
status string Status pembayaran
reason string Alasan status rejected dan failed

Nilai status:

Error

Referensi Kode Error

Berikut adalah referensi kode Error untuk Wallex API

Kode Error Keterangan
400 Bad Request – Harap periksa permintaan Anda
401 Unauthorized – header Otorisasi Anda tidak ada atau sudah kedaluwarsa
403 Forbidden – Anda mungkin melewatkan X-Api-Key di header permintaan Anda
500 Internal Server Error – Kami memiliki masalah dengan server kami. Coba lagi nanti.
503 Service Unavailable – Kami sementara offline untuk pemeliharaan. Silakan coba lagi nanti.

Pesan Error

Berikut adalah referensi pesan Error untuk Wallex API

Response:

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

Payload

Properti Keterangan
error_code string Kode kesalahan
message string Pesan kesalahan
errors string Array dari kesalahan