跳转到内容
下载 OpenAPI 描述
语言
服务器
Generated server url

https://openapi.paykka.com/

操作

通知Webhook

通知Webhook文档

操作

请求

支付结果通知

标头
x-paykka-appidstring必需

Signature Algorithm, eg: 978594372956732

示例: 978594372956732
x-paykka-timestampstring必需

Millisecond-level timestamp, it is recommended to exceed 5min

示例: 1757387467986
x-paykka-noncestring必需

Request random numbers, anti-request replay

示例: 4326048250346354435
x-paykka-sign-algstring必需

Signature Algorithm, eg: SHA256_WITH_RSA

示例: SHA256_WITH_RSA
x-paykka-signstring必需

signature value

示例: Mif3gh48xxxxxxxxx
正文application/json必需
notify_typestring(商户通知事件类型)

PAYMENT.AUTHORIZATION: 支付已授权事件
PAYMENT.SUCCESS: 支付成功事件
PAYMENT.FAILURE: 支付失败事件
PAYMENT.CANCELED: 支付取消事件
REFUND.SUCCESS: 退款成功事件
REFUND.FAILURE: 退款失败事件

枚举"PAYMENT.AUTHORIZATION""PAYMENT.SUCCESS""PAYMENT.FAILURE""PAYMENT.CANCELED""REFUND.SUCCESS""REFUND.FAILURE"
error_codestring

错误码

error_descriptionstring

错误描述

merchant_idstring

商户号

trans_idstring

商户订单号

order_idstring

paykka订单号

amountinteger(int64)

金额

currencystring(币种; 传ISO 3166-1支持的货币三字码)

币种; 传ISO 3166-1支持的货币三字码

枚举"CNY""USD""JPY""RUB""EUR""GBP""HKD""AUD""CAD""INR"
示例: "USD"
statusstring(网关订单状态)

PROCESSING: 支付中
SUCCESS: 支付成功
AUTHORIZED: 未请款
FAILURE: 支付失败
REFUNDED: 已退款
PARTIALLY_REFUNDED: 已部分退款
CANCELED: 已取消
PARTIALLY_REVERSED: 已部分撤销

枚举"PROCESSING""SUCCESS""AUTHORIZED""FAILURE""REFUNDED""PARTIALLY_REFUNDED""CANCELED""PARTIALLY_REVERSED"
pay_finish_timestring(date-time)

支付完成时间

recurring_agreement_idstring

循环协议id

tokenstring

卡令牌

shopper_referencestring

顾客编号

authentication_resultobject(AuthenticationRecordInNotify)

3DS验证结果

expire_timestring(date-time)

过期时间

session_idstring

收银台id

示例: "CS200395192979024625"
paymentobject(PaymentInfoRespInNotify)

支付信息

card_infoobject(CardInfoRespInNotify)

支付卡数据

balancesobject(BalanceRespInNotify)

余额

curl -i -X POST \
  https://openapi.paykka.com/v3/payment/acq/NotifyUrlOfYourPayments \
  -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 '{
    "notify_type": "PAYMENT.AUTHORIZATION",
    "merchant_id": "18356675194960",
    "trans_id": "m58129512",
    "order_id": "GW2056xxxxx2136685",
    "status": "AUTHORIZED",
    "amount": 199,
    "currency": "EUR",
    "session_id": "CS20602223728587",
    "shopper_reference": "f4911bc8b17106a08f2f7a89a9fc4d11",
    "expire_time": "2025-03-08T10:00:00+08:00",
    "payment": {
      "payment_method": "BANKCARD"
    },
    "card_info": {
      "bin": "424242",
      "last4": "4242",
      "card_brand": "VISA"
    }
  }'

响应

OK

正文*/*
ret_codestring必需

ResultCode of current request

ret_msgstring必需

ResultMessage of current request

响应
无内容

请求

退款结果通知

标头
x-paykka-appidstring必需

Signature Algorithm, eg: 978594372956732

示例: 978594372956732
x-paykka-timestampstring必需

Millisecond-level timestamp, it is recommended to exceed 5min

示例: 1757387467986
x-paykka-noncestring必需

Request random numbers, anti-request replay

示例: 4326048250346354435
x-paykka-sign-algstring必需

Signature Algorithm, eg: SHA256_WITH_RSA

示例: SHA256_WITH_RSA
x-paykka-signstring必需

signature value

示例: Mif3gh48xxxxxxxxx
正文application/json必需
notify_typestring(商户通知事件类型)

PAYMENT.AUTHORIZATION: 支付已授权事件
PAYMENT.SUCCESS: 支付成功事件
PAYMENT.FAILURE: 支付失败事件
PAYMENT.CANCELED: 支付取消事件
REFUND.SUCCESS: 退款成功事件
REFUND.FAILURE: 退款失败事件

枚举"PAYMENT.AUTHORIZATION""PAYMENT.SUCCESS""PAYMENT.FAILURE""PAYMENT.CANCELED""REFUND.SUCCESS""REFUND.FAILURE"
error_codestring

错误码

error_descriptionstring

错误描述

merchant_idstring

商户号

trans_idstring

商户退货订单号

refund_order_idstring

paykka退货订单号

order_idstring

原交易paykka订单号

amountinteger(int64)

金额

currencystring(币种; 传ISO 3166-1支持的货币三字码)

币种; 传ISO 3166-1支持的货币三字码

枚举"CNY""USD""JPY""RUB""EUR""GBP""HKD""AUD""CAD""INR"
示例: "USD"
statusstring(网关退款订单状态)

REVIEWING: 审核中
PROCESSING: 退款中
SUCCESS: 成功
FAILURE: 失败

枚举"REVIEWING""PROCESSING""SUCCESS""FAILURE"
pay_finish_timestring(date-time)

支付完成时间

expire_timestring(date-time)

过期时间

curl -i -X POST \
  https://openapi.paykka.com/v3/payment/acq/NotifyUrlOfYourRefund \
  -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 '{
    "timestamp": 1744976074556,
    "notify_type": "REFUND.SUCCESS",
    "error_code": "0000",
    "error_description": "request success",
    "merchant_id": "18356675194960",
    "trans_id": "m58129512",
    "refund_order_id": "RG20324325320129",
    "order_id": "GW2056xxxxx2136685",
    "status": "SUCCESS",
    "amount": 2,
    "currency": "USD",
    "pay_finish_time": "2025-04-18T19:34:34+08:00"
  }'

响应

OK

正文*/*
ret_codestring必需

ResultCode of current request

ret_msgstring必需

ResultMessage of current request

响应
无内容
操作
操作