PayKKa Docs for Payments
v1.0 🇨🇳 (Release)
  • v1.2 🇨🇳 (Current Release)
  • v1.0 🇨🇳 (Release)
  1. 通知Webhook
PayKKa Docs for Payments
v1.0 🇨🇳 (Release)
  • v1.2 🇨🇳 (Current Release)
  • v1.0 🇨🇳 (Release)
  • 变更记录
  • 接入流程
  • API 参考
    • 开始
    • API认证
    • 系统响应码
    • 付款错误码
    • 付款
      • 交易
      • 交易查询
      • token删除
      • token查询
      • 循环交易协议取消
    • 收银台
      • 收银台创建
      • 收银台查询
    • 退款
      • 退款
      • 退款查询
    • 通知Webhook
      • 交易结果通知
        POST
      • 退款结果通知
        POST
  • 前端接入
    • PayKKa Radar SDK 使用文档
    • PayKKa Checkout UI Component 使用文档
  • 数据模型
    • Schemas
      • 响应
      • QueryPayResultReqDto
      • CheckoutQueryRespDto
      • CheckoutPaymentsRespDto
      • PaymentLinkPaymentsRespDto
      • PaymentsReqDto
      • AuthenticationRecordDto
      • PaymentsRespDto
      • AuthenticationReqDto
      • RefundNotifyReqDto
      • PaymentsNotifyReqDto
      • QueryPayResultRespDto
      • QueryMerchRequest
      • QueryMerchResponse
      • WebAuthRequest
      • WebAuthResponse
      • QueryOpenidRequest
      • QueryOpenidResponse
      • OrderPayQrcodeRequest
      • EntryPayQrcodeResponse
      • EntryPayQrcodeRequest
      • CheckoutIdDto
      • BillRespDto
      • CardOrgEnum
      • ChannelConfig
      • CheckoutThemeRespDto
      • CountryEnum
      • GoodsRespDto
      • Money
      • PaymentInfoRespDto
      • PaymentMethodEnum
      • PaymentMethodRespDto
      • PaymentMethodsRespDto
      • PaymentTypeEnum
      • SessionModeEnum
      • SessionStatusEnum
      • CheckoutAuthenticationRecordDto
      • TokenRespDto
      • BillReqDto
      • BrowserReqDto
      • CheckoutBillReqDto
      • CheckoutPaymentsReqDto
      • DeviceOsEnum
      • PaymentDeviceTypeEnum
      • PaymentInfoReqDto
      • CheckoutPaymentInfoReqDto
      • TerminalTypeEnum
      • SessionAuthenticationRecordDto
      • SessionOrderStatusEnum
      • CheckoutPaymentQueryDto
      • PaymentMethodsReqDto
      • PaymentModeEnum
      • ApplePaySessionRespDto
      • BatchQueryDictReqDto
      • BatchQueryDictRespDto
      • DataDictResp
      • DataDictValueItem
      • OldPlaceOrderQrcodeRequestV2
      • OldPlaceOrderQrcodeResponseV2
      • OldPosQueryOrderRequestV2
      • OldPosQueryOrderResponseV2
      • OldCollectPayQrcodeRequestV2
      • OldCollectPayQrcodeResponseV2
      • OldPlaceOrderQrcodeRequest
      • OldPlaceOrderQrcodeResponse
      • OldPosQueryOrderRequest
      • OldPosQueryOrderResponse
      • OldCollectPayQrcodeRequest
      • OldCollectPayQrcodeResponse
      • PlaceOrderQrcodeRequest
      • PlaceOrderQrcodeResponse
      • DeviceActivateRequestV2
      • DeviceActivateResponseV2
      • DeviceActivateRequest
      • DeviceActivateResponse
      • CollectPayQrcodeRequest
      • CollectPayQrcodeResponse
      • PaymentLinkSessionReqDto
      • PaymentLinkPaymentsReqDto
      • PaymentLinkPaymentQueryDto
      • PaymentLinkPaymentInfoReqDto
      • PaymentLinkIdDto
      • CurrencyEnum
      • PaymentLinkQueryRespDto
      • WechatCallbackRespDto
      • AlipayCallbackRespDto
      • TokenRemoveReqDto
      • QueryTokenReqDto
      • QueryTokenRespDto
      • Result
      • CardTokenUsageEnum
      • ChallengeIndicatorEnum
      • ApiPaymentMethodEnum
      • CustomerReqDto
      • QueryRefundReqDto
      • GoodsReqDto
      • SessionCreateReqDto
      • SessionPaymentInfoReqDto
      • ShippingReqDto
      • SessionAuthenticationReqDto
      • ThreedSecureExemptionEnum
      • SessionBillReqDto
      • GatewayOrderStatusEnum
      • SessionRespDto
      • SessionCustomerReqDto
      • SessionQueryReqDto
      • SessionGoodsReqDto
      • RefundReqDto
      • AuthenticationRecordRespDto
      • GatewayRefundOrderStatusEnum
      • SessionShippingReqDto
      • RefundRespDto
      • QueryRefundResultReqDto
      • QueryPaymentsReqDto
      • QueryRefundResultRespDto
      • RecurringCancelReqDto
      • CardInfoRespDto
      • QueryTransResultReqDto
      • AddressStyleDto
      • ThreedSecureModeEnum
      • QueryAddressStyleRespDto
      • DataDictRespDto
      • PagedDataDictValueItem
      • DeviceSignInReqDto
      • DeviceSignInRespDto
      • PosCurrency
      • DeviceSignInRequestV2
      • DeviceSignInResponseV2
      • DeviceSignInRequest
      • DeviceSignInResponse
  1. 通知Webhook

