{
  "opencollection": "1.0.0",
  "info": {
    "name": "Distribution Account Payouts API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Payouts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a payout by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/payouts/:transaction_id",
            "params": [
              {
                "name": "transaction_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "通过交易唯一ID获取付款详情信息。"
        },
        {
          "info": {
            "name": "Get list of payouts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/payouts",
            "params": [
              {
                "name": "transaction_id",
                "value": "",
                "type": "query",
                "description": "交易订单ID"
              },
              {
                "name": "purpose",
                "value": "",
                "type": "query",
                "description": "用途，枚举：PAYOUT、WITHDRAW"
              },
              {
                "name": "source_currency",
                "value": "",
                "type": "query",
                "description": "源币种"
              },
              {
                "name": "target_currency",
                "value": "",
                "type": "query",
                "description": "目的币种"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "订单状态"
              },
              {
                "name": "request_id",
                "value": "",
                "type": "query",
                "description": "客户端请求ID"
              },
              {
                "name": "start_time",
                "value": "",
                "type": "query",
                "description": "开始时间，13位时间戳毫秒"
              },
              {
                "name": "end_time",
                "value": "",
                "type": "query",
                "description": "结束时间，13位时间戳毫秒"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "页码，默认值为1"
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "每页查询数量，默认值为20"
              }
            ]
          },
          "docs": "获取付款列表信息"
        },
        {
          "info": {
            "name": "Create a payout",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/payouts",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "### 功能说明：\r\n向指定收款对象创建一笔付款。\r\n### 幂等说明：不支持幂等\r\n- request_id相同，业务字段相同时，返回`REQUEST_ID_IS_NOT_UNIQUE`错误；\r\n- request_id相同，业务字段不同时，返回`REQUEST_ID_IS_NOT_UNIQUE`错误；\r\n- request_id不同，业务字段相同时，按全新交易处理，创建新的payout交易。\r\n### 超时方案：\r\n如果调用Create a payout接口超时，可使用request_id调用Get list of payouts接口获取结果。"
        },
        {
          "info": {
            "name": "Cancel a payout",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/payouts/cancel/:transaction_id",
            "params": [
              {
                "name": "transaction_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "取消付款。\r\n- 业务字段（transaction_id）相同时，不支持幂等"
        },
        {
          "info": {
            "name": "Send captcha on a payout",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/payouts/captchas/:transaction_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "transaction_id",
                "value": "",
                "type": "path",
                "description": "交易ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "当付款交易需要进行验证时，通过该接口发送付款验证码。"
        },
        {
          "info": {
            "name": "Verify captcha on a payout",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/payouts/captchas/verify/:transaction_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "transaction_id",
                "value": "",
                "type": "path",
                "description": "交易单号"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "提交验证码进行验证，推进付款流程。"
        },
        {
          "info": {
            "name": "Supplement transaction  document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/payouts/documents/supplement/:transaction_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "transaction_id",
                "value": "",
                "type": "path",
                "description": "交易单号"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "### 功能说明：\r\n补充付款订单的贸易材料，暂只支持`business_type=IMPORT_TRADE_ADVANCE`进口预付场景的付款单。一个进口预付付款单可以补充多笔贸易材料，直到补充的贸易材料总金额等于预付付款单的金额。\r\n### 幂等说明：\r\n- request_id相同，业务字段相同时，幂等返回，并返回最新的审核状态status。\r\n- request_id相同，业务字段不同时，会返回REQUEST_ID_IS_NOT_UNIQUE。\r\n- request_id不同，业务字段相同时，按全新请求处理。\r\n### 超时方案：\r\n如果调用Supplement transaction  document接口超时，可使用原报文重试。"
        },
        {
          "info": {
            "name": "Calculate payout fees",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/fee/budget",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "purpose",
                "value": "",
                "type": "query",
                "description": "用途，枚举：PAYOUT、WITHDRAW"
              },
              {
                "name": "source_currency",
                "value": "",
                "type": "query",
                "description": "源币种"
              },
              {
                "name": "target_currency",
                "value": "",
                "type": "query",
                "description": "目的币种"
              },
              {
                "name": "source_amount",
                "value": "",
                "type": "query",
                "description": "源币种金额"
              },
              {
                "name": "swift_charge_option",
                "value": "",
                "type": "query",
                "description": "SWIFT中间行费用承担方，枚举： OUR（付款人承担） 、SHA（共同承担） 、BEN (收款人承担手续费)"
              },
              {
                "name": "pobo_option",
                "value": "",
                "type": "query",
                "description": "是否使用POBO，枚举：TRUE、FALSE"
              },
              {
                "name": "charge_type",
                "value": "",
                "type": "query",
                "description": "计费类型，枚举值： 1：内扣-从付款金额中收取服务费 2：外收-从付款金额基础上额外收取服务费"
              }
            ]
          },
          "docs": "payout手续费试算"
        }
      ]
    }
  ],
  "bundled": true
}