1. Payee
PayKKa OpenAPI Documentation
英文(EN)
  • 中文(CN)
  • 英文(EN)
  • Overview
  • Interface rules
  • SDK
  • Communication security
    • Signature Generation & Verification
  • API list
    • Merchant Onboarding
      • Apply for Onboarding
      • Update Onboarding Info
      • Query Onboarding Status
      • Onboarding Notification
    • 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
        POST
      • update
        POST
      • inquiry
        POST
      • notification
        POST
    • 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. Payee

update

POST
/api/v2/merch/beneficiary/update
Payee modification

Request

Header Params

Body Params application/json

Example
{
    "request_id": "string",
    "type": "string",
    "beneficiary": {
        "purpose": "PFG",
        "purpose_desc": "string",
        "country": "string",
        "industry": 0,
        "main_industry": "string",
        "sub_industry": [
            "string"
        ],
        "nick_name": "string",
        "first_name": "string",
        "last_name": "string",
        "doc_type": "string",
        "id_number": "string",
        "uni_social_credit": "string",
        "address": {
            "province": "string",
            "city": "string",
            "zipcode": "string",
            "address1": "string",
            "address2": "string"
        }
    },
    "bank_acc": {
        "country": "st",
        "currency": "EUR",
        "acc_name": "string",
        "acc_type": "PRIVATE",
        "acc_no": "string",
        "payment_type": "LOCAL",
        "routing_code_type1": "string",
        "routing_code_value1": "string",
        "routing_code_type2": "string",
        "routing_code_value2": "string",
        "iban": "string",
        "bic_swift": "string",
        "bank_acc_type": "CHECKING",
        "bank_addr": "string",
        "bank_name": "string",
        "branch_bank_name": "string",
        "phone": "string",
        "province": "string",
        "city": "string",
        "district": "string"
    },
    "attachment": {
        "other_file_ids": [
            0
        ],
        "contract_file_id": 0,
        "logistics_file_id": 0,
        "pi_file_id": 0
    }
}

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/beneficiary/update' \
--header 'X-Merch-Id: M24061911365700670' \
--header 'Content-Type: application/json' \
--data '{
    "request_id": "string",
    "type": "string",
    "beneficiary": {
        "purpose": "PFG",
        "purpose_desc": "string",
        "country": "string",
        "industry": 0,
        "main_industry": "string",
        "sub_industry": [
            "string"
        ],
        "nick_name": "string",
        "first_name": "string",
        "last_name": "string",
        "doc_type": "string",
        "id_number": "string",
        "uni_social_credit": "string",
        "address": {
            "province": "string",
            "city": "string",
            "zipcode": "string",
            "address1": "string",
            "address2": "string"
        }
    },
    "bank_acc": {
        "country": "st",
        "currency": "EUR",
        "acc_name": "string",
        "acc_type": "PRIVATE",
        "acc_no": "string",
        "payment_type": "LOCAL",
        "routing_code_type1": "string",
        "routing_code_value1": "string",
        "routing_code_type2": "string",
        "routing_code_value2": "string",
        "iban": "string",
        "bic_swift": "string",
        "bank_acc_type": "CHECKING",
        "bank_addr": "string",
        "bank_name": "string",
        "branch_bank_name": "string",
        "phone": "string",
        "province": "string",
        "city": "string",
        "district": "string"
    },
    "attachment": {
        "other_file_ids": [
            0
        ],
        "contract_file_id": 0,
        "logistics_file_id": 0,
        "pi_file_id": 0
    }
}'

Responses

🟢200success
*/*
OK
Body*/*

Example
{
    "msg": "string",
    "payee_id": "string",
    "status": "PENDING"
}
🟠400Wrong request
🟠401permission denied
🟠404Record does not exist
🟠429429
🔴500Server error
Modified at 2026-04-16 08:39:45
Previous
create
Next
inquiry
Built with