收款记录列表 - 铱云开放API 2.0

分页查询订(退)单收款记录列表，默认查询10个天内的支付记录，最大支持查询1个月，如果指定订单号，时间范围可不传。
建议按订单号查询

请求参数

Header 参数

access_token

string

必需

oauth2接口获取的access_token

x-client-id

string

必需

申请对接时的clientId

Body 参数application/json

auditStatus

array[string]

可选

收款状态, WAIT_CONFIRM: 待确认, CONFIRMED: 已收款, IN_PAY: 支付中, CANCEL: 已作废

枚举值:

WAIT_CONFIRMCONFIRMEDIN_PAYCANCELFAIL

currentPage

integer <int32>

可选

pageSize

integer <int32>

可选

sourceBizCodes

array[string]

可选

来源单号列表，最大50个，传入订单后可不传时间范围

tradeStatus

array[string]

可选

交易状态（paid：付款:unpaid：未支付,failed:失败）

type

integer <int32>

必需

查询类型， 1：订单，2：退单

withAttachments

boolean

可选

是否附带收款附件信息，默认False

modifyTimeBegin

string

必需

更新开始时间，默认查询10天内，最大支持查询范围1个月

modifyTimeEnd

string

更新开始结束

必需

示例

{
    "currentPage": 41,
    "pageSize": 58,
    "type": 82,
    "createTimeEnd": 571467694221,
    "auditStatus": [
        "CANCEL",
        "CANCEL",
        "WAIT_CONFIRM",
        "FAIL",
        "CANCEL"
    ],
    "auditTimeEnd": 1210173320446,
    "auditTimeBegin": 542734473754,
    "sourceBizCodes": [
        "72",
        "77",
        "97",
        "7"
    ],
    "createTimeBegin": 937680625255,
    "tradeStatus": [
        "in sint proident nisi sunt",
        "sit laborum laboris eiusmod dolore",
        "sed esse aute"
    ]
}

返回响应

🟢200OK

application/json

Body

currentPage

integer <int32>

可选

items

array[object (收款记录列表OpenPaymentRecordVO) {25}]

可选

attachments

array[object (付款退款记录附件VO) {11}]

附件列表

可选

auditId

integer <int64>

审核人id

可选

auditName

string

审核人名称

可选

auditStatus

enum<string>

可选

收款状态，WAIT_CONFIRM：待确认，CONFIRMED：已收款，CANCEL：已作废

枚举值:

WAIT_CONFIRMCONFIRMEDIN_PAYCANCELFAIL

auditTime

string <date-time>

审核时间

可选

createId

integer <int64>

制单人id

可选

createName

string

制单人名称

可选

createTime

string <date-time>

制单时间

可选

integer <int64>

收付款记录id

可选

modifyTime

string <date-time>

修改时间

可选

orderCode

string

订单号

可选

payMoney

number

收付款金额

可选

payTime

string <date-time>

收付款时间

可选

paymentChannel

enum<string>

可选

支付渠道（1:线上2:线下）

枚举值:

ONLINEOFFLINE

paymentMethodCode

string

收付款方式

可选

paymentMethodName

string

收付款方式名称

可选

paymentRecordAggregateCode

string

可选

收付记录聚合编号(批量收款时，与paymentRecordCode时一对多关系)

paymentRecordCode

string

收付记录编号

可选

platformPayerId

string

可选

第三方平台用户表示（微信openid，阿里ali_user_id)

platformTradeCode

string

第三方支付流水号

可选

remark

string

备注信息

可选

sourceBizType

enum<string>

订单类型

可选

枚举值:

ORDERRETURN_ORDERFUND_ACCOUNTOTHER_RECEIVABLEOTHER_PAYABLEPURCHASE_ORDERPURCHASE_RETURN_ORDERWRITE_OFFRECEIPT_ACCOUNTBUYER_ORDERBUYER_RETURN_ORDERBALANCE_TOP_UPMERCHANT_ORDER

tradeStatus

string

可选

交易状态（paid：付款:unpaid：未支付）

tradeStatusMsg

string

交易状态描述

可选

tradeType

enum<string>

可选

交易类型（pay, refund）

枚举值:

PAYREFUNDCREDIT_REFUND

pageSize

integer <int32>

可选

totalCount

integer <int64>

可选

totalPage

integer <int64>

可选

示例

{
    "currentPage": 0,
    "items": [
        {
            "attachments": [
                {
                    "createId": 0,
                    "createName": "string",
                    "createTime": "2019-08-24T14:15:22Z",
                    "fileName": "string",
                    "fileOriginalName": "string",
                    "fileSize": 0,
                    "fileType": "string",
                    "fileUrl": "string",
                    "id": 0,
                    "modifyTime": "2019-08-24T14:15:22Z",
                    "paymentRecordCode": "string"
                }
            ],
            "auditId": 0,
            "auditName": "string",
            "auditStatus": "WAIT_CONFIRM",
            "auditTime": "2019-08-24T14:15:22Z",
            "createId": 0,
            "createName": "string",
            "createTime": "2019-08-24T14:15:22Z",
            "id": 0,
            "modifyTime": "2019-08-24T14:15:22Z",
            "orderCode": "string",
            "payMoney": 0,
            "payTime": "2019-08-24T14:15:22Z",
            "paymentChannel": "ONLINE",
            "paymentMethodCode": "string",
            "paymentMethodName": "string",
            "paymentRecordAggregateCode": "string",
            "paymentRecordCode": "string",
            "platformPayerId": "string",
            "platformTradeCode": "string",
            "remark": "string",
            "sourceBizType": "ORDER",
            "tradeStatus": "string",
            "tradeStatusMsg": "string",
            "tradeType": "PAY"
        }
    ],
    "pageSize": 0,
    "totalCount": 0,
    "totalPage": 0
}