公共事业缴费直连代扣扣款支付接口

直连代扣机构根据用户个人签约协议，按期按账单请求从用户账户扣款的接口。

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/ebpp/pdeduct/pay' \ --header 'Content-Type: application/json' \ --data-raw '{ "agent_channel": "PUBLICFORM", "agent_code": "SECOND", "agreement_id": "1234557890", "bill_date": "201410", "bill_key": "262327843", "extend_field": "{\"key1\":\"value1\",\"key2\":\"value2\",\r\n\"key3\":\"value3\",\"key4\":\"value4\"}", "fine_amount": "2.00", "memo": "memo", "open_id": "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5", "out_order_no": "18882329324", "pay_amount": "23.00", "pid": "2088611103588892", "user_id": "2088123411243554" }'

{ "agreement_id": "1231232132", "bill_no": "201323423234", "extend_field": "{\"school_no\":\"SHNU\",\r\n\"student_id\":\"20130516\"}", "out_order_no": "213134234", "result_code": "AE0110270001", "result_msg": "支付金额不足", "result_status": "1" }

请求参数

Body 参数application/json

agent_channel

string

可选

渠道码，如用户通过机构通过服务窗进来签约则是PUBLICFORM，此值可随意传，只要不空就行

示例值:

PUBLICFORM

agent_code

string

可选

二级渠道码，预留字段

示例值:

SECOND

agreement_id

string

支付宝代扣协议Id

可选

示例值:

1234557890

bill_date

string

账期

可选

示例值:

201410

bill_key

string

可选

户号，缴费单位用于标识每一户的唯一性的

示例值:

262327843

extend_field

string

可选

扩展参数。必须以key value形式定义，转为json为格式：{"key1":"value1","key2":"value2", "key3":"value3","key4":"value4"} 后端会直接转换为MAP对象，转换异常会报参数格式错误

示例值:

{"key1":"value1","key2":"value2", "key3":"value3","key4":"value4"}

fine_amount

string

滞纳金

可选

示例值:

2.00

memo

string

备注信息

可选

示例值:

memo

open_id

string

可选

用户UserId在应用AppId下的唯一用户标识

示例值:

074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5

out_order_no

string

商户外部业务流水号

可选

示例值:

18882329324

pay_amount

string

可选

扣款金额，支付总金额，包含滞纳金

示例值:

23.00

pid

string

可选

商户PartnerId

示例值:

2088611103588892

user_id

string

用户ID

可选

示例值:

2088123411243554

示例

返回响应

🟢200common response

application/json

Body

agreement_id

string

支付宝代扣协议ID

可选

示例值:

1231232132

bill_no

string

支付宝订单流水号

可选

示例值:

201323423234

extend_field

string

扩展参数

可选

示例值:

{"school_no":"SHNU", "student_id":"20130516"}

out_order_no

string

商户代扣业务流水

可选

示例值:

213134234

result_code

string

可选

针对于支付失败时，给的对应错误明细，如果判断外围的错误码是INVOKE_PAYACCEPTANCE_EXCEPTION需要近一步再结合着结果模型中的result_code, result_msg来判断

示例值:

AE0110270001

result_msg

string

可选

针对于支付失败时，给的对应错误明细，如果判断外围的错误码是INVOKE_PAYACCEPTANCE_EXCEPTION需要近一步再结合着结果模型中的result_code, result_msg来判断

示例值:

支付金额不足

result_status

string

可选

订单支付状态。 0：未知 1：成功 2：失败

示例值:

🔴500请求失败