{"swagger":"2.0","info":{"description":"## 8퍼센트와 Toss의 제휴서비스를 위해 8퍼센트에서 Toss로 제공되는 API입니다.\n","version":"1.0.0","title":"8PERCENT-TOSS API"},"host":"virtserver.swaggerhub.com","basePath":"/8percent/Toss/1.0.0","schemes":["https"],"security":[{"OAuth2":["toss"]}],"paths":{"/users/":{"get":{"tags":["User"],"summary":"사용자 내역 조회","description":"사용자의 리스트를 볼 수 있습니다.\n","produces":["application/json"],"parameters":[{"name":"joinedAt","in":"query","description":"가입날짜 필터. gt, gte, lt, lte 를 사용할 수 있다. 예를 들어 joinedAt_gt=2017-11-01 로 지정하면 2017-11-01 이후에 가입한 사용자를 대상으로 한다.","required":false,"type":"string"},{"name":"limit","in":"query","description":"몇개의 투자 내역을 보여 줄 것인가","required":false,"type":"integer"},{"name":"offset","in":"query","description":"어디서 부터 조회할 것인가","required":false,"type":"integer"}],"responses":{"200":{"description":"## Response \n- extUserToken: 토스측 사용자 키\n- name: 사용자명\n- joinedAt: 사용자 가입 날짜\n- joinedFromToss: 토스로 부터 가입 되었는지 여부\n","schema":{"$ref":"#/definitions/ArrayOfUsers"}}}}},"/users/{extUserToken}":{"get":{"tags":["User"],"summary":"사용자 상세 조회","description":"사용자의 정보를 볼 수 있습니다.\n","produces":["application/json"],"parameters":[{"name":"extUserToken","in":"path","description":"사용자 ID","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"## Response \n- extUserToken: 토스측 사용자 키\n- name: 사용자명\n- joinedAt: 사용자 가입 날짜\n- balance: 예치금 잔액 \n- irr: 수익율\n- paidAmount: 누적 수익금\n- investment_info: \n  - amount: 투자 금액\n  - count: 분산투자된 수\n  - state: 투자 상태\n    - run: 투자 신청중\n    - normal: 정상 상환중\n    - shortOverdue: 단기 연체\n    - longOverdue: 장기 연체\n    - default: 부도\n    - end: 상환 완료\n  - paidAmount: 누적 수익금\n  - scheduledAmount: 예상 수익금\n  \n  \n","schema":{"$ref":"#/definitions/UserDetail"}}}}},"/portfolios":{"get":{"tags":["Portfolio"],"summary":"전체 포트폴리오 내역 조회","description":"포트폴리오들을 모두 조회한다.","produces":["application/json"],"parameters":[{"name":"createdAt","in":"query","description":"생성날짜 필터. gt, gte, lt, lte 를 사용할 수 있다. 예를 들어  createdAt_gte=2017-11-01 로 지정하면 2017-11-01 이후에 생성된 포트폴리오를 대상으로 한다.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ArrayOfPortfolios"}}}}},"/users/{extUserToken}/portfolio_info":{"get":{"tags":["Portfolio"],"summary":"투자 유형별 정보 제공","description":"각 사용자의 투자 유형별 정보 제공","produces":["application/json"],"parameters":[{"name":"extUserToken","in":"path","description":"사용자 ID","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ArrayOfPortfoliosInfo"}}}}},"/users/{extUserToken}/portfolios":{"get":{"tags":["Portfolio"],"summary":"사용자 포트폴리오 내역 조회","description":"사용자의 포트폴리오들을 모두 조회한다.","produces":["application/json"],"parameters":[{"name":"extUserToken","in":"path","description":"사용자 ID","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ArrayOfPortfolios"}}}}},"/users/{extUserToken}/portfolios/{portfolioUuid}":{"get":{"tags":["Portfolio"],"summary":"사용자 포트폴리오 상세 조회","description":"포트폴리오를 조회한다. 포트폴리오에 포함된 투자건들에 대한 요약 정보를 함께 확인할 수 있다.","produces":["application/json"],"parameters":[{"name":"extUserToken","in":"path","description":"사용자 ID","required":true,"type":"integer","format":"int64"},{"name":"portfolioUuid","in":"path","description":"포트폴리오 unique ID","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Portfolio"}},"400":{"description":"잘못된 포트폴리오 ID 입니다.","schema":{"$ref":"#/definitions/Error"},"examples":{"application/json":{"code":"invalid_portfolio_id","message":"잘못된 포트폴리오 ID 입니다."}}},"403":{"description":"요청된 포트폴리오에 대한 권한이 없습니다.","schema":{"$ref":"#/definitions/Error"},"examples":{"application/json":{"code":"portfolid_forbidden","message":"요청된 포트폴리오에 대한 권한이 없습니다."}}},"404":{"description":"요청된 포트폴리오를 찾을 수 없습니다.","schema":{"$ref":"#/definitions/Error"},"examples":{"application/json":{"code":"portfolio_not_found","message":"요청된 포트폴리오를 찾을 수 없습니다."}}}}}},"/users/{extUserToken}/account":{"get":{"tags":["Account"],"summary":"사용자 계좌정보 조회","parameters":[{"name":"extUserToken","in":"path","description":"사용자 ID","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"계좌 정보","schema":{"$ref":"#/definitions/Account"}}}}},"/users/{extUserToken}/transactions":{"get":{"tags":["Account"],"summary":"사용자 거래 내역 조회","parameters":[{"name":"extUserToken","in":"path","description":"사용자 ID","required":true,"type":"integer","format":"int64"},{"name":"limit","in":"query","description":"몇개의 투자 내역을 보여 줄 것인가","required":false,"type":"integer"},{"name":"offset","in":"query","description":"어디서 부터 조회할 것인가","required":false,"type":"integer"}],"responses":{"200":{"description":"거래 내역. 시간 역순으로 보여 준다.","schema":{"$ref":"#/definitions/ArrayOfTransactions"}}}}}},"securityDefinitions":{"OAuth2":{"type":"oauth2","authorizationUrl":"https://toss.8percent.kr/o/token/","tokenUrl":"https://toss.8percent.kr/o/token/","flow":"accessCode","scopes":{"toss":"can read information about toss"}}},"definitions":{"Token":{"type":"object","properties":{"token":{"type":"string","example":"yJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo1MTAwLCJ1c2VybmFtZSI6ImFzcGlyYXRpb25Aa2Fpc3QuYWMua3IiLCJleHAiOjE1MTE3MTkzOTksImVtYWlsIjoiYXNwaXJhdGlvbkBrYWlzdC5hYy5rciJ9.TixpgxVNqhjR141I1VFZztkWggPrTzwiHxzuIVUEeX0"}}},"User":{"type":"object","properties":{"extUserToken":{"type":"string","example":"e664b125ad39b01df3007b1b5061bd12aa0d7a205b570154b05dd3a6b8127389"},"name":{"type":"string","example":"이호성"},"joinedAt":{"type":"string","example":"2017-09-25T13:23:22.326531Z"},"joinedFromToss":{"type":"string","example":"true"}}},"ArrayOfUsers":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string"},"previous":{"type":"string"},"results":{"$ref":"#/definitions/User"}},"example":{"count":100,"next":"https://toss.8percent.kr/api/v1/users/?limit=10&offset=40","previous":"https://toss.8percent.kr/api/v1/users/?limit=10&offset=20","results":[{"extUserToken":"e664b125ad39b01df3007b1b5061bd12aa0d7a205b570154b05dd3a6b8127389","name":"이호성","joinedAt":"2017-11-17T12:31:00.326Z","joinedFromToss":false},{"extUserToken":"e3409sdk23123ssdkls07b1b5061bd12aa0d7a205b570154b05dd3a6b8127389","name":"차준호","joinedAt":"2017-11-17T13:12:04.326Z","joinedFromToss":true}]}},"UserDetail":{"type":"object","properties":{"extUserToken":{"type":"string","example":"e664b125ad39b01df3007b1b5061bd12aa0d7a205b570154b05dd3a6b8127389"},"name":{"type":"string","example":"이호성"},"joinedAt":{"type":"string","example":"2017-09-25T13:23:22.326531Z"},"joinedFromToss":{"type":"string","example":"true"},"balance":{"type":"integer","example":1000000},"irr":{"type":"number","example":12.9},"paidAmount":{"type":"integer","example":1200},"investment_info":{"$ref":"#/definitions/ArrayOfInvestmentInfo"}},"example":{"balance":1000000,"investment_info":"[{\"state\":\"run\",\"count\":4,\"amount\":100000,\"paidAmount\":4000,\"scheduledAmount\":2000},{\"state\":\"normal\",\"count\":8,\"amount\":100000,\"paidAmount\":4000,\"scheduledAmount\":3500},{\"state\":\"end\",\"count\":10,\"amount\":800000,\"paidAmount\":1200,\"scheduledAmount\":1500},{\"state\":\"default\",\"count\":5,\"amount\":50000,\"paidAmount\":5000,\"scheduledAmount\":4800},{\"state\":\"shortOverdue\",\"count\":12,\"amount\":800000,\"paidAmount\":5000},{\"state\":\"longOverdue\",\"count\":2,\"amount\":20000,\"paidAmount\":1000,\"scheduledAmount\":1500}]","joinedAt":"2017-09-25T13:23:22.326531Z","name":"이호성","joinedFromToss":"true","irr":12.9,"paidAmount":1200,"extUserToken":"e664b125ad39b01df3007b1b5061bd12aa0d7a205b570154b05dd3a6b8127389"}},"ArrayOfInvestmentInfo":{"type":"object","properties":{"count":{"type":"integer","example":8},"amount":{"type":"integer","example":100000},"state":{"type":"string","example":"normal"}},"example":"[{\"state\":\"run\",\"count\":4,\"amount\":100000,\"paidAmount\":4000,\"scheduledAmount\":2000},{\"state\":\"normal\",\"count\":8,\"amount\":100000,\"paidAmount\":4000,\"scheduledAmount\":3500},{\"state\":\"end\",\"count\":10,\"amount\":800000,\"paidAmount\":1200,\"scheduledAmount\":1500},{\"state\":\"default\",\"count\":5,\"amount\":50000,\"paidAmount\":5000,\"scheduledAmount\":4800},{\"state\":\"shortOverdue\",\"count\":12,\"amount\":800000,\"paidAmount\":5000},{\"state\":\"longOverdue\",\"count\":2,\"amount\":20000,\"paidAmount\":1000,\"scheduledAmount\":1500}]"},"InvestmentInfo":{"type":"object","properties":{"count":{"type":"integer","example":8},"amount":{"type":"integer","example":100000},"status":{"type":"string","example":"normal"}}},"Portfolio":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1001},"uuid":{"type":"string","example":"5ce0e9a55ffa654bcee01238041fb31a"},"extUserToken":{"type":"string","example":"f597d8b5c9c7c160b4d3301a97d8c14f6868d336dffae5a4520072e39c8a93e1"},"amount":{"type":"integer","example":100000},"confimedAmount":{"type":"integer","example":80000},"irr":{"type":"integer","example":"9.27"},"period":{"type":"integer","example":12},"interest":{"type":"integer","example":9123},"type":{"type":"string","example":"balancedIncome","enum":["conservationIncome","balancedIncome","aggresiveGrowth"]},"typeName":{"type":"string","example":"균형 투자형","enum":["안정 투자형","균형 투자형","수익 투자형"]},"status":{"type":"string","example":"success","enum":["ready","success","cancel"]},"payToken":{"type":"string","example":"RT_9Vf7mVKXYa977"},"created":{"type":"string","example":"2017-09-25 13:23:22"},"investments":{"$ref":"#/definitions/PortfolioInvestments"}},"example":{"amount":100000,"period":12,"created":"2017-09-25 13:23:22","irr":"9.27","typeName":"균형 투자형","type":"balancedIncome","investments":"","uuid":"5ce0e9a55ffa654bcee01238041fb31a","extUserToken":"f597d8b5c9c7c160b4d3301a97d8c14f6868d336dffae5a4520072e39c8a93e1","confimedAmount":80000,"interest":9123,"id":1001,"status":"success","payToken":"RT_9Vf7mVKXYa977"}},"ArrayOfPortfolios":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string"},"previous":{"type":"string"},"results":{"$ref":"#/definitions/Portfolio"}},"example":{"count":1,"next":"https://toss.8percent.kr/api/v1/portfolios?limit=10&offset=40","previous":"https://toss.8percent.kr/api/v1/portfolios/?limit=10&offset=20","results":[{"id":1001,"uuid":"5ce0e9a55ffa654bcee01238041fb31a","extUserToken":"f597d8b5c9c7c160b4d3301a97d8c14f6868d336dffae5a4520072e39c8a93e1","amount":100000,"confirmedAmount":80000,"irr":9.27,"period":12,"interest":9123,"type":"balancedIncome","typeName":"균형 투자형","status":"success","payToken":"RT_9Vf7mVKXYa977","created":"2017-09-25 13:23:22"},{"id":1002,"uuid":"23312abac0ds0sd879cui32jlk2djksd","extUserToken":"f597d8b5c9c7c160b4d3301a97d8c14f6868d336dffae5a4520072e39c8a93e1","amount":200000,"confirmedAmount":160000,"irr":8.27,"period":6,"interest":5123,"adjusted_interest":7212,"type":"balancedIncome","typeName":"균형 투자형","status":"success","payToken":"RT_9232347mVKXYa977","created":"2017-09-25 15:24:22"}]}},"ArrayOfPortfoliosInfo":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string"},"previous":{"type":"string"},"results":{"$ref":"#/definitions/Portfolio"}},"example":{"results":[{"portfolioType":"conservationIncome","irr":8.87,"minIrr":7.95,"maxIrr":8.83,"name":"안정 투자형","investedCount":3963,"recommended":false,"isAvailable":true},{"portfolioType":"balancedIncome","irr":9.87,"minIrr":8.92,"maxIrr":10.5,"name":"균형 투자형","investedCount":3963,"recommended":true,"isAvailable":true},{"portfolioType":"aggresiveGrowth","irr":11.23,"minIrr":10.78,"maxIrr":11.42,"name":"수익 투자형","investedCount":3963,"recommended":false,"isAvailable":false}]}},"InvestmentsSummary":{"type":"object","properties":{"amounts":{"$ref":"#/definitions/InvestmentsSummary_amounts"},"counts":{"$ref":"#/definitions/InvestmentsSummary_counts"}},"example":{"amounts":{"totalPrincipal":100000,"waitingPrincipal":10000,"runningPrincipal":80000,"finishedPrincipal":10000,"acculmulatedInterest":2000},"counts":{"total":128,"normal":82,"shortOverdue":23,"longOverdue":5,"default":1}}},"Deal":{"type":"object","properties":{"index":{"type":"integer"},"irr":{"type":"number"},"eight_grade":{"type":"string"},"title":{"type":"string"},"kcb_score":{"type":"integer"},"kcb_grade":{"type":"integer"},"period":{"type":"integer"},"link":{"type":"string"},"paybackState":{"type":"string","enum":["상환 중","단기연체","장기연체","부실"]}}},"Transaction":{"type":"object","properties":{"datetime":{"type":"string"},"type":{"type":"string"},"amount":{"type":"integer"},"balance":{"type":"integer"}}},"ArrayOfTransactions":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string"},"previous":{"type":"string"},"results":{"$ref":"#/definitions/Transaction"}},"example":{"count":100,"next":"https://api.8percent.kr/api/v1/user/account/transacionts/?limit=10&offset=40","previous":"https://api.8percent.kr/api/v1/user/account/transactions/?limit=10&offset=20","results":[{"datetime":"2017.05.17 12:31:00","type":"원리금상환","amount":12341,"balance":562756},{"datetime":"2017.05.17 12:32:00","type":"예치금 출금","amount":100000,"balance":462756}]}},"Investment":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"amount":{"type":"integer","format":"int64","example":10000},"link":{"type":"string","example":"https://8percent.kr/my/repayment_detail/?deal_index=4011"},"deal":{"$ref":"#/definitions/Deal"}}},"PortfolioInvestments":{"type":"array","items":{"$ref":"#/definitions/Investment"},"example":"[{\"id\":1,\"amount\":10000,\"link\":\"https://8percent.kr/my/repayment_detail/?deal_index=4011\",\"deal\":{\"index\":4011,\"irr\":9.1,\"eightGrade\":\"B-\",\"title\":\"개인자금\",\"kcbScore\":730,\"kcbGrade\":4,\"period\":12,\"link\":\"https://8percent.kr/investment/deals/4011/\",\"paybackState\":\"상환 중\"}},{\"id\":2,\"amount\":10000,\"link\":\"https://8percent.kr/my/repayment_detail/?deal_index=4010\",\"deal\":{\"index\":4010,\"irr\":10.7,\"eightGrade\":\"C\",\"title\":\"개인자금\",\"kcbScore\":710,\"kcbGrade\":5,\"period\":12,\"link\":\"https://8percent.kr/investment/deals/4010/\",\"paybackState\":\"단기연체\"}}]"},"Account":{"type":"object","properties":{"ownerName":{"type":"string","example":"팔퍼센_이호성"},"number":{"type":"string","example":"79015054819762"},"bankCode":{"type":"string","example":"011"},"bankName":{"type":"string","example":"농협은행"},"balance":{"type":"integer","example":462756}},"example":{"number":"79015054819762","bankCode":"011","ownerName":"팔퍼센_이호성","balance":462756,"bankName":"농협은행"}},"Error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}},"InvestmentsSummary_amounts":{"properties":{"totalPrincipal":{"type":"integer"},"waitingPrincipal":{"type":"integer"},"runningPrincipal":{"type":"integer"},"finishedPrincipal":{"type":"integer"},"accumulatedInterest":{"type":"integer"}}},"InvestmentsSummary_counts":{"properties":{"total":{"type":"integer"},"normal":{"type":"integer"},"shortOverdue":{"type":"integer"},"longOverdue":{"type":"integer"},"default":{"type":"integer"}}}},"responses":{"InvalidPortfolioId":{"description":"잘못된 포트폴리오 ID 입니다.","schema":{"$ref":"#/definitions/Error"},"examples":{"application/json":{"code":"invalid_portfolio_id","message":"잘못된 포트폴리오 ID 입니다."}}},"PortfolioForbidden":{"description":"요청된 포트폴리오에 대한 권한이 없습니다.","schema":{"$ref":"#/definitions/Error"},"examples":{"application/json":{"code":"portfolid_forbidden","message":"요청된 포트폴리오에 대한 권한이 없습니다."}}},"PortfolioNotFound":{"description":"요청된 포트폴리오를 찾을 수 없습니다.","schema":{"$ref":"#/definitions/Error"},"examples":{"application/json":{"code":"portfolio_not_found","message":"요청된 포트폴리오를 찾을 수 없습니다."}}}}}