交易结果通知

POST
/apis/YourPaymentsNotifyUrl
最后修改时间:2025-03-03 03:08:02
交易结果通知

请求参数

Path 参数

Header 参数

Body 参数application/json

示例
{
    "version": "v1.0",
    "sign": "string",
    "timestamp": 1659999999,
    "notify_type": "string",
    "error_code": "string",
    "error_description": "string",
    "merchant_id": "string",
    "trans_id": "string",
    "order_id": "string",
    "status": "string",
    "amount": 0,
    "currency": "CNY",
    "pay_finish_time": "2019-08-24T14:15:22.123Z",
    "recurring_agreement_id": "string",
    "token": "string",
    "shopper_reference": "string",
    "authentication_result": {
        "authentication_url": "string",
        "enroll_status": "string",
        "upgraded": true,
        "downgraded": true,
        "version": "string",
        "upgrade_reason": "string",
        "authentication_status": "string",
        "cryptogram": "string",
        "xid": "string",
        "exemption": "string",
        "mode": "string",
        "exemption_applied": "string",
        "eci": "string"
    },
    "expire_time": "2019-08-24T14:15:22.123Z",
    "session_id": "CS200395192979024625",
    "payment": {
        "store_payment_method": false
    },
    "card_info": {
        "bin": "string",
        "last4": "string",
        "card_brand": "VISA"
    }
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/apis/YourPaymentsNotifyUrl' \
--header 'type;' \
--header 'signature;' \
--header 'content-type: application/json' \
--data-raw '{
    "version": "v1.0",
    "sign": "string",
    "timestamp": 1659999999,
    "notify_type": "string",
    "error_code": "string",
    "error_description": "string",
    "merchant_id": "string",
    "trans_id": "string",
    "order_id": "string",
    "status": "string",
    "amount": 0,
    "currency": "CNY",
    "pay_finish_time": "2019-08-24T14:15:22.123Z",
    "recurring_agreement_id": "string",
    "token": "string",
    "shopper_reference": "string",
    "authentication_result": {
        "authentication_url": "string",
        "enroll_status": "string",
        "upgraded": true,
        "downgraded": true,
        "version": "string",
        "upgrade_reason": "string",
        "authentication_status": "string",
        "cryptogram": "string",
        "xid": "string",
        "exemption": "string",
        "mode": "string",
        "exemption_applied": "string",
        "eci": "string"
    },
    "expire_time": "2019-08-24T14:15:22.123Z",
    "session_id": "CS200395192979024625",
    "payment": {
        "store_payment_method": false
    },
    "card_info": {
        "bin": "string",
        "last4": "string",
        "card_brand": "VISA"
    }
}'

返回响应

🟢200成功
*/*
请求成功
Body

示例
{
    "ret_code": "string",
    "ret_msg": "string"
}
🟠400请求有误
🟠404记录不存在
🟠429429
🔴500服务器错误
修改于 2025-03-03 03:08:02
上一页
退款查询
下一页
退款结果通知
Built with