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.

Pengiriman Dana

Jalur Pembayaran yang Tersedia

Dapatkan daftar jalur pembayaran yang tersedia, nilai-nilai dalam array memberikan informasi tentang jalur yang didukung, batasan setiap jalur pembayaran pada setiap proses penyelesaian. Jika jumlah Anda melebihi batas kami, itu akan menciptakan transaksi pemisahan penyelesaian.

Request body:

{
  "beneficiaryEntityType": "individual",
  "buyCurrency": "USD",
  "bankCountryCode": "US",
  "swift": "USBKUS44IMT",
  "accountNumber": "0123456789",
  "amount": 100000
}

Response:

{
    "data": [
        {
            "settlementChannel": "LOCAL",
            "limit": 1000000,
            "splitSettlement": false
        },
        {
            "settlementChannel": "SWIFT-SHA",
            "limit": null,
            "splitSettlement": false
        },
        {
            "settlementChannel": "SWIFT-OUR",
            "limit": null,
            "splitSettlement": false
        }
    ]
}

HTTP Request

POST /v2/payments/available-channels

Body Parameters

Parameter Keterangan
beneficiaryEntityType
optional
string Jenis akun yang Anda tindaklanjuti untuk pembayaran ini
buyCurrency
required
string Mata uang yang Anda tindaklanjuti untuk pembayaran ini
bankCountryCode
required
string Kode negara bank untuk memproses pembayaran ini
swift
optional
string Kode SWIFT untuk memproses pembayaran ini
accountNumber
optional
string Nomor akun untuk memproses pembayaran ini
amount
required
number Jumlah yang dibayarkan

Response

Property Keterangan
settlementChannel string Jalur penyelesaian
limit number Batas saluran penyelesaian
splitSettlement boolean Penanda untuk pemisahan pembayaran jika menggunakan jalur penyelesaian ini

Lihat Daftar Bank Pelanggan

Menampilkan daftar bank yang dapat digunakan pengguna untuk mendanai pengiriman dana ke Wallex

Path Parameters:

  "countryId": "ID"

Response:

{
    "data": [
        {
            "bankName": "BANK RAYA",
            "swiftCode": "AGTBIDJA"
        },
        {
            "bankName": "Bank ANZ",
            "swiftCode": "ANZBIDJX"
        },
        {
            "bankName": "Bank Artha Graha",
            "swiftCode": "ARTGIDJA"
        },
        ....
    ]
}

HTTP Request

GET /v2/payments/customer-banks/:countryId

Path Parameters

Parameter Deskripsi
countryId
wajib
string ID Negara yang ingin ditampilkan

Response

Properti Deskripsi
bankName string Nama Bank
swiftCode string SWIFT dari rekening bank

Mendapatkan Penawaran Pengiriman Dana

Dapatkan penawaran/kurs untuk Pengiriman Dana dengan pasangan mata uang, jumlah, dan negara bank penerima yang diberikan. Jika negara penerima dan negara bank penerima keduanya disediakan, sistem akan menampilkan persyaratan penerima dalam balasan.

Request body:

{
  "sellCurrency": "SGD",
  "buyCurrency": "IDR",
  "amount": 10000,
  "beneficiaryCountryCode": "ID",
  "beneficiaryBankCountryCode": "ID",
  "fixedSide": "buy",
  "paymentChannel": "LOCAL"
}

Response:

{
  "currencyPair": "SGDIDR",
  "buyCurrency": "IDR",
  "sellCurrency": "SGD",
  "buyAmount": 1000000,
  "sellAmount": 95.25,
  "fixedSide": "buy",
  "rate": 10498.7328,
  "partnerRate": 10499,
  "partnerBuyAmount": 1000000,
  "partnerSellAmount": 95.25,
  "partnerPaymentFee": 9.5,
  "expiresAt": "2022-04-01T08:08:09Z",
  "quoteId": "9d46002f-f346-41a4-96da-9fff7182f4a0",
  "conversionFee": 6,
  "paymentFee": 9.5,
  "totalFee": 15.5,
  "totalAmount": 110.75,
  "paymentChannel": "LOCAL",
  "bankCharges": 0,
  "supportingDocumentsRequired": false,
  "beneficiaryRequirements": [
    {
      "beneficiary": {
        "paymentType": "regular",
        "entityType": "individual",
        "address": "^.{1,255}",
        "country": "^[A-Z]{2}",
        "city": "^.{1,255}",
        "region": "^.{1,255}"
      },
      "bankAccount": {
        "currency": "^[A-Z]{3}",
        "bankName": "^.{1,255}",
        "bankAccountHolderName": "^[a-zA-Z0-9 ,.\\-'&()!]*$",
        "bicSwift": "^[0-9A-Z]{8}$|^[0-9A-Z]{11}$",
        "country": "^[A-Z]{2}",
        "accountNumber": "^\\d{1,16}$"
      }
    },
    {
      "beneficiary": {
        "paymentType": "regular",
        "entityType": "company",
        "address": "^.{1,255}",
        "country": "^[A-Z]{2}",
        "city": "^.{1,255}",
        "companyName": "^[a-zA-Z0-9 ,.\\-'&()!]*$",
        "region": "^.{1,255}"
      },
      "bankAccount": {
        "currency": "^[A-Z]{3}",
        "bankName": "^.{1,255}",
        "bankAccountHolderName": "^[a-zA-Z0-9 ,.\\-'&()!]*$",
        "bicSwift": "^[0-9A-Z]{8}$|^[0-9A-Z]{11}$",
        "country": "^[A-Z]{2}",
        "accountNumber": "^\\d{1,16}$"
      }
    }
  ]
}

HTTP Request

POST /v2/payments/quote

Body Parameters

Parameter Deskripsi
sellCurrency
wajib
string Mata uang jual anda, contoh “SGD”
buyCurrency
wajib
string Mata uang beli anda, contoh “IDR”
amount
wajib
number Jumlah yg harus dibayar, contoh 1000000
beneficiaryBankCountryCode
wajib
string Negara bank penerima.
Untuk mendapatkan persyaratan penerima di data balikan, harap sertakan beneficiaryCountryCode dan beneficiaryBankCountryCode. 2 huruf ISO negara
beneficiaryCountryCode
opsional
string Negara penerima.
Untuk mendapatkan persyaratan penerima di data balikan, harap sertakan beneficiaryCountryCode dan beneficiaryBankCountryCode. 2 huruf ISO negara
fixedSide
opsional
string Sisi mata uang mana yang harus kami simpan. kami akan menghitung sisi lain (default sebagai buy jika tidak ada). “buy” atau “sell”
paymentChannel
opsional
string Nilai yang memungkinkan adalah LOCAL, SWIFT-SHA dan SWIFT-OUR. jika tidak dipilih, maka saluran akan ditentukan oleh Wallex
includeFee
opsional
boolean Menunjukkan apakah sudah termasuk biaya untuk menghitung totalAmount (default sebagai true jika tidak ada).
Hanya berlaku jika fixedSide “sell”
partner
opsional
object Objek biaya dan markup yang digunakan untuk menambahkan biaya dan markup mitra kustom, jika tidak ditetapkan, akan mencari config biaya dan markup untuk mitra tertentu.

Konfigurasi parameter atau biaya/markup ini hanya berlaku untuk mitra utama.

satuan nilai fee mengikuti contoh sellCurrency: fee 2 berarti 2 SGD jika sellCurrency SGD.

nilai markup dalam satuan persentase.

Daftar Kode Error

simple_payment_quote_failed
payment_channel_not_valid
fixed_side_not_valid
beneficiary_bank_country_code_is_required
rate_non_existent
insufficient_amount_against_fee
local_payment_reach_limit
local_channel_not_available
swift_channel_not_available
all_channels_not_available

Buat Pengiriman Dana

Membuat pengiriman dana baru. Harap panggil /v2/payments/quote sebelum panggilan ini untuk mendapatkan ID penawaran.

Request body:

{
  "paymentReference": "test LP",
  "quoteId": "5e2c377f-2e34-43d9-b379-536cf7e528da",
  "fundingSource": "SALARY_WAGES",
  "purposeOfTransfer": "LOAN",
  "additionalReference": "MCPAY-1234",
  "fundingCountry": "SG",
  "beneficiary": {
    "type": "bank",
    "paymentType": "priority",
    "entityType": "individual",
    "address": "Road XYZ 321",
    "country": "ID",
    "city": "Jakarta Timur",
    "region": "DKI Jakarta",
    "email": "testlp@yopmail.com"
  },
  "bankAccount": {
    "currency": "IDR",
    "bankName": "BCA",
    "bankAccountHolderName": "John",
    "bicSwift": "CENAIDJA",
    "country": "ID",
    "accountNumber": "123456789"
  },
  "originSender": {
    "type": "individual",
    "name": "indro allezz",
    "firstName": "indro",
    "lastName": "allezz",
    "country": "ID",
    "address": "Gedung A",
    "city": "Jakarta Timur",
    "state": "DKI Jakarta",
    "postalCode": 65143,
    "nationality": "ID",
    "identificationType": "passport",
    "identificationNumber": "7162537123",
    "mobileCountryCode": "62",
    "mobileNumber": "87232938928",
    "dateOfBirth": "1990-03-24"
  },
  "fundingBankInfo":{
    "bankAccountNumber": "7777777",
    "swift": "CENAIDJA"
  }
}

