PayKKa API reference (v3)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

curl -i -X POST \
  https://openapi.paykka.com/v3/payment/acq/void \
  -H 'Content-Type: application/json' \
  -H 'x-paykka-appid: 978594372956732' \
  -H 'x-paykka-nonce: 4326048250346354435' \
  -H 'x-paykka-sign: Mif3gh48xxxxxxxxx' \
  -H 'x-paykka-sign-alg: SHA256_WITH_RSA' \
  -H 'x-paykka-timestamp: 1757387467986' \
  -d '{
    "merchant_id": "18356675194960",
    "timestamp": 1745922570644,
    "order_id": "GW20620xxxxx6999",
    "reason": "REQUESTED_BY_CUSTOMER"
  }'

curl -i -X POST \
  https://openapi.paykka.com/v3/payment/acq/token/remove \
  -H 'Content-Type: application/json' \
  -H 'x-paykka-appid: 978594372956732' \
  -H 'x-paykka-nonce: 4326048250346354435' \
  -H 'x-paykka-sign: Mif3gh48xxxxxxxxx' \
  -H 'x-paykka-sign-alg: SHA256_WITH_RSA' \
  -H 'x-paykka-timestamp: 1757387467986' \
  -d '{
    "merchant_id": "18356675194960",
    "timestamp": 1745922570644,
    "token": "TK206139xxx264751",
    "shopper_reference": "f4911bc8b17106a08f2f7a89a9fc4d11"
  }'

curl -i -X POST \
  https://openapi.paykka.com/v3/payment/acq/recurring/cancel \
  -H 'Content-Type: application/json' \
  -H 'x-paykka-appid: 978594372956732' \
  -H 'x-paykka-nonce: 4326048250346354435' \
  -H 'x-paykka-sign: Mif3gh48xxxxxxxxx' \
  -H 'x-paykka-sign-alg: SHA256_WITH_RSA' \
  -H 'x-paykka-timestamp: 1757387467986' \
  -d '{
    "merchant_id": "18356675194960",
    "timestamp": 1745922570644,
    "recurring_agreement_id": "RA2061xxxx0784537",
    "shopper_reference": "f4911bc8b17106a08f2f7a89a9fc4d11"
  }'

curl -i -X POST \
  https://openapi.paykka.com/v3/payment/acq/apple-pay/create-session \
  -H 'Content-Type: application/json' \
  -H 'x-paykka-appid: 978594372956732' \
  -H 'x-paykka-nonce: 4326048250346354435' \
  -H 'x-paykka-sign: Mif3gh48xxxxxxxxx' \
  -H 'x-paykka-sign-alg: SHA256_WITH_RSA' \
  -H 'x-paykka-timestamp: 1757387467986' \
  -d '{
    "merchant_id": "18356675194960",
    "timestamp": 1745922570644,
    "display_name": "Your Merchant Name",
    "domain_name": "www.mydomain.com"
  }'

curl -i -X POST \
  https://openapi.paykka.com/v3/payment/acq/token/query \
  -H 'Content-Type: application/json' \
  -H 'x-paykka-appid: 978594372956732' \
  -H 'x-paykka-nonce: 4326048250346354435' \
  -H 'x-paykka-sign: Mif3gh48xxxxxxxxx' \
  -H 'x-paykka-sign-alg: SHA256_WITH_RSA' \
  -H 'x-paykka-timestamp: 1757387467986' \
  -d '{
    "merchant_id": "18356675194960",
    "timestamp": 1745922570644,
    "shopper_reference": "f4911bc8b17106a08f2f7a89a9fc4d11"
  }'

curl -i -X POST \
  https://openapi.paykka.com/v3/payment/acq/capture \
  -H 'Content-Type: application/json' \
  -H 'x-paykka-appid: 978594372956732' \
  -H 'x-paykka-nonce: 4326048250346354435' \
  -H 'x-paykka-sign: Mif3gh48xxxxxxxxx' \
  -H 'x-paykka-sign-alg: SHA256_WITH_RSA' \
  -H 'x-paykka-timestamp: 1757387467986' \
  -d '{
    "merchant_id": "18356675194960",
    "timestamp": 1745922570644,
    "order_id": "GW20620xxxxx6999",
    "amount": 300,
    "currency": "USD",
    "capture_final": true
  }'

