Onboarding

POST

https://merchantapi-demo.bill24.io/on_boarding/on_boarding_supplier

This endpoint is used to register a Sub Biller and allows them to link an account for settlement.

If the bank_id field is filled in, the return_url field becomes required

Request

Header Params

Content-Type

string

required

Example:

application/json

Authorization

string

required

Example:

Bearer {token get from endpoint (Authorization)}

Body Params application/json

supplier_sync_code

string

required

Sub Biller id at Biller side

name

string

required

Sub Biller name in English

name_kh

string

optional

Sub Biller name in Khmer

address

string

optional

Sub Biller address

bank_id

string

optional

Bank id is used to identify the bank where the Sub Biller
wants to activate an account can get from endpoint (Get Available
Banks)

return_url

string

optional

Url to return when add account successful (provide by
Biller)

currency

string

optional

Currency that allow Sub Biller to add specific account (if currency is null or empty Sub Biller can add any account currency)

Example

{
  "supplier_sync_code": "Cpo001",
  "name": "Station 1",
  "name_kh": "ស្ថានីយ៏ទី១",
  "address": "Chbar Ompov,Phnom Penh",
  "return_url": "https://example.com/redirect-page",
  "bank_id": "AC",
  "currency": "KHR"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://merchantapi-demo.bill24.io/on_boarding/on_boarding_supplier' \
--header 'Content-Type:  application/json' \
--header 'Authorization:  Bearer {token get from endpoint (Authorization)}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "supplier_sync_code": "Cpo001",
    "name": "Station 1",
    "name_kh": "ស្ថានីយ៏ទី១",
    "address": "Chbar Ompov,Phnom Penh",
    "return_url": "https://example.com/redirect-page",
    "bank_id": "AC",
    "currency": "KHR"
}'

Responses

🟢200Success

application/json

Body

code

string

optional

Response Code

message

string

optional

Response message in English

message_kh

string

optional

Response message in Khmer

data

object

optional

Data object

code

string

optional

Supplier code at Bill24 side

supplier_sync_code

string

optional

Sub biler id at Biller side

name

string

optional

Sub biler name in English

name_kh

string

optional

Sub biler name in Khmer

address

string

optional

Sub biler address

add_link_account

object

optional

Data object

Example

{
  "code": "000",
  "message": "success",
  "message_kh": "ជោគជ័យ",
  "data": {
    "code": "2839",
    "supplier_sync_code": "Cpo001",
    "name": "Station 1",
    "name_kh": "ស្ថានីយ៏ទី១",
    "address": "Chbar Ompov,Phnom Penh",
    "add_link_account": {
      "web_url": "https://example.bank.com.kh/47291847702ACPUREJaPKqhYg"
    }
  }
}

🔵310Response

🔵312Response

⚪1Response

Modified at 2025-03-27 09:54:41

Authorization

Add Link Account