Response:

{
  "simplePaymentId": "9679322c-40c3-49f6-8f92-945ded5e6c05",
  "totalAmount": 110.76,
  "status": "awaiting_funds",
  "buyAmount": 1000000,
  "buyCurrency": "IDR",
  "sellAmount": 95.26,
  "sellCurrency": "SGD",
  "currencyPair": "SGDIDR",
  "rate": 10497,
  "conversionFee": 6,
  "paymentFee": 9.5,
  "totalFee": 15.5,
  "createdAt": "2022-04-01T08:47:58Z",
  "completedAt": null,
  "reference": "220401-SIM-T9679322",
  "paymentReference": "test LP",
  "fundingSource": "SALARY_WAGES",
  "fundingCountry": "SG",
  "paymentChannel": "LOCAL",
  "bankCharges": 0,
  "purposeOfTransfer": "LOAN",
  "beneficiary": {
    "address": "Road XYZ 321",
    "city": "Jakarta Timur",
    "country": "ID",
    "email": "testlp@yopmail.com",
    "entityType": "individual",
    "beneficiaryId": "5086bc50-1ea7-4655-b529-4f8c76028d36",
    "nickname": "John - BCA - 123456789",
    "region": "DKI Jakarta",
    "type": "bank",
    "bankAccount": {
      "accountNumber": "123456789",
      "bankAccountHolderName": "John",
      "bankName": "BCA",
      "bicSwift": "CENAIDJA",
      "country": "ID",
      "currency": "IDR"
    }
  },
  "fundingReference": "CSA7FH",
  "originSender": {
    "id": "2c90050b-8710-44af-bcf8-f808a86437d0",
    "type": "individual",
    "name": "indro allezz",
    "address": "Gedung A",
    "city": "Jakarta Timur",
    "country": "ID",
    "identificationType": "passport",
    "identificationNumber": "7162537123",
    "firstName": "indro",
    "lastName": "allezz",
    "mobileNumber": "87232938928",
    "domain": "simple_payment",
    "domainId": "9679322c-40c3-49f6-8f92-945ded5e6c05",
    "mobileCountryCode": "+62",
    "incorporationDate": null,
    "dateOfBirth": "1990-03-24T00:00:00Z",
    "state": "DKI Jakarta",
    "postalCode": "65143",
    "expiryDate": null,
    "nationality": "ID"
  },
  "fixedSide": "buy",
  "fundingCutoffTime": "2022-04-01T20:47:58Z",
  "additionalReference": "MCPAY-1234",
  "failedCreateDocument": [],
  "fundingBankInfo": [
    {
      "id": "3d581080-1176-4a91-95aa-0e48f98777b9",
      "bankId": "5d8555df-15a1-4164-bdff-7881de851b78",
      "bankName": "BANK CENTRAL ASIA",
      "swiftCode": "CENAIDJA",
      "accountNumber": "7777777",
      "currency": "USD",
      "amount": 110.76
    }
  ]
}

HTTP Request

POST /v2/payments

Body Parameters

