Withdraw-API.v1.json

{
  "openapi": "3.0.0",
  "info": {
    "title": "3. 提现服务",
    "version": "1.0",
    "description": ""
  },
  "servers": [
    {
      "url": "https://global-api-sandbox.lianlianpay-inc.com",
      "description": "Sandbox"
    },
    {
      "url": "https://global-api.lianlianpay.com",
      "description": "Production"
    }
  ],
  "paths": {
    "/collection/v1/withdraws": {
      "get": {
        "summary": "查询提现记录",
        "responses": {},
        "operationId": "",
        "description": "接口聚合了店铺、多比、提前宝提现列表查询，结果按创建时间排序。",
        "parameters": [
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "startTime",
            "description": "开始时间",
            "required": true
          },
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "endTime",
            "description": "结束时间",
            "required": true
          },
          {
            "schema": {
              "type": "integer",
              "maximum": 100,
              "minimum": 1
            },
            "in": "query",
            "name": "pageSize",
            "description": "分页大小",
            "required": true
          },
          {
            "schema": {
              "type": "integer",
              "default": 1
            },
            "in": "query",
            "name": "pageNum",
            "description": "页码",
            "required": true
          },
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "withdrawType",
            "description": "提现类型\n\nwithdrawType|message\n-|-\nBALANCE|余额提现\nWALLET|多比提现\nCREDIT|提前宝提现"
          },
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "platform",
            "description": "平台类型\n\ncode|name\n-|-\nAmazon|亚马逊\nFBA|亚马逊印度站（FBA）\nPAYPAL|PayPal\nSHOPEE|SHOPEE\nSOUQ|SOUQ\nCDiscount|Cdiscount\nMercado|Mercadolibre\nJDID|JD.ID(USD)\nJDIDIDR|JD.ID\nRakuten|法国乐天\nDeRakuten|德国乐天\nBRINGLY|bringly\nFNAC|fnac\nSHOPIFY|Shopify\nFRUUGO|fruugo\nSELF_BUILD|自建站\nQOO10|Qoo10\nAPPSTORE|AppStore\nALIEXPRESS|AliExpress\nBIGCOMMERCE|Bigcommerce\nMAGENTO|Magento\nNOON|Noon\nREAL_DE|real.de\nMEESHO|Meesho\nALLEGRO|Allegro\nALLEGRO_PLN|Allegro\nCOUPANG|Coupang\nDARTY|Darty\nVOVA|Vova\nB2W|B2W\nADSENSE|AdSense\nADMOB|AdMob\nWIX|Wix\nGOOGLE_SHOPPING_ACTIONS|Google Shopping Actions\nEMAG|eMAG"
          },
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "currency",
            "description": "币种"
          },
          {
            "schema": {
              "type": "integer"
            },
            "in": "query",
            "name": "status",
            "description": "状态 \n\nstatus|message\n-|-\n1|提现中\n2|提现成功\n3|提现失败"
          },
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "externalTransId",
            "description": "第三方单号"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "total": {
                    "type": "integer"
                  },
                  "list": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/WithdrawInfo"
                    }
                  }
                }
              }
            }
          }
        },
        "tags": [
          "接口"
        ]
      },
      
      "parameters": []
    },
    "/collection/v1/bankcards": {
      "get": {
        "summary": "查询提现银行账号信息",
        "tags": [
          "接口"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "total": {
                      "type": "integer"
                    },
                    "list": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/BankAccountInfo"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "",
        "description": "该接口支持按币种查询客户提现银行账号信息。",
        "parameters": [
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "currency",
            "description": "币种"
          },
          {
            "schema": {
              "type": "integer",
              "default": 1
            },
            "in": "query",
            "name": "pageNum",
            "description": "页码",
            "required": true
          },
          {
            "schema": {
              "type": "integer",
              "maximum": 100,
              "minimum": 1
            },
            "in": "query",
            "name": "pageSize",
            "description": "分页大小",
            "required": true
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "WithdrawInfo": {
        "title": "提现单",
        "type": "object",
        "description": "",
        "x-tags": [
          "对象"
        ],
        "properties": {
          "externalTransId": {
            "type": "string",
            "description": "第三方单号"
          },
          "status": {
            "type": "integer",
            "description": "状态 \n\nstatus|message\n-|-\n1|提现中\n2|提现成功\n3|提现失败"
          },
          "withdrawType": {
            "type": "string",
            "description": "提现类型 \n\nid|message\n-|-\nBALANCE|店铺提现\nWALLET|多比提现\nCREDIT|提前宝"
          },
          "platform": {
            "type": "string",
            "description": "平台"
          },
          "amount": {
            "type": "string",
            "description": "提现金额"
          },
          "currency": {
            "type": "string",
            "description": "提现币种"
          },
          "targetAmount": {
            "type": "string",
            "description": "打款金额"
          },
          "targetCurrency": {
            "type": "string",
            "description": "打款币种"
          },
          "feeAmount": {
            "type": "string",
            "description": "应收手续费"
          },
          "actualFeeAmount": {
            "type": "string",
            "description": "实收手续费"
          },
          "feeCurrency": {
            "type": "string",
            "description": "手续费币种"
          },
          "createTime": {
            "type": "string",
            "description": "创建时间"
          },
          "rate": {
            "type": "string",
            "description": "提现汇率"
          },
          "rateTime": {
            "type": "string",
            "description": "结汇时间"
          },
          "bankAccountName": {
            "type": "string",
            "description": "提现银行账号户名"
          },
          "bankName": {
            "type": "string",
            "description": "银行名称"
          },
          "bankAccountNo": {
            "type": "string",
            "description": "银行账号"
          },
          "withdrawDetailList": {
            "type": "array",
            "description": "明细",
            "items": {
              "$ref": "#/components/schemas/WithdrawDetail"
            }
          },
          "feeRate": {
            "type": "string",
            "description": "手续费费率"
          },
          "creditFeeAmount": {
            "type": "string",
            "description": "提前宝手续费"
          }
        },
        "required": [
          "externalTransId",
          "status",
          "withdrawType",
          "platform",
          "amount",
          "currency",
          "targetAmount",
          "targetCurrency",
          "feeAmount",
          "actualFeeAmount",
          "feeCurrency",
          "createTime",
          "rate",
          "rateTime",
          "bankAccountName",
          "bankName",
          "bankAccountNo",
          "withdrawDetailList",
          "feeRate",
          "creditFeeAmount"
        ]
      },
      "WithdrawDetail": {
        "title": "提现明细",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "明细流水号"
          },
          "shopName": {
            "type": "string",
            "description": "店铺名称"
          },
          "shopAccountId": {
            "type": "string",
            "description": "店铺账号id"
          },
          "amount": {
            "type": "string",
            "description": "金额"
          },
          "currency": {
            "type": "string",
            "description": "币种"
          },
          "feeAmount": {
            "type": "string",
            "description": "应收手续费"
          },
          "actualFeeAmount": {
            "type": "string",
            "description": "实收手续费"
          },
          "feeCurrency": {
            "type": "string",
            "description": "手续费币种"
          },
          "creditFeeAmount": {
            "type": "string",
            "description": "提前宝手续费"
          }
        },
        "required": [
          "id",
          "shopName",
          "shopAccountId",
          "amount",
          "currency",
          "feeAmount",
          "actualFeeAmount",
          "feeCurrency",
          "creditFeeAmount"
        ],
        "x-tags": [
          "对象"
        ]
      },
      "BankAccountInfo": {
        "title": "提现银行账号",
        "type": "object",
        "x-tags": [
          "对象"
        ],
        "description": "",
        "properties": {
          "id": {
            "type": "string",
            "description": "账号ID"
          },
          "bankAccountNo": {
            "type": "string",
            "description": "提现银行账号"
          },
          "bankAccountName": {
            "type": "string",
            "description": "提现银行账号户名"
          },
          "bankName": {
            "type": "string",
            "description": "银行名称"
          },
          "currency": {
            "type": "string",
            "description": "币种列表 [\"USD\"]"
          },
          "district": {
            "type": "string",
            "description": "地区"
          },
          "bankAccountType": {
            "type": "string",
            "description": "银行卡类型\n\nbankAccountType|message\n-|-\n0|借记卡\n1|信用卡\n2|对公银行账号"
          }
        },
        "required": [
          "id",
          "bankAccountNo",
          "bankAccountName",
          "bankName",
          "currency",
          "district",
          "bankAccountType"
        ]
      }
    }
  }
}