curl -i -X POST \
  https://openapi.paykka.com/v3/payment/acq/query \
  -H 'Content-Type: application/json' \
  -H 'x-paykka-appid: 978594372956732' \
  -H 'x-paykka-nonce: 4326048250346354435' \
  -H 'x-paykka-sign: Mif3gh48xxxxxxxxx' \
  -H 'x-paykka-sign-alg: SHA256_WITH_RSA' \
  -H 'x-paykka-timestamp: 1757387467986' \
  -d '{
    "merchant_id": "18356675194960",
    "trans_id": "",
    "order_id": "GW20620xxxxx6999",
    "session_id": "",
    "timestamp": 1746515084018
  }'

curl -i -X POST \
  https://openapi.paykka.com/v3/payment/acq \
  -H 'Content-Type: application/json' \
  -H 'x-paykka-appid: 978594372956732' \
  -H 'x-paykka-nonce: 4326048250346354435' \
  -H 'x-paykka-sign: Mif3gh48xxxxxxxxx' \
  -H 'x-paykka-sign-alg: SHA256_WITH_RSA' \
  -H 'x-paykka-timestamp: 1757387467986' \
  -d '{
    "trans_id": "174293243204408",
    "merchant_id": "18356675194960",
    "payment_type": "PURCHASE",
    "authorisation_type": "FINAL_AUTH",
    "capture_method": "AUTOMATIC",
    "timestamp": 1746515589126,
    "currency": "EUR",
    "amount": 100,
    "return_url": "https://your_url",
    "payment": {
      "payment_method": "BANKCARD",
      "shopper_reference": "f4911bc8b17106a08f2f7a89a9fc4d11",
      "card_no": "4242424242424242",
      "exp_year": "2029",
      "exp_month": "03",
      "cvv": "123",
      "holder_name": "Winifred Reopell",
      "holder_email": "zhangsan@test.com"
    },
    "browser": {
      "user_agent": "Mozilla/5.0 (Linux; U; Android 12.0.0; zh-cn; SONY-7XT78X Build/2DKKUF) AppleWebKit/537.36 (KHTML, like Gecko)Version/4.0 Chrome/74.0.3729.157 Mobile Safari/537.36",
      "color_depth": "165",
      "language": "ko-KR",
      "java_enabled": true,
      "device_type": "PC",
      "terminal_type": "WEB",
      "device_os": "WINDOWS",
      "timezone_offset": "-12:10",
      "screen_height": "128",
      "screen_width": "255",
      "cookies": "isg=BA4O1YD75-wYqlLAB-T9JZjXxxxJFHEUkjdslrlhj9 TB_TENANT_TYPE=organization",
      "device_finger_print_id": "info.kbxqkxkzqgjmwj.qpxzwmwzbwwijkth"
    },
    "goods": [
      {
        "id": "6916003178438",
        "name": "珠宝",
        "category": "珠宝",
        "brand": "周六福",
        "link": "https://www.zlf.cn/",
        "price": 170000,
        "quantity": 1,
        "delivery_date": "2024-12-26T03:22:09+08:00",
        "picture_url": "https://www.zlf.cn/"
      }
    ],
    "bill": {
      "billing_address_collection": "REQUIRED",
      "first_name": "Dalene",
      "last_name": "Hyrkas",
      "address_line1": "农安县和上镇八沟村梧河组12号",
      "country": "VU",
      "state": "河南省",
      "city": "南阳市",
      "postal_code": "411327",
      "email": "gggj0gonfc@outlook.com",
      "area_code": "0580",
      "phone_number": "98421617",
      "descriptor": "FHFXREM"
    },
    "shipping": {
      "first_name": "zhang",
      "last_name": "jin",
      "address_line1": "16 Rue Crespin du Gast, 75011 Paris, France",
      "country": "FR",
      "state": "V98J+4R Paris, France",
      "city": "Paris",
      "email": "1806294290@qq.com",
      "postal_code": "75001",
      "area_code": "33",
      "phone_number": "756879736"
    },
    "customer": {
      "order_ip": "183.238.13.170",
      "pay_ip": "183.238.13.170"
    },
    "authentication": {
      "challenge_indicator": "AUTO"
    }
  }'