Parameter Deskripsi
paymentReference
wajib
string Referensi untuk pengiriman dana
quoteId
wajib
string Id kutipan dari endpoint “/v2/payments/quote”
fundingSource
wajib
string Sumber dana, daftar lengkap bisa didapat dari Sumber Pendanaan
purposeOfTransfer
wajib
string Tujuan transfer, daftar lengkapnya bisa didapat disini
beneficiary
wajib
object Detail penerima, harus mengikuti persyaratan penerima dari endpoint “/v2/payments/quote”
- Ketika negara penerima adalah ID, wilayah harus mengikuti seperti disini
- Ketika negara penerima adalah ID, kota harus mengikuti seperti disini
- Nilai yang diterima untuk IdentificationType seperti disini
- Nilai yang diterima untuk Relationship seperti disini
bankAccount
wajib
object Detail rekening Bank Penerima, harus mengikuti persyaratan penerima dari endpoint “/v2/payments/quote”
originSender
wajib
object Detail pengirim asal. Silakan periksa persyaratannya disini
additionalReference
kondisional
string Referensi internal pengiriman dana sistem Anda. Untuk tujuan rekonsiliasi antara Wallex dan mitra. Untuk kasus LP Partnership, diperlukan.
fundingCountry
kondisional
string Negara yang melakukan pengiriman dana, diperlukan saat negara penerima adalah ID
files
kondisional
array Array fileId untuk dimasukkan dalam pengiriman dana, file diperlukan jika SupportDocumentsRequired true ketika mendapatkan “/v2/payments/quote”
fileId diambil dari endpoint “/get-upload-url”
Panduan untuk mengunggah file
- Dapatkan unggah url
- Unggah file
referenceId
opsional
string Pengenal / deskripsi transaksi di sistem Anda
uniqueReferenceId
opsional
boolean Periksa pengidentifikasi / deskripsi unik transaksi di sistem Anda
fundingBankInfo
wajib
object Informasi bank yang digunakan pengirim untuk mendanai pengiriman dana ke Wallex
invoiceDate
kondisional
string Format tanggal faktur: DD-MM-YYYY
diperlukan untuk pembayaran INR untuk tujuan terkait bisnis
invoiceNumber
kondisional
string Format nomor faktur: hanya nilai alfanumerik (tanpa karakter khusus). Panjang maksimal 30 karakter.
diperlukan untuk pembayaran INR untuk tujuan terkait bisnis

Daftar Kode Error

simple_payments_create_failed
quoteId_is_missing
simple_payment_quote_not_exists
paymentReference_is_missing
fundingSource_is_missing
purposeOfTransfer_is_missing
purpose_code_non_existent
invalid_funding_source
originSender_is_missing
additional_reference_is_required
funding_country_required
simple_payment_reference_id_already_exist
Beneficiary does not exist
ORIGIN_SENDER_INVALID_TYPE
ORIGIN_SENDER_NAME_REQUIRED
ORIGIN_SENDER_FIRST_NAME_REQUIRED
ORIGIN_SENDER_LAST_NAME_REQUIRED
ORIGIN_SENDER_COUNTRY_REQUIRED
ORIGIN_SENDER_ADDRESS_REQUIRED
ORIGIN_SENDER_CITY_REQUIRED
ORIGIN_SENDER_STATE_REQUIRED
ORIGIN_SENDER_POSTAL_CODE_REQUIRED
ORIGIN_SENDER_IDENTIFICATION_TYPE_REQUIRED
ORIGIN_SENDER_IDENTIFICATION_NUMBER_REQUIRED
ORIGIN_SENDER_MOBILE_COUNTRY_CODE_REQUIRED
ORIGIN_SENDER_MOBILE_NUMBER_REQUIRED
ORIGIN_SENDER_NATIONALITY_REQUIRED
ORIGIN_SENDER_DATE_OF_BIRTH_REQUIRED
ORIGIN_SENDER_INCORPORATION_DATE_REQUIRED
ORIGIN_SENDER_INVALID_INCORPORATION_DATE_FORMAT
ORIGIN_SENDER_BUSINESS_ACTIVITY_REQUIRED
ORIGIN_SENDER_BUSINESS_REGISTRATION_REQUIRED
BUSINESS_ACTIVITY_NOT_AVAILABLE
beneficiaries_create_failed
(other errors may occur depending on different condition)
ENTITY_TYPE_IS_REQUIRED
COUNTRY_IS_REQUIRED
INVALID_BENEFICIARY_ADDRESS
INVALID_BENEFICIARY_CITY
INVALID_REGION
INVALID_BENEFICIARY_COMPANY_NAME
CURRENCY_IS_REQUIRED
INVALID_BANK_ACCOUNT_HOLDER_NAME
INVALID_BANK_NAME
INVALID_BIC_SWIFT
COUNTRY_IS_REQUIRED
INVALID_ACCOUNT_NUMBER
beneficiary_validate_state_region_failed
city_not_match_with_related_cities_data
region_not_exist

Dapatkan Semua Pengiriman Dana

Mendapatkan semua pengiriman dana pengguna saat ini, dalam array objek pengiriman dana.

Query Parameters:

  /v2/payments?startDate=2022-04-01T00:00:00Z
  &endDate=2022-04-01T23:59:00Z
  &referenceId=X-123
  &status[]=rejected
  &status[]=awaiting_funds
  &pagination[page]=1
  &pagination[perPage]=10

Response:

{
  "pagination": {
    "itemCount": 2,
    "page": 1,
    "perPage": 10,
    "search": [],
    "totalEntries": 2,
    "totalPages": 1
  },
  "data": [
    {
      "simplePaymentId": "9679322c-40c3-49f6-8f92-945ded5e6c05",
      "totalAmount": 110.76,
      "status": "awaiting_funds",
      "buyAmount": 1000000,
      "buyCurrency": "IDR",
      "sellAmount": 95.26,
      "sellCurrency": "SGD",
      "currencyPair": "SGDIDR",
      "rate": 10497.225,
      "marketmakerName": "Dealing Desk",
      "paymentFee": 9.5,
      "totalFee": 15.5,
      "createdAt": "2022-04-01T08:47:58Z",
      "completedAt": null,
      "reference": "220401-SIM-T9679322",
      "paymentReference": "test LP",
      "fundingSource": "SALARY_WAGES",
      "fundingCountry": "SG",
      "paymentChannel": "LOCAL",
      "bankCharges": 0,
      "purposeOfTransfer": "LOAN",
      "beneficiary": {
        "address": "Road XYZ 321",
        "city": "Jakarta Timur",
        "country": "ID",
        "email": "testlp@yopmail.com",
        "entityType": "individual",
        "beneficiaryId": "5086bc50-1ea7-4655-b529-4f8c76028d36",
        "nickname": "John - BCA - 123456789",
        "region": "DKI Jakarta",
        "type": "bank",
        "bankAccount": {
          "accountNumber": "123456789",
          "bankAccountHolderName": "John",
          "bankName": "BCA",
          "bicSwift": "CENAIDJA",
          "country": "ID",
          "currency": "IDR"
        }
      },
      "fundingReference": "CSA7FH",
      "originSender": {
        "id": "2c90050b-8710-44af-bcf8-f808a86437d0",
        "type": "individual",
        "name": "indro allezz",
        "address": "Gedung A",
        "city": "Jakarta Timur",
        "country": "ID",
        "identificationType": "passport",
        "identificationNumber": "7162537123",
        "firstName": "indro",
        "lastName": "allezz",
        "mobileNumber": "87232938928",
        "domain": "simple_payment",
        "domainId": "9679322c-40c3-49f6-8f92-945ded5e6c05",
        "mobileCountryCode": "+62",
        "incorporationDate": null,
        "dateOfBirth": "1990-03-24T00:00:00Z",
        "state": "DKI Jakarta",
        "postalCode": "65143",
        "expiryDate": null,
        "nationality": "ID"
      },
      "fixedSide": "buy",
      "fundingCutoffTime": "2022-04-01T20:47:58Z",
      "additionalReference": "MCPAY-1234",
      "fundingBankInfo": [
        {
          "id": "3d581080-1176-4a91-95aa-0e48f98777b9",
          "bankId": "5d8555df-15a1-4164-bdff-7881de851b78",
          "bankName": "BANK CENTRAL ASIA",
          "swiftCode": "CENAIDJA",
          "accountNumber": "1234567890",
          "currency": "USD",
          "amount": 110.76
        }
      ]
    },
    {
      "simplePaymentId": "b8f02449-9dc5-4311-b4e1-994f1d7d13ca",
      "totalAmount": 110.76,
      "status": "awaiting_funds",
      "buyAmount": 1000000,
      "buyCurrency": "IDR",
      "sellAmount": 95.26,
      "sellCurrency": "SGD",
      "currencyPair": "SGDIDR",
      "rate": 10497.225,
      "marketmakerName": "Dealing Desk",
      "paymentFee": 9.5,
      "totalFee": 15.5,
      "createdAt": "2022-04-01T08:15:11Z",
      "completedAt": null,
      "reference": "220401-SIM-RB8F0244",
      "paymentReference": "Test refine path",
      "fundingSource": "SALARY_WAGES",
      "fundingCountry": "SG",
      "paymentChannel": "LOCAL",
      "bankCharges": 0,
      "purposeOfTransfer": "BEXP",
      "purposeOfTransferDescription": "test",
      "beneficiary": {
        "address": "Test address",
        "city": "Jakarta Timur",
        "companyName": "ABC PTE",
        "country": "ID",
        "entityType": "company",
        "beneficiaryId": "b7394fc1-5c4f-4a04-9960-8e7db42caff0",
        "identificationType": "COMPANY_REGISTRATION_NUMBER",
        "identificationValue": "ABC12345",
        "relationship": "BUSINESS_PARTNER",
        "nickname": "ABC PTE - test bank - 123456789",
        "region": "DKI Jakarta",
        "type": "bank",
        "bankAccount": {
          "accountNumber": "123456789",
          "bankAccountHolderName": "ABC PTE",
          "bankName": "test bank",
          "bicSwift": "CENAIDJA",
          "country": "ID",
          "currency": "IDR"
        }
      },
      "fundingReference": "CSADYC",
      "originSender": {
        "id": "17cbccd4-069c-4687-9470-2a213449da4b",
        "type": "individual",
        "name": "nitya wija",
        "address": "Gedung A",
        "city": "Singapore",
        "country": "SG",
        "identificationType": "passport",
        "identificationNumber": "7162537123",
        "firstName": "nitya",
        "lastName": "wija",
        "mobileNumber": "22222222",
        "domain": "simple_payment",
        "domainId": "b8f02449-9dc5-4311-b4e1-994f1d7d13ca",
        "mobileCountryCode": "+65",
        "incorporationDate": null,
        "dateOfBirth": "1990-03-24T00:00:00Z",
        "state": "Singapore",
        "postalCode": "65143",
        "expiryDate": null,
        "nationality": "SG"
      },
      "fixedSide": "buy",
      "fundingCutoffTime": "2022-04-01T20:15:11Z",
      "additionalReference": "TEST Add reference",
      "fundingBankInfo": [
        {
          "id": "3d581080-1176-4a91-95aa-0e48f98777b9",
          "bankId": "5d8555df-15a1-4164-bdff-7881de851b78",
          "bankName": "BANK CENTRAL ASIA",
          "swiftCode": "CENAIDJA",
          "accountNumber": "1234567890",
          "currency": "USD",
          "amount": 110.76
        }
      ]
    }
  ]
}

