1. Merchant Onboarding
PayKKa OpenAPI Documentation
英文(EN)
  • 中文(CN)
  • 英文(EN)
  • Overview
  • Interface rules
  • SDK
  • Communication security
    • Signature Generation & Verification
  • API list
    • Merchant Onboarding
      • Apply for Onboarding
        POST
      • Update Onboarding Info
        POST
      • Query Onboarding Status
        POST
      • Onboarding Notification
        POST
    • Risk Assessment
      • Submit Assessment
      • Update Assessment Info
      • Get Assessment Result
      • Assessment Notification
    • VA
      • apply
      • inquiry
      • notification
    • Remittance
      • notification
    • Order
      • create
      • update
      • inquiry
      • supplement
    • Tradesettle
      • apply
      • inquiry
      • notification
    • Balance
      • inquiry
    • Payee
      • create
      • update
      • inquiry
      • notification
    • Forex
      • pre-order
      • confirm
      • inquiry
      • notification
    • Payment
      • apply
      • inquiry
      • notification
    • file service
      • upload
  • appendix
    • Open the collection account code table
    • Product Category
    • Business categories
    • Province and city code
    • Bank code
    • industry
    • new industry
    • Country code
  1. Merchant Onboarding

Apply for Onboarding

POST
/api/v2/merch/onboard/apply
Create a merchant onboarding application and submit merchant information.
Note: Do not pass the request header X-Merch-Id for this API.

Request

Header Params

Body Params application/json

Example
{
    "request_id": "string",
    "contact_person": {
        "phone_prefix": "strin",
        "phone": "string",
        "email": "string"
    },
    "license": {
        "region": "st",
        "ent_name": "string",
        "ent_name_en": "string",
        "found_date": "2019-08-24",
        "registered_currency": "str",
        "registered_capital": 0,
        "address": {
            "province": "string",
            "city": "string",
            "zipcode": "string",
            "address1": "string",
            "address2": "string"
        },
        "legal_rep_name": "string",
        "license_file_id": 0,
        "ent_type": "string",
        "uni_social_credit": "string",
        "busi_from": "2019-08-24",
        "busi_end": "2019-08-24",
        "long_term": true,
        "br_no": "string",
        "br_file_id": 0,
        "annual_return_file_id": 0,
        "incorporation_form_file_id": 0,
        "br_expiry_date": "2019-08-24",
        "cr_issue_date": "2019-08-24",
        "company_article_file_id": 0,
        "cr_file_id": 0,
        "cr_no": "string",
        "share_structure_file_id": 0,
        "cr_expiry_date": "2019-08-24",
        "other_file_ids": [
            0
        ]
    },
    "business": {
        "main_industry": "string",
        "sub_industry": [
            "string"
        ],
        "industry": 0,
        "employee_number": "string",
        "address": {
            "province": "string",
            "city": "string",
            "zipcode": "string",
            "address1": "string",
            "address2": "string"
        },
        "export_country": [
            "string"
        ],
        "export_type": [
            "string"
        ],
        "trade_volume": "string",
        "website": "string",
        "business_models": [
            "string"
        ]
    },
    "stakeholder_list": [
        {
            "identity_type": "string",
            "name": "string",
            "nationality": "st",
            "birth_date": "2019-08-24",
            "address_proof_file_id": 0,
            "doc_type": "string",
            "id_number": "string",
            "doc_address": "string",
            "doc_non_portrait_side_file_id": 0,
            "doc_portrait_side_file_id": 0,
            "eff_date_start": "2019-08-24",
            "eff_date_end": "2019-08-24",
            "long_term": true,
            "share": 0,
            "resident_address": {
                "province": "string",
                "city": "string",
                "zipcode": "string",
                "address1": "string",
                "address2": "string"
            }
        }
    ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'http://prod-cn.your-api-server.com/api/v2/merch/onboard/apply' \
--header 'X-Merch-Id: M24061911365700670' \
--header 'Content-Type: application/json' \
--data '{
    "request_id": "string",
    "contact_person": {
        "phone_prefix": "strin",
        "phone": "string",
        "email": "string"
    },
    "license": {
        "region": "st",
        "ent_name": "string",
        "ent_name_en": "string",
        "found_date": "2019-08-24",
        "registered_currency": "str",
        "registered_capital": 0,
        "address": {
            "province": "string",
            "city": "string",
            "zipcode": "string",
            "address1": "string",
            "address2": "string"
        },
        "legal_rep_name": "string",
        "license_file_id": 0,
        "ent_type": "string",
        "uni_social_credit": "string",
        "busi_from": "2019-08-24",
        "busi_end": "2019-08-24",
        "long_term": true,
        "br_no": "string",
        "br_file_id": 0,
        "annual_return_file_id": 0,
        "incorporation_form_file_id": 0,
        "br_expiry_date": "2019-08-24",
        "cr_issue_date": "2019-08-24",
        "company_article_file_id": 0,
        "cr_file_id": 0,
        "cr_no": "string",
        "share_structure_file_id": 0,
        "cr_expiry_date": "2019-08-24",
        "other_file_ids": [
            0
        ]
    },
    "business": {
        "main_industry": "string",
        "sub_industry": [
            "string"
        ],
        "industry": 0,
        "employee_number": "string",
        "address": {
            "province": "string",
            "city": "string",
            "zipcode": "string",
            "address1": "string",
            "address2": "string"
        },
        "export_country": [
            "string"
        ],
        "export_type": [
            "string"
        ],
        "trade_volume": "string",
        "website": "string",
        "business_models": [
            "string"
        ]
    },
    "stakeholder_list": [
        {
            "identity_type": "string",
            "name": "string",
            "nationality": "st",
            "birth_date": "2019-08-24",
            "address_proof_file_id": 0,
            "doc_type": "string",
            "id_number": "string",
            "doc_address": "string",
            "doc_non_portrait_side_file_id": 0,
            "doc_portrait_side_file_id": 0,
            "eff_date_start": "2019-08-24",
            "eff_date_end": "2019-08-24",
            "long_term": true,
            "share": 0,
            "resident_address": {
                "province": "string",
                "city": "string",
                "zipcode": "string",
                "address1": "string",
                "address2": "string"
            }
        }
    ]
}'

Responses

🟢200success
*/*
OK
Body*/*

Example
{
    "authorize_link": "string",
    "merch_id": "string"
}
🟠400Wrong request
🟠401permission denied
🟠404Record does not exist
🟠429429
🔴500Server error
Modified at 2026-04-20 08:10:17
Previous
API list
Next
Update Onboarding Info
Built with