1. Order
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
        POST
      • update
        POST
      • inquiry
        POST
      • supplement
        POST
    • 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. Order

create

POST
/api/v2/merch/contract/create

Request

Header Params

Body Params application/json

Example
{
    "request_id": "string",
    "buyer_country": "string",
    "buyer_name": "string",
    "amount": 0,
    "currency": "EUR",
    "contract_no": "string",
    "contract_file_ids": [
        0
    ],
    "goods_info": {
        "category": 0,
        "name": "string",
        "quantity": 0,
        "url": "string",
        "custom_dec_info": {
            "dec_method": "string",
            "dec_no": "string"
        }
    },
    "invoice_file_ids": [
        0
    ],
    "is_exchange_settle": true,
    "logistics_info": {
        "buyer_type": "NEW",
        "destination": "string",
        "expected_ship_date": "2019-08-24",
        "freight_arrange_file_ids": [
            0
        ],
        "latest_order_file_ids": [
            0
        ],
        "logistics_company_name": "string",
        "outbound_no": "string",
        "inquiry_records_file_ids": [
            0
        ],
        "ship_date": "2019-08-24",
        "ship_status": "SHIPPED",
        "shipped_file_ids": [
            0
        ],
        "transaction_type": "EXW",
        "transport_type": "AIR"
    },
    "order_date": "2019-08-24",
    "remark": "string",
    "other_file_ids": [
        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/contract/create' \
--header 'X-Merch-Id: M24061911365700670' \
--header 'Content-Type: application/json' \
--data '{
    "request_id": "string",
    "buyer_country": "string",
    "buyer_name": "string",
    "amount": 0,
    "currency": "EUR",
    "contract_no": "string",
    "contract_file_ids": [
        0
    ],
    "goods_info": {
        "category": 0,
        "name": "string",
        "quantity": 0,
        "url": "string",
        "custom_dec_info": {
            "dec_method": "string",
            "dec_no": "string"
        }
    },
    "invoice_file_ids": [
        0
    ],
    "is_exchange_settle": true,
    "logistics_info": {
        "buyer_type": "NEW",
        "destination": "string",
        "expected_ship_date": "2019-08-24",
        "freight_arrange_file_ids": [
            0
        ],
        "latest_order_file_ids": [
            0
        ],
        "logistics_company_name": "string",
        "outbound_no": "string",
        "inquiry_records_file_ids": [
            0
        ],
        "ship_date": "2019-08-24",
        "ship_status": "SHIPPED",
        "shipped_file_ids": [
            0
        ],
        "transaction_type": "EXW",
        "transport_type": "AIR"
    },
    "order_date": "2019-08-24",
    "remark": "string",
    "other_file_ids": [
        0
    ]
}'

Responses

🟢200success
*/*
OK
Body*/*

Example
{
    "contract_order_no": "string",
    "status": "RELATABLE"
}
🟠400Wrong request
🟠401permission denied
🟠404Record does not exist
🟠429429
🔴500Server error
Modified at 2026-04-16 08:38:11
Previous
notification
Next
update
Built with