HTTP Request

GET /v2/payments

Query Parameters

Parameter Deskripsi
startDate
opsional
string menyaring item lebih besar dari atau sama dengan startDate
contoh: 2019-05-07T08:59:49Z
tanggal ini diperlakukan sebagai waktu UTC
endDate
opsional
string menyaring item kurang dari endDate
contoh: 2019-05-07T08:59:49Z
tanggal ini diperlakukan sebagai waktu UTC
referenceId
opsional
string menyaring item dengan referenceId
status
opsional
array menyaring item dengan status.
value tersedia: awaiting_funds, processing, completed, rejected, failed
pagination[page]
opsional
number nomor halaman
pagination[perPage]
opsional
number limit halaman

Response

Property Description
data array Data Array dari kirim dana
pagination object Objek permintaan pagination
simplePaymentId string ID dari kirim dana
totalAmount number Jumlah pengiriman dana
status string Status pengiriman dana
buyAmount number Jumlah pembelian
buyCurrency string Mata uang beli
sellAmount number Jumlah jual
sellCurrency string Mata uang jual
currencyPair string Pasangan mata uang pengiriman dana
fixedSide string Sisi tetap
rate number Nilai pengiriman dana klien
totalFee number Jumlah biaya
beneficiaryName
deprecated
string Nama penerima
createdAt string Tanggal proses pengiriman dana
completedAt string Tanggal proses pengiriman dana selesai
settlementDate
deprecated
string Tanggal proses pengiriman dana lunas
reference string Referensi
referenceId string Referensi ID
paymentReference string Referensi pengiriman dana
paymentChannel string Saluran pembayaran
paymentDate
deprecated
string Tanggal pengiriman dana
failureReason string Alasan kegagalan
fundingSource string Sumber dana
purposeOfTransfer string Tujuan transaksi
beneficiary object Info Penerima
fundingReference string 6 digit kode untuk referensi pengiriman dana
fundingCutoffTime string tanggal batas waktu pengiriman dana
fundingBankInfo object Informasi bank yang digunakan pengirim untuk mendanai pengiriman dana ke Wallex

Lihat Detail Pengiriman Dana

Mengembalikan pengiriman dana tertentu dari pengguna saat ini.

Path Parameters:

  "id": "c4ec60b3-e388-4306-916a-55cf7afe9060"

Response:

{
  "simplePaymentId": "c4ec60b3-e388-4306-916a-55cf7afe9060",
  "totalAmount": 16.5,
  "status": "awaiting_funds",
  "buyAmount": 10559,
  "buyCurrency": "IDR",
  "sellAmount": 1,
  "sellCurrency": "SGD",
  "currencyPair": "SGDIDR",
  "rate": 10559.1771,
  "conversionFee": 6,
  "marketmakerName": "Dealing Desk",
  "paymentFee": 9.5,
  "totalFee": 15.5,
  "createdAt": "2022-03-30T05:41:28Z",
  "completedAt": null,
  "reference": "220330-SIM-4C4EC60B",
  "paymentReference": "Test refine path",
  "fundingSource": "SALARY_WAGES",
  "fundingCountry": "SG",
  "paymentChannel": "LOCAL",
  "bankCharges": 0,
  "purposeOfTransfer": "BEXP",
  "purposeOfTransferDescription": "test",
  "beneficiary": {
    "address": "Test address",
    "city": "Jakarta Timur",
    "companyName": "ABC PTE",
    "country": "ID",
    "entityType": "company",
    "beneficiaryId": "a3695259-551c-4df0-b22b-1c3c2a78f3a8",
    "identificationType": "COMPANY_REGISTRATION_NUMBER",
    "identificationValue": "ABC12345",
    "relationship": "BUSINESS_PARTNER",
    "nickname": "ABC PTE - test bank - 123456789",
    "region": "DKI Jakarta",
    "type": "bank",
    "bankAccount": {
      "accountNumber": "123456789",
      "bankAccountHolderName": "ABC PTE",
      "bankName": "test bank",
      "bicSwift": "CENAIDJA",
      "country": "ID",
      "currency": "IDR"
    }
  },
  "fundingReference": "CWSQSK",
  "originSender": {
    "id": "4fba9aae-74ee-401c-948f-f54d3e18fec9",
    "type": "individual",
    "name": "nitya wija",
    "address": "Gedung A",
    "city": "Singapore",
    "country": "SG",
    "identificationType": "passport",
    "identificationNumber": "7162537123",
    "firstName": "nitya",
    "lastName": "wija",
    "mobileNumber": "22222222",
    "domain": "simple_payment",
    "domainId": "c4ec60b3-e388-4306-916a-55cf7afe9060",
    "mobileCountryCode": "+65",
    "incorporationDate": null,
    "dateOfBirth": "1990-03-24T00:00:00Z",
    "state": "Singapore",
    "postalCode": "65143",
    "expiryDate": null,
    "nationality": "SG"
  },
  "fixedSide": "sell",
  "fundingCutoffTime": "2022-03-30T17:41:28Z",
  "additionalReference": "TEST Add reference",
  "fundingBankInfo": [
    {
      "id": "3d581080-1176-4a91-95aa-0e48f98777b9",
      "bankId": "5d8555df-15a1-4164-bdff-7881de851b78",
      "bankName": "BANK CENTRAL ASIA",
      "swiftCode": "CENAIDJA",
      "accountNumber": "1234567890",
      "currency": "SGD",
      "amount": 16.5
    }
  ]
}

HTTP Request

GET /v2/payments/:id

Path Parameters

Parameter Deskripsi
id
wajib
string ID dari kirim dana

Response

Properti Deskripsi
simplePaymentId string ID dari kirim dana
totalAmount number Jumlah pengiriman dana
status string Status pengiriman dana
buyAmount number Jumlah pembelian
buyCurrency string Mata uang beli
sellAmount number Jumlah jual
sellCurrency string Mata uang jual
currencyPair string Pasangan mata uang pengiriman dana
fixedSide string Sisi tetap
rate number The client rate of payment
totalFee number Jumlah biaya
beneficiaryName
deprecated
string Nama penerima
createdAt string Tanggal proses pengiriman dana
completedAt string Tanggal proses pengiriman dana selesai
settlementDate
deprecated
string Tanggal proses pengiriman dana lunas
reference string Referensi
referenceId string Referensi ID
paymentReference string Referensi pengiriman dana
paymentChannel string Saluran pembayaran
paymentDate
deprecated
string Tanggal pengiriman dana
failureReason string Alasan kegagalan
fundingSource string Sumber dana
purposeOfTransfer string Tujuan transaksi
beneficiary object Info penerima
fundingReference string 6 digit kode untuk referensi pengiriman dana anda
fundingCutoffTime string tanggal batas waktu pengiriman dana
fundingBankInfo object Informasi bank yang digunakan pengirim untuk mendanai pengiriman dana ke Wallex

Lihat Daftar Nama Bank China

Response:

{
  "data": [
    {
      "name": "Agricultural Bank of China",
      "value": "中国农业银行 - ABC (Agricultural Bank of China)",
      "shortName": "ABC",
      "swiftCode": "ABOCCNBJ",
      "chineseName": "中国农业银行"
    },
    {
      "name": "Bank of China",
      "value": "中国银行 - BOC (Bank of China)",
      "shortName": "BOC",
      "swiftCode": "BKCHCNBJ",
      "chineseName": "中国银行"
    },
    {
      "name": "Industrial and Commercial Bank of China",
      "value": "中国工商银行 - ICBC (Industrial and Commercial Bank of China)",
      "shortName": "ICBC",
      "swiftCode": "ICBKCNBJ",
      "chineseName": "中国工商银行"
    }
  ]
}

Mengembalikan semua daftar bank China. Digunakan untuk validasi nama bank penerima individu dalam CNY ke China

HTTP Request

GET /v2/china-bank-name-list

Response

Property Description
name string Nama bank dalam karakter alfabet
chineseName string Nama bank dalam karakter Cina
value string Nama bank dalam alfabet dan karakter Cina, harus meneruskan nilai ini sebagai nama bank saat membuat penerima manfaat individu CNY ke Cina
shortName string Nama pendek bank
swiftCode string Kode Swift bank

Pemberitahuan Webhook

API Pemberitahuan Webhook memungkinkan aplikasi mitra menerima pembaruan secara real-time untuk setiap transaksi melalui endpoint yang sudah didaftarkan di Wallex, sehingga mitra tidak perlu memeriksa transaksi secara berkala.

Data Webhook

Wallex mengirimkan notifikasi webhook dengan membuat permintaan POST ke endpoint langganan mitra dengan kode status 200. Pemberitahuan akan dicoba ulang hingga 3 kali jika kode status 200 tidak dikembalikan dan batas waktu 30 detik. Jika aplikasi Anda memerlukan lebih banyak waktu pemrosesan, sebaiknya dilakukan secara asinkron.

Setiap mitra hanya memiliki satu endpoint langganan, langganan tunggal tersebut akan memungkinkan aplikasi menerima peristiwa webhook untuk semua transaksi Wallex.

Berikut adalah objek yang disertakan dalam webhook:

Properti Keterangan
resource string Nama sumber daya terkait. misalnya: simple_payment
resourceId string ID sumber daya terkait
accountId string ID akun sumber daya terkait
status string Status sumber daya terkait
remarks
kondisional
string Keterangan sumber daya user, misalnya: alasan ditolak
reason
kondisional
string Alasan gagal/ditolak di sumber daya simple_payment

Perbarui Langganan Webhook

Request body:

{
    "url": "https://example.webhook",
    "headers": {
      "x-api-key": "a976277f-c865-44d9-b0b0-16acaee33382"
    }
}

Response:

{
    "url": "https://example.webhook",
    "headers": {
      "x-api-key": "a976277f-c865-44d9-b0b0-16acaee33382"
    }
}

Perbarui Langganan Webhook memungkinkan mitra memperbarui pengaturan webhook mereka. Mitra perlu menentukan URL yang valid dengan pengaturan header tambahan.

HTTP Request

PUT /v2/webhook

Body Parameters

Parameter Deskripsi
url
wajib
string URL webhook
headers
opsional
string Header webhook

Response

Properti Deskripsi
url string URL webhook
headers string Header webhook

Daftar Kode Error

Error
webhook_url_invalid
webhook_headers_invalid

Mengambil Langganan Webhook

Response:

{
  "url": "https://example.webhook",
    "headers": {
      "x-api-key": "a976277f-c865-44d9-b0b0-16acaee33382"
    }
}

Mengembalikan pengaturan langganan webhook mitra terbaru.

HTTP Request

GET /v2/webhook

Response

Properti Deskripsi
url string URL webhook
headers string Header webhook