diff --git a/src/schema/v2.openapi.json b/src/schema/v2.openapi.json index ca28a1f78..1a6b2b1e2 100644 --- a/src/schema/v2.openapi.json +++ b/src/schema/v2.openapi.json @@ -276,13 +276,13 @@ { "name": "isArchived", "in": "query", - "description": "
보관 조회 여부
\ntrue 이면 보관된 할인 분담의 필터 옵션을 조회하고, false 이면 보관되지 않은 할인 분담의 필터 옵션을 조회합니다. 아무 값도 넘기지 않을 경우 기본값은 false 입니다.
\n", + "description": "보관 조회 여부
\ntrue 이면 보관된 할인 분담의 필터 옵션을 조회하고, false 이면 보관되지 않은 할인 분담의 필터 옵션을 조회합니다. 기본값은 false 입니다.
\n", "required": false, "schema": { "type": "boolean" }, "x-portone-title": "보관 조회 여부", - "x-portone-description": "true 이면 보관된 할인 분담의 필터 옵션을 조회하고, false 이면 보관되지 않은 할인 분담의 필터 옵션을 조회합니다. 아무 값도 넘기지 않을 경우 기본값은 false 입니다.
\n" + "x-portone-description": "true 이면 보관된 할인 분담의 필터 옵션을 조회하고, false 이면 보관되지 않은 할인 분담의 필터 옵션을 조회합니다. 기본값은 false 입니다.
\n" } ], "responses": { @@ -345,8 +345,27 @@ }, "/platform/discount-share-policies": { "get": { - "description": "여러 할인 분담을 조회합니다.
\n", + "summary": "할인 분담 정책 다건 조회
\n", + "description": "할인 분담 정책 다건 조회
\n여러 할인 분담을 조회합니다.
\n", "operationId": "getPlatformDiscountSharePolicies", + "parameters": [ + { + "name": "requestBody", + "in": "query", + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetPlatformDiscountSharePoliciesBody" + } + } + }, + "x-portone-query-or-body": { + "enabled": true, + "required": false + } + } + ], "requestBody": { "content": { "application/json": { @@ -355,11 +374,11 @@ } } }, - "required": true + "required": false }, "responses": { "200": { - "description": "성공 응답으로 조회된 파트너 리스트와 페이지 정보가 반환됩니다.
\n", + "description": "성공 응답으로 조회된 할인 분담 정책 리스트와 페이지 정보가 반환됩니다.
\n", "content": { "application/json": { "schema": { @@ -367,7 +386,7 @@ } } }, - "x-portone-description": "성공 응답으로 조회된 파트너 리스트와 페이지 정보가 반환됩니다.
\n" + "x-portone-description": "성공 응답으로 조회된 할인 분담 정책 리스트와 페이지 정보가 반환됩니다.
\n" }, "400": { "description": "InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우여러 할인 분담을 조회합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/GetPlatformDiscountSharePoliciesError" - }, - "x-portone-unstable": true + } }, "post": { - "description": "새로운 할인 분담을 생성합니다.
\n", + "summary": "할인 분담 정책 생성
\n", + "description": "할인 분담 정책 생성
\n새로운 할인 분담을 생성합니다.
\n", "operationId": "createPlatformDiscountSharePolicy", "requestBody": { "content": { @@ -488,6 +509,8 @@ "portOne": [] } ], + "x-portone-category": "platform.policy", + "x-portone-title": "할인 분담 정책 생성", "x-portone-description": "새로운 할인 분담을 생성합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/CreatePlatformDiscountSharePolicyError" @@ -496,7 +519,8 @@ }, "/platform/discount-share-policies/{id}": { "get": { - "description": "주어진 아이디에 대응되는 할인 분담을 조회합니다.
\n", + "summary": "할인 분담 정책 조회
\n", + "description": "할인 분담 정책 조회
\n주어진 아이디에 대응되는 할인 분담을 조회합니다.
\n", "operationId": "getPlatformDiscountSharePolicy", "parameters": [ { @@ -571,13 +595,16 @@ "portOne": [] } ], + "x-portone-category": "platform.policy", + "x-portone-title": "할인 분담 정책 조회", "x-portone-description": "주어진 아이디에 대응되는 할인 분담을 조회합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/GetPlatformDiscountSharePolicyError" } }, "patch": { - "description": "주어진 아이디에 대응되는 할인 분담을 업데이트합니다.
\n", + "summary": "할인 분담 정책 수정
\n", + "description": "할인 분담 정책 수정
\n주어진 아이디에 대응되는 할인 분담을 업데이트합니다.
\n", "operationId": "updatePlatformDiscountSharePolicy", "parameters": [ { @@ -672,6 +699,8 @@ "portOne": [] } ], + "x-portone-category": "platform.policy", + "x-portone-title": "할인 분담 정책 수정", "x-portone-description": "주어진 아이디에 대응되는 할인 분담을 업데이트합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/UpdatePlatformDiscountSharePolicyError" @@ -1038,12 +1067,211 @@ "x-portone-unstable": true } }, - "/platform/discount-share-policies/{id}/archive": {}, - "/platform/discount-share-policies/{id}/recover": {}, + "/platform/discount-share-policies/{id}/archive": { + "post": { + "summary": "할인 분담 정책 보관
\n", + "description": "할인 분담 정책 보관
\n주어진 아이디에 대응되는 할인 분담을 보관합니다.
\n", + "operationId": "archivePlatformDiscountSharePolicy", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "할인 분담 아이디
\n", + "required": true, + "schema": { + "type": "string" + }, + "x-portone-title": "할인 분담 아이디" + } + ], + "responses": { + "200": { + "description": "성공 응답으로 보관된 할인 분담 객체를 반환합니다.
\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ArchivePlatformDiscountSharePolicyResponse" + } + } + }, + "x-portone-description": "성공 응답으로 보관된 할인 분담 객체를 반환합니다.
\n" + }, + "400": { + "description": "InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우UnauthorizedError
: 인증 정보가 올바르지 않은 경우PlatformNotEnabledError
: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우PlatformDiscountSharePolicyNotFoundError
PlatformCannotArchiveScheduledDiscountSharePolicyError
: 예약된 업데이트가 있는 할인 분담 정책을 보관하려고 하는 경우주어진 아이디에 대응되는 할인 분담을 보관합니다.
\n", + "x-portone-error": { + "$ref": "#/components/schemas/ArchivePlatformDiscountSharePolicyError" + } + } + }, + "/platform/discount-share-policies/{id}/recover": { + "post": { + "summary": "할인 분담 정책 복원
\n", + "description": "할인 분담 정책 복원
\n주어진 아이디에 대응되는 할인 분담을 복원합니다.
\n", + "operationId": "recoverPlatformDiscountSharePolicy", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "할인 분담 아이디
\n", + "required": true, + "schema": { + "type": "string" + }, + "x-portone-title": "할인 분담 아이디" + } + ], + "responses": { + "200": { + "description": "성공 응답으로 복원된 할인 분담 객체를 반환합니다.
\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RecoverPlatformDiscountSharePolicyResponse" + } + } + }, + "x-portone-description": "성공 응답으로 복원된 할인 분담 객체를 반환합니다.
\n" + }, + "400": { + "description": "InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우UnauthorizedError
: 인증 정보가 올바르지 않은 경우PlatformNotEnabledError
: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우PlatformDiscountSharePolicyNotFoundError
주어진 아이디에 대응되는 할인 분담을 복원합니다.
\n", + "x-portone-error": { + "$ref": "#/components/schemas/RecoverPlatformDiscountSharePolicyError" + } + } + }, "/platform/additional-fee-policies": { "get": { - "description": "여러 추가 수수료 정책을 조회합니다.
\n", + "summary": "추가 수수료 정책 다건 조회
\n", + "description": "추가 수수료 정책 다건 조회
\n여러 추가 수수료 정책을 조회합니다.
\n", "operationId": "getPlatformAdditionalFeePolicies", + "parameters": [ + { + "name": "requestBody", + "in": "query", + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetPlatformAdditionalFeePoliciesBody" + } + } + }, + "x-portone-query-or-body": { + "enabled": true, + "required": false + } + } + ], "requestBody": { "content": { "application/json": { @@ -1052,7 +1280,7 @@ } } }, - "required": true + "required": false }, "responses": { "200": { @@ -1105,14 +1333,16 @@ "portOne": [] } ], + "x-portone-category": "platform.policy", + "x-portone-title": "추가 수수료 정책 다건 조회", "x-portone-description": "여러 추가 수수료 정책을 조회합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/GetPlatformAdditionalFeePoliciesError" - }, - "x-portone-unstable": true + } }, "post": { - "description": "새로운 추가 수수료 정책을 생성합니다.
\n", + "summary": "추가 수수료 정책 생성
\n", + "description": "추가 수수료 정책 생성
\n새로운 추가 수수료 정책을 생성합니다.
\n", "operationId": "createPlatformAdditionalFeePolicy", "requestBody": { "content": { @@ -1185,6 +1415,8 @@ "portOne": [] } ], + "x-portone-category": "platform.policy", + "x-portone-title": "추가 수수료 정책 생성", "x-portone-description": "새로운 추가 수수료 정책을 생성합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/CreatePlatformAdditionalFeePolicyError" @@ -1193,7 +1425,8 @@ }, "/platform/additional-fee-policies/{id}": { "get": { - "description": "주어진 아이디에 대응되는 추가 수수료 정책을 조회합니다.
\n", + "summary": "추가 수수료 정책 조회
\n", + "description": "추가 수수료 정책 조회
\n주어진 아이디에 대응되는 추가 수수료 정책을 조회합니다.
\n", "operationId": "getPlatformAdditionalFeePolicy", "parameters": [ { @@ -1268,13 +1501,16 @@ "portOne": [] } ], + "x-portone-category": "platform.policy", + "x-portone-title": "추가 수수료 정책 조회", "x-portone-description": "주어진 아이디에 대응되는 추가 수수료 정책을 조회합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/GetPlatformAdditionalFeePolicyError" } }, "patch": { - "description": "주어진 아이디에 대응되는 추가 수수료 정책을 업데이트합니다.
\n", + "summary": "추가 수수료 정책 수정
\n", + "description": "추가 수수료 정책 수정
\n주어진 아이디에 대응되는 추가 수수료 정책을 업데이트합니다.
\n", "operationId": "updatePlatformAdditionalFeePolicy", "parameters": [ { @@ -1369,6 +1605,8 @@ "portOne": [] } ], + "x-portone-category": "platform.policy", + "x-portone-title": "추가 수수료 정책 수정", "x-portone-description": "주어진 아이디에 대응되는 추가 수수료 정책을 업데이트합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/UpdatePlatformAdditionalFeePolicyError" @@ -1733,8 +1971,188 @@ "x-portone-unstable": true } }, - "/platform/additional-fee-policies/{id}/archive": {}, - "/platform/additional-fee-policies/{id}/recover": {}, + "/platform/additional-fee-policies/{id}/archive": { + "post": { + "summary": "추가 수수료 정책 보관
\n", + "description": "추가 수수료 정책 보관
\n주어진 아이디에 대응되는 추가 수수료 정책을 보관합니다.
\n", + "operationId": "archivePlatformAdditionalFeePolicy", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "추가 수수료 정책 아이디
\n", + "required": true, + "schema": { + "type": "string" + }, + "x-portone-title": "추가 수수료 정책 아이디" + } + ], + "responses": { + "200": { + "description": "성공 응답으로 보관된 추가 수수료 정책 객체를 반환합니다.
\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ArchivePlatformAdditionalFeePolicyResponse" + } + } + }, + "x-portone-description": "성공 응답으로 보관된 추가 수수료 정책 객체를 반환합니다.
\n" + }, + "400": { + "description": "InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우UnauthorizedError
: 인증 정보가 올바르지 않은 경우PlatformNotEnabledError
: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우PlatformAdditionalFeePolicyNotFoundError
PlatformCannotArchiveScheduledAdditionalFeePolicyError
: 예약된 업데이트가 있는 추가 수수료 정책을 보관하려고 하는 경우주어진 아이디에 대응되는 추가 수수료 정책을 보관합니다.
\n", + "x-portone-error": { + "$ref": "#/components/schemas/ArchivePlatformAdditionalFeePolicyError" + } + } + }, + "/platform/additional-fee-policies/{id}/recover": { + "post": { + "summary": "추가 수수료 정책 복원
\n", + "description": "추가 수수료 정책 복원
\n주어진 아이디에 대응되는 추가 수수료 정책을 복원합니다.
\n", + "operationId": "recoverPlatformAdditionalFeePolicy", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "추가 수수료 정책 아이디
\n", + "required": true, + "schema": { + "type": "string" + }, + "x-portone-title": "추가 수수료 정책 아이디" + } + ], + "responses": { + "200": { + "description": "성공 응답으로 복원된 추가 수수료 정책 객체를 반환합니다.
\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RecoverPlatformAdditionalFeePolicyResponse" + } + } + }, + "x-portone-description": "성공 응답으로 복원된 추가 수수료 정책 객체를 반환합니다.
\n" + }, + "400": { + "description": "InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우UnauthorizedError
: 인증 정보가 올바르지 않은 경우PlatformNotEnabledError
: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우PlatformAdditionalFeePolicyNotFoundError
주어진 아이디에 대응되는 추가 수수료 정책을 복원합니다.
\n", + "x-portone-error": { + "$ref": "#/components/schemas/RecoverPlatformAdditionalFeePolicyError" + } + } + }, "/platform/partner-filter-options": { "get": { "description": "파트너 다건 조회 시 필요한 필터 옵션을 조회합니다.
\n", @@ -1743,13 +2161,13 @@ { "name": "isArchived", "in": "query", - "description": "보관 조회 여부
\ntrue 이면 보관된 파트너의 필터 옵션을 조회하고, false 이면 보관되지 않은 파트너의 필터 옵션을 조회합니다. 아무 값도 넘기지 않을 경우 기본값은 false 입니다.
\n", + "description": "보관 조회 여부
\ntrue 이면 보관된 파트너의 필터 옵션을 조회하고, false 이면 보관되지 않은 파트너의 필터 옵션을 조회합니다. 기본값은 false 입니다.
\n", "required": false, "schema": { "type": "boolean" }, "x-portone-title": "보관 조회 여부", - "x-portone-description": "true 이면 보관된 파트너의 필터 옵션을 조회하고, false 이면 보관되지 않은 파트너의 필터 옵션을 조회합니다. 아무 값도 넘기지 않을 경우 기본값은 false 입니다.
\n" + "x-portone-description": "true 이면 보관된 파트너의 필터 옵션을 조회하고, false 이면 보관되지 않은 파트너의 필터 옵션을 조회합니다. 기본값은 false 입니다.
\n" } ], "responses": { @@ -1812,8 +2230,27 @@ }, "/platform/partners": { "get": { - "description": "여러 파트너를 조회합니다.
\n", + "summary": "파트너 다건 조회
\n", + "description": "파트너 다건 조회
\n여러 파트너를 조회합니다.
\n", "operationId": "getPlatformPartners", + "parameters": [ + { + "name": "requestBody", + "in": "query", + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetPlatformPartnersBody" + } + } + }, + "x-portone-query-or-body": { + "enabled": true, + "required": false + } + } + ], "requestBody": { "content": { "application/json": { @@ -1822,7 +2259,7 @@ } } }, - "required": true + "required": false }, "responses": { "200": { @@ -1875,14 +2312,16 @@ "portOne": [] } ], + "x-portone-category": "platform.partner", + "x-portone-title": "파트너 다건 조회", "x-portone-description": "여러 파트너를 조회합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/GetPlatformPartnersError" - }, - "x-portone-unstable": true + } }, "post": { - "description": "새로운 파트너를 생성합니다.
\n", + "summary": "파트너 생성
\n", + "description": "파트너 생성
\n새로운 파트너를 생성합니다.
\n", "operationId": "createPlatformPartner", "requestBody": { "content": { @@ -1907,7 +2346,7 @@ "x-portone-description": "성공 응답으로 생성된 파트너 객체가 반환됩니다.
\n" }, "400": { - "description": "InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우PlatformAccountVerificationFailedError
: 파트너 계좌 인증이 실패한 경우PlatformCurrencyNotSupportedError
: 지원 되지 않는 통화를 선택한 경우PlatformContractNotFoundError
PlatformContractNotFoundError
PlatformAccountVerificationNotFoundError
: 파트너 계좌 검증 아이디를 찾을 수 없는 경우PlatformPartnerIdAlreadyExistsError
PlatformPartnerIdAlreadyExistsError
PlatformAccountVerificationAlreadyUsedError
: 파트너 계좌 검증 아이디를 이미 사용한 경우새로운 파트너를 생성합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/CreatePlatformPartnerError" @@ -1974,7 +2415,8 @@ "/platform/partner-dashboard": {}, "/platform/partners/{id}": { "get": { - "description": "파트너 객체를 조회합니다.
\n", + "summary": "파트너 조회
\n", + "description": "파트너 조회
\n파트너 객체를 조회합니다.
\n", "operationId": "getPlatformPartner", "parameters": [ { @@ -2049,13 +2491,16 @@ "portOne": [] } ], + "x-portone-category": "platform.partner", + "x-portone-title": "파트너 조회", "x-portone-description": "파트너 객체를 조회합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/GetPlatformPartnerError" } }, "patch": { - "description": "주어진 아이디에 대응되는 파트너 정보를 업데이트합니다.
\n", + "summary": "파트너 수정
\n", + "description": "파트너 수정
\n주어진 아이디에 대응되는 파트너 정보를 업데이트합니다.
\n", "operationId": "updatePlatformPartner", "parameters": [ { @@ -2092,7 +2537,7 @@ "x-portone-description": "성공 응답으로 업데이트된 파트너 객체가 반환됩니다.
\n" }, "400": { - "description": "InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우PlatformAccountVerificationFailedError
: 파트너 계좌 인증이 실패한 경우PlatformPartnerNotFoundError
PlatformContractNotFoundError
PlatformPartnerNotFoundError
PlatformContractNotFoundError
PlatformAccountVerificationNotFoundError
: 파트너 계좌 검증 아이디를 찾을 수 없는 경우PlatformArchivedPartnerError
: 보관된 파트너를 업데이트하려고 하는 경우PlatformArchivedPartnerError
: 보관된 파트너를 업데이트하려고 하는 경우PlatformAccountVerificationAlreadyUsedError
: 파트너 계좌 검증 아이디를 이미 사용한 경우주어진 아이디에 대응되는 파트너 정보를 업데이트합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/UpdatePlatformPartnerError" @@ -2158,7 +2605,8 @@ }, "/platform/partners/batch": { "post": { - "description": "새로운 파트너를 다건 생성합니다.
\n", + "summary": "파트너 다건 생성
\n", + "description": "파트너 다건 생성
\n새로운 파트너를 다건 생성합니다.
\n", "operationId": "createPlatformPartners", "requestBody": { "content": { @@ -2183,7 +2631,7 @@ "x-portone-title": "성공 응답" }, "400": { - "description": "InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우PlatformPartnerIdsDuplicatedError
InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우PlatformPartnerIdsDuplicatedError
PlatformCurrencyNotSupportedError
: 지원 되지 않는 통화를 선택한 경우새로운 파트너를 다건 생성합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/CreatePlatformPartnersError" @@ -2462,7 +2912,7 @@ "x-portone-description": "성공 응답으로 예약된 파트너 객체가 반환됩니다.
\n" }, "400": { - "description": "InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우PlatformAccountVerificationFailedError
: 파트너 계좌 인증이 실패한 경우PlatformPartnerNotFoundError
PlatformContractNotFoundError
PlatformPartnerNotFoundError
PlatformContractNotFoundError
PlatformAccountVerificationNotFoundError
: 파트너 계좌 검증 아이디를 찾을 수 없는 경우PlatformPartnerScheduleAlreadyExistsError
PlatformArchivedPartnerError
: 보관된 파트너를 업데이트하려고 하는 경우PlatformPartnerScheduleAlreadyExistsError
PlatformArchivedPartnerError
: 보관된 파트너를 업데이트하려고 하는 경우PlatformAccountVerificationAlreadyUsedError
: 파트너 계좌 검증 아이디를 이미 사용한 경우파트너 복원
\n", + "description": "파트너 복원
\n주어진 아이디에 대응되는 파트너를 보관합니다.
\n", + "operationId": "archivePlatformPartner", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "파트너 아이디
\n", + "required": true, + "schema": { + "type": "string" + }, + "x-portone-title": "파트너 아이디" + } + ], + "responses": { + "200": { + "description": "성공 응답으로 보관된 파트너 객체를 반환합니다.
\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ArchivePlatformPartnerResponse" + } + } + }, + "x-portone-description": "성공 응답으로 보관된 파트너 객체를 반환합니다.
\n" + }, + "400": { + "description": "InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우UnauthorizedError
: 인증 정보가 올바르지 않은 경우PlatformNotEnabledError
: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우PlatformPartnerNotFoundError
PlatformCannotArchiveScheduledPartnerError
: 예약된 업데이트가 있는 파트너를 보관하려고 하는 경우주어진 아이디에 대응되는 파트너를 보관합니다.
\n", + "x-portone-error": { + "$ref": "#/components/schemas/ArchivePlatformPartnerError" + } + } + }, + "/platform/partners/{id}/recover": { + "post": { + "summary": "파트너 복원
\n", + "description": "파트너 복원
\n주어진 아이디에 대응되는 파트너를 복원합니다.
\n", + "operationId": "recoverPlatformPartner", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "파트너 아이디
\n", + "required": true, + "schema": { + "type": "string" + }, + "x-portone-title": "파트너 아이디" + } + ], + "responses": { + "200": { + "description": "성공 응답으로 복원된 파트너 객체를 반환합니다.
\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RecoverPlatformPartnerResponse" + } + } + }, + "x-portone-description": "성공 응답으로 복원된 파트너 객체를 반환합니다.
\n" + }, + "400": { + "description": "InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우UnauthorizedError
: 인증 정보가 올바르지 않은 경우PlatformNotEnabledError
: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우PlatformPartnerNotFoundError
주어진 아이디에 대응되는 파트너를 복원합니다.
\n", + "x-portone-error": { + "$ref": "#/components/schemas/RecoverPlatformPartnerError" + } + } + }, "/platform/contracts": { "get": { - "description": "여러 계약을 조회합니다.
\n", + "summary": "계약 다건 조회
\n", + "description": "계약 다건 조회
\n여러 계약을 조회합니다.
\n", "operationId": "getPlatformContracts", + "parameters": [ + { + "name": "requestBody", + "in": "query", + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetPlatformContractsBody" + } + } + }, + "x-portone-query-or-body": { + "enabled": true, + "required": false + } + } + ], "requestBody": { "content": { "application/json": { @@ -2712,7 +3361,7 @@ } } }, - "required": true + "required": false }, "responses": { "200": { @@ -2765,14 +3414,16 @@ "portOne": [] } ], + "x-portone-category": "platform.policy", + "x-portone-title": "계약 다건 조회", "x-portone-description": "여러 계약을 조회합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/GetPlatformContractsError" - }, - "x-portone-unstable": true + } }, "post": { - "description": "새로운 계약을 생성합니다.
\n", + "summary": "계약 생성
\n", + "description": "계약 생성
\n새로운 계약을 생성합니다.
\n", "operationId": "createPlatformContract", "requestBody": { "content": { @@ -2845,6 +3496,8 @@ "portOne": [] } ], + "x-portone-category": "platform.policy", + "x-portone-title": "계약 생성", "x-portone-description": "새로운 계약을 생성합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/CreatePlatformContractError" @@ -2853,6 +3506,8 @@ }, "/platform/contracts/{id}": { "get": { + "summary": "계약 조회
\n", + "description": "계약 조회
\n주어진 아이디에 대응되는 계약을 조회합니다.
\n", "operationId": "getPlatformContract", "parameters": [ { @@ -2927,12 +3582,16 @@ "portOne": [] } ], + "x-portone-category": "platform.policy", + "x-portone-title": "계약 조회", + "x-portone-description": "주어진 아이디에 대응되는 계약을 조회합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/GetPlatformContractError" } }, "patch": { - "description": "주어진 아이디에 대응되는 계약을 업데이트합니다.
\n", + "summary": "계약 수정
\n", + "description": "계약 수정
\n주어진 아이디에 대응되는 계약을 업데이트합니다.
\n", "operationId": "updatePlatformContract", "parameters": [ { @@ -3027,6 +3686,8 @@ "portOne": [] } ], + "x-portone-category": "platform.policy", + "x-portone-title": "계약 수정", "x-portone-description": "주어진 아이디에 대응되는 계약을 업데이트합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/UpdatePlatformContractError" @@ -3393,31 +4054,216 @@ "x-portone-unstable": true } }, - "/platform/contracts/{id}/archive": {}, - "/platform/contracts/{id}/recover": {}, + "/platform/contracts/{id}/archive": { + "post": { + "summary": "계약 보관
\n", + "description": "계약 보관
\n주어진 아이디에 대응되는 계약을 보관합니다.
\n", + "operationId": "archivePlatformContract", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "계약 아이디
\n", + "required": true, + "schema": { + "type": "string" + }, + "x-portone-title": "계약 아이디" + } + ], + "responses": { + "200": { + "description": "성공 응답으로 보관된 계약 객체를 반환합니다.
\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ArchivePlatformContractResponse" + } + } + }, + "x-portone-description": "성공 응답으로 보관된 계약 객체를 반환합니다.
\n" + }, + "400": { + "description": "InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우UnauthorizedError
: 인증 정보가 올바르지 않은 경우PlatformNotEnabledError
: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우PlatformContractNotFoundError
PlatformCannotArchiveScheduledContractError
: 예약된 업데이트가 있는 계약을 보관하려고 하는 경우주어진 아이디에 대응되는 계약을 보관합니다.
\n", + "x-portone-error": { + "$ref": "#/components/schemas/ArchivePlatformContractError" + } + } + }, + "/platform/contracts/{id}/recover": { + "post": { + "summary": "계약 복원
\n", + "description": "계약 복원
\n주어진 아이디에 대응되는 계약을 복원합니다.
\n", + "operationId": "recoverPlatformContract", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "계약 아이디
\n", + "required": true, + "schema": { + "type": "string" + }, + "x-portone-title": "계약 아이디" + } + ], + "responses": { + "200": { + "description": "성공 응답으로 복원된 계약 객체를 반환합니다.
\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RecoverPlatformContractResponse" + } + } + }, + "x-portone-description": "성공 응답으로 복원된 계약 객체를 반환합니다.
\n" + }, + "400": { + "description": "InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우UnauthorizedError
: 인증 정보가 올바르지 않은 경우PlatformNotEnabledError
: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우PlatformContractNotFoundError
주어진 아이디에 대응되는 계약을 복원합니다.
\n", + "x-portone-error": { + "$ref": "#/components/schemas/RecoverPlatformContractError" + } + } + }, "/platform/transfers/{id}": { "get": { + "summary": "정산건 조회
\n", + "description": "정산건 조회
\n정산건을 조회합니다.
\n", "operationId": "getPlatformTransfer", "parameters": [ { "name": "id", "in": "path", + "description": "조회하고 싶은 정산건 아이디
\n", "required": true, "schema": { "type": "string" - } + }, + "x-portone-title": "조회하고 싶은 정산건 아이디" } ], "responses": { "200": { - "description": "", + "description": "성공 응답으로 정산건 객체가 반환됩니다.
\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformTransfer" } } - } + }, + "x-portone-description": "성공 응답으로 정산건 객체가 반환됩니다.
\n" }, "400": { "description": "InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우정산건을 조회합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/GetPlatformTransferError" } }, "delete": { + "summary": "정산건 삭제
\n", + "description": "정산건 삭제
\nscheduled, in_process 상태의 정산건만 삭제가능합니다.
\n", "operationId": "deletePlatformTransfer", "parameters": [ { @@ -3546,14 +4397,109 @@ "portOne": [] } ], + "x-portone-category": "platform.transfer", + "x-portone-title": "정산건 삭제", + "x-portone-description": "scheduled, in_process 상태의 정산건만 삭제가능합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/DeletePlatformTransferError" } } }, - "/platform/transfer-summaries": {}, + "/platform/transfer-summaries": { + "get": { + "summary": "정산건 다건 조회
\n", + "description": "정산건 다건 조회
\n성공 응답으로 조회된 정산건 요약 리스트와 페이지 정보가 반환됩니다.
\n", + "operationId": "getPlatformTransferSummaries", + "parameters": [ + { + "name": "requestBody", + "in": "query", + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetPlatformTransferSummariesBody" + } + } + }, + "x-portone-query-or-body": { + "enabled": true, + "required": false + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetPlatformTransferSummariesBody" + } + } + }, + "required": false + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetPlatformTransferSummariesResponse" + } + } + } + }, + "400": { + "description": "InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우UnauthorizedError
: 인증 정보가 올바르지 않은 경우PlatformNotEnabledError
: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우성공 응답으로 조회된 정산건 요약 리스트와 페이지 정보가 반환됩니다.
\n", + "x-portone-error": { + "$ref": "#/components/schemas/GetPlatformTransferSummariesError" + } + } + }, "/platform/transfers/order": { "post": { + "summary": "주문 정산건 생성
\n", + "description": "주문 정산건 생성
\n성공 응답으로 생성된 주문 정산건 객체가 반환됩니다.
\n", "operationId": "createPlatformOrderTransfer", "requestBody": { "content": { @@ -3635,6 +4581,9 @@ "portOne": [] } ], + "x-portone-category": "platform.transfer", + "x-portone-title": "주문 정산건 생성", + "x-portone-description": "성공 응답으로 생성된 주문 정산건 객체가 반환됩니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/CreatePlatformOrderTransferError" } @@ -3642,6 +4591,8 @@ }, "/platform/transfers/order-cancel": { "post": { + "summary": "주문 취소 정산건 생성
\n", + "description": "주문 취소 정산건 생성
\n성공 응답으로 생성된 주문 취소 정산건 객체가 반환됩니다.
\n", "operationId": "createPlatformOrderCancelTransfer", "requestBody": { "content": { @@ -3723,6 +4674,9 @@ "portOne": [] } ], + "x-portone-category": "platform.transfer", + "x-portone-title": "주문 취소 정산건 생성", + "x-portone-description": "성공 응답으로 생성된 주문 취소 정산건 객체가 반환됩니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/CreatePlatformOrderCancelTransferError" } @@ -3730,6 +4684,8 @@ }, "/platform/transfers/manual": { "post": { + "summary": "수기 정산건 생성
\n", + "description": "수기 정산건 생성
\n성공 응답으로 생성된 수기 정산건 객체가 반환됩니다.
\n", "operationId": "createPlatformManualTransfer", "requestBody": { "content": { @@ -3801,6 +4757,9 @@ "portOne": [] } ], + "x-portone-category": "platform.transfer", + "x-portone-title": "수기 정산건 생성", + "x-portone-description": "성공 응답으로 생성된 수기 정산건 객체가 반환됩니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/CreatePlatformManualTransferError" } @@ -3808,16 +4767,99 @@ }, "/platform/transfer-dashboard": {}, "/platform/transfer-filter-options": {}, + "/platform/transfer-summaries/sheet-file": { + "get": { + "summary": "정산 상세 내역 다운로드
\n", + "description": "정산 상세 내역 다운로드
\n정산 상세 내역을 csv 파일로 다운로드 합니다.
\n", + "operationId": "downloadPlatformTransferSheet", + "parameters": [ + { + "name": "requestBody", + "in": "query", + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DownloadPlatformTransferSheetBody" + } + } + }, + "x-portone-query-or-body": { + "enabled": true, + "required": true + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DownloadPlatformTransferSheetBody" + } + } + }, + "required": false + }, + "responses": { + "200": { + "description": "", + "content": { + "text/csv": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "400": { + "description": "InvalidRequestError
: 요청된 입력 정보가 유효하지 않은 경우UnauthorizedError
: 인증 정보가 올바르지 않은 경우정산 상세 내역을 csv 파일로 다운로드 합니다.
\n", + "x-portone-error": { + "$ref": "#/components/schemas/DownloadPlatformTransferSheetError" + } + } + }, "/platform/payable-settlement-dates": {}, "/platform/partner-settlements": {}, - "/platform/partner-settlement-filter-options": {}, + "/platform/partner-settlements/settlement-dates": {}, + "/platform/partner-settlements/currencies": {}, + "/platform/partner-settlements/dashboard": {}, + "/platform/partner-settlements/sheet-file": {}, "/platform/payouts/{id}": {}, "/platform/payouts": {}, - "/platform/payouts/{id}/complete": {}, - "/platform/payouts/{payoutId}/partner-settlements": {}, - "/platform/payout-partner-settlements/{id}": {}, - "/platform/payouts/{id}/sheets": {}, - "/platform/payouts/{id}/sheet-file": {}, + "/platform/bulk-payouts/{id}": {}, + "/platform/bulk-payouts": {}, + "/platform/bulk-payouts/{bulkPayoutId}/partner-settlements": {}, "/platform/bank-accounts/{bank}/{accountNumber}/holder": { "get": { "summary": "예금주 조회
\n", @@ -3845,26 +4887,26 @@ "x-portone-title": "'-'를 제외한 계좌 번호" }, { - "name": "birthDate", + "name": "birthdate", "in": "query", - "description": "생년월일
\n실명 조회를 위해 추가로 보낼 수 있습니다. birthDate과 businessRegistrationNumber 중 하나만 사용해야 합니다.
\n", + "description": "생년월일
\n실명 조회를 위해 추가로 보낼 수 있습니다. birthdate과 businessRegistrationNumber 중 하나만 사용해야 합니다.
\n", "required": false, "schema": { "type": "string" }, "x-portone-title": "생년월일", - "x-portone-description": "실명 조회를 위해 추가로 보낼 수 있습니다. birthDate과 businessRegistrationNumber 중 하나만 사용해야 합니다.
\n" + "x-portone-description": "실명 조회를 위해 추가로 보낼 수 있습니다. birthdate과 businessRegistrationNumber 중 하나만 사용해야 합니다.
\n" }, { "name": "businessRegistrationNumber", "in": "query", - "description": "사업자등록번호
\n실명 조회를 위해 추가로 보낼 수 있습니다. birthDate과 businessRegistrationNumber 중 하나만 사용해야 합니다.
\n", + "description": "사업자등록번호
\n실명 조회를 위해 추가로 보낼 수 있습니다. birthdate과 businessRegistrationNumber 중 하나만 사용해야 합니다.
\n", "required": false, "schema": { "type": "string" }, "x-portone-title": "사업자등록번호", - "x-portone-description": "실명 조회를 위해 추가로 보낼 수 있습니다. birthDate과 businessRegistrationNumber 중 하나만 사용해야 합니다.
\n" + "x-portone-description": "실명 조회를 위해 추가로 보낼 수 있습니다. birthdate과 businessRegistrationNumber 중 하나만 사용해야 합니다.
\n" } ], "responses": { @@ -3928,12 +4970,12 @@ "portOne": [] } ], + "x-portone-category": "platform.account", "x-portone-title": "예금주 조회", "x-portone-description": "계좌의 예금주를 조회합니다.
\n", "x-portone-error": { "$ref": "#/components/schemas/GetPlatformAccountHolderError" - }, - "x-portone-unstable": true + } } }, "/identity-verifications/{identityVerificationId}": { @@ -11257,7 +12299,9 @@ "$ref": "#/components/schemas/RegisterStoreReceiptError" } } - } + }, + "/platform/payouts-sheet": {}, + "/platform/bulk-payouts-sheet": {} }, "components": { "schemas": { @@ -18031,54 +19075,6 @@ "description": "가상계좌 말소 성공 응답
\n", "x-portone-title": "가상계좌 말소 성공 응답" }, - "CompletePlatformPayoutError": { - "oneOf": [ - { - "$ref": "#/components/schemas/ForbiddenError" - }, - { - "$ref": "#/components/schemas/InvalidRequestError" - }, - { - "$ref": "#/components/schemas/PlatformNotEnabledError" - }, - { - "$ref": "#/components/schemas/PlatformPayoutAlreadyCompletedError" - }, - { - "$ref": "#/components/schemas/PlatformPayoutCreatorMismatchedError" - }, - { - "$ref": "#/components/schemas/PlatformPayoutNotFoundError" - }, - { - "$ref": "#/components/schemas/UnauthorizedError" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "FORBIDDEN": "#/components/schemas/ForbiddenError", - "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", - "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", - "PLATFORM_PAYOUT_ALREADY_COMPLETED": "#/components/schemas/PlatformPayoutAlreadyCompletedError", - "PLATFORM_PAYOUT_CREATOR_MISMATCHED": "#/components/schemas/PlatformPayoutCreatorMismatchedError", - "PLATFORM_PAYOUT_NOT_FOUND": "#/components/schemas/PlatformPayoutNotFoundError", - "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" - } - } - }, - "CompletePlatformPayoutResponse": { - "required": [ - "payout" - ], - "type": "object", - "properties": { - "payout": { - "$ref": "#/components/schemas/PlatformPayout" - } - } - }, "ConfirmEscrowBody": { "title": "에스크로 구매 확정 입력 정보", "type": "object", @@ -19657,6 +20653,7 @@ "x-portone-title": "할인 분담 정책 생성 성공 응답" }, "CreatePlatformManualTransferBody": { + "title": "수기 정산건 생성을 위한 입력 정보", "required": [ "partnerId", "settlementAmount", @@ -19665,24 +20662,32 @@ "type": "object", "properties": { "partnerId": { - "type": "string" + "type": "string", + "title": "파트너 아이디" }, "memo": { - "type": "string" + "type": "string", + "title": "메모" }, "settlementAmount": { "type": "integer", - "format": "int64" + "format": "int64", + "title": "정산 금액" }, "settlementDate": { "type": "string", "description": "날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
기본값은 false 입니다.
\n" } - } + }, + "description": "수기 정산건 생성을 위한 입력 정보
\n", + "x-portone-title": "수기 정산건 생성을 위한 입력 정보" }, "CreatePlatformManualTransferError": { "oneOf": [ @@ -19714,7 +20719,7 @@ } }, "CreatePlatformOrderCancelTransferBody": { - "title": "취소 정산 등록을 위한 입력 정보", + "title": "주문 취소 정산 등록을 위한 입력 정보", "required": [ "cancellationId", "discounts" @@ -19722,24 +20727,31 @@ "type": "object", "properties": { "partnerId": { - "type": "string" + "type": "string", + "title": "파트너 아이디" }, "paymentId": { - "type": "string" + "type": "string", + "title": "결제 아이디" }, "transferId": { - "type": "string" + "type": "string", + "title": "정산건 아이디" }, "cancellationId": { - "type": "string" + "type": "string", + "title": "취소 내역 아이디" }, "memo": { - "type": "string" + "type": "string", + "title": "메모" }, "orderDetail": { - "$ref": "#/components/schemas/CreatePlatformOrderCancelTransferBodyOrderDetail" + "$ref": "#/components/schemas/CreatePlatformOrderCancelTransferBodyOrderDetail", + "title": "주문 취소 정보" }, "discounts": { + "title": "할인 정보", "type": "array", "items": { "$ref": "#/components/schemas/CreatePlatformOrderCancelTransferBodyDiscount" @@ -19748,20 +20760,26 @@ "settlementStartDate": { "type": "string", "description": "날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
해당 정보가 존재하는 경우 외부 결제 취소 정산건으로 등록되고, 존재하지않은 경우 포트원 결제 취소 정산건으로 등록됩니다.
\n" }, "isForTest": { - "type": "boolean" + "type": "boolean", + "title": "테스트 모드 여부", + "description": "기본값은 false 입니다.
\n" } }, - "description": "취소 정산 등록을 위한 입력 정보
\n하나의 payment에 하나의 정산 건만 존재하는 경우에는 (partnerId, paymentId)로 취소 정산을 등록하실 수 있습니다.\n하나의 payment에 여러 개의 정산 건이 존재하는 경우에는 transferId를 필수로 입력해야 합니다.\ntransferId를 입력한 경우 (partnerId, paymentId)는 생략 가능합니다.
\n", - "x-portone-title": "취소 정산 등록을 위한 입력 정보", + "description": "주문 취소 정산 등록을 위한 입력 정보
\n하나의 payment에 하나의 정산 건만 존재하는 경우에는 (partnerId, paymentId)로 취소 정산을 등록하실 수 있습니다.\n하나의 payment에 여러 개의 정산 건이 존재하는 경우에는 transferId를 필수로 입력해야 합니다.\ntransferId를 입력한 경우 (partnerId, paymentId)는 생략 가능합니다.
\n", + "x-portone-title": "주문 취소 정산 등록을 위한 입력 정보", "x-portone-description": "하나의 payment에 하나의 정산 건만 존재하는 경우에는 (partnerId, paymentId)로 취소 정산을 등록하실 수 있습니다.\n하나의 payment에 여러 개의 정산 건이 존재하는 경우에는 transferId를 필수로 입력해야 합니다.\ntransferId를 입력한 경우 (partnerId, paymentId)는 생략 가능합니다.
\n" }, "CreatePlatformOrderCancelTransferBodyDiscount": { + "title": "할인 정보", "required": [ "sharePolicyId", "amount" @@ -19769,45 +20787,64 @@ "type": "object", "properties": { "sharePolicyId": { - "type": "string" + "type": "string", + "title": "할인 분담 정책 아이디" }, "amount": { "type": "integer", - "format": "int64" + "format": "int64", + "title": "할인 금액" } - } + }, + "description": "할인 정보
\n", + "x-portone-title": "할인 정보" }, "CreatePlatformOrderCancelTransferBodyExternalCancellationDetail": { + "title": "외부 결제 상세 정보", "type": "object", "properties": { "cancelledAt": { "type": "string", - "format": "date-time" + "format": "date-time", + "title": "취소 일시" } - } + }, + "description": "외부 결제 상세 정보
\n", + "x-portone-title": "외부 결제 상세 정보" }, "CreatePlatformOrderCancelTransferBodyOrderDetail": { + "title": "주문 취소 정보", "type": "object", "properties": { "orderAmount": { "type": "integer", - "format": "int64" + "format": "int64", + "title": "주문 취소 금액" }, "orderLines": { + "title": "주문 취소 항목 리스트", "type": "array", "items": { "$ref": "#/components/schemas/CreatePlatformOrderCancelTransferBodyOrderLine" } }, "all": { - "$ref": "#/components/schemas/CreatePlatformOrderCancelTransferBodyOrderDetailAll" + "$ref": "#/components/schemas/CreatePlatformOrderCancelTransferBodyOrderDetailAll", + "title": "전체 금액 취소" } - } + }, + "description": "주문 취소 정보
\norderAmount, orderLines, all 중에서 하나만 입력하여야 합니다.
\n", + "x-portone-title": "주문 취소 정보", + "x-portone-description": "orderAmount, orderLines, all 중에서 하나만 입력하여야 합니다.
\n" }, "CreatePlatformOrderCancelTransferBodyOrderDetailAll": { - "type": "object" + "title": "전체 금액 취소", + "type": "object", + "description": "전체 금액 취소
\n", + "x-portone-title": "전체 금액 취소" }, "CreatePlatformOrderCancelTransferBodyOrderLine": { + "title": "주문 취소 항목 리스트", "required": [ "productId", "quantity", @@ -19816,19 +20853,24 @@ "type": "object", "properties": { "productId": { - "type": "string" + "type": "string", + "title": "상품 아이디" }, "quantity": { "type": "integer", - "format": "int32" + "format": "int32", + "title": "상품 수량" }, "discounts": { + "title": "상품 할인 정보", "type": "array", "items": { "$ref": "#/components/schemas/CreatePlatformOrderCancelTransferBodyDiscount" } } - } + }, + "description": "주문 취소 항목 리스트
\n", + "x-portone-title": "주문 취소 항목 리스트" }, "CreatePlatformOrderCancelTransferError": { "oneOf": [ @@ -19916,6 +20958,7 @@ } }, "CreatePlatformOrderTransferBody": { + "title": "주문 정산건 생성을 위한 입력 정보", "required": [ "partnerId", "paymentId", @@ -19926,57 +20969,77 @@ "type": "object", "properties": { "partnerId": { - "type": "string" + "type": "string", + "title": "파트너 아이디" }, "contractId": { - "type": "string" + "type": "string", + "title": "계약 아이디", + "description": "기본값은 파트너의 기본 계약 아이디 입니다.
\n" }, "memo": { - "type": "string" + "type": "string", + "title": "메모" }, "paymentId": { - "type": "string" + "type": "string", + "title": "결제 아이디" }, "orderDetail": { - "$ref": "#/components/schemas/CreatePlatformOrderTransferBodyOrderDetail" + "$ref": "#/components/schemas/CreatePlatformOrderTransferBodyOrderDetail", + "title": "주문 정보" }, "settlementStartDate": { "type": "string", - "description": "날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
기본값은 결제 일시 입니다.
\n", + "x-portone-description": "날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
해당 정보가 존재하는 경우 외부 결제 정산건 으로 등록되고, 존재하지않은 경우 포트원 결제 정산건으로 등록됩니다.
\n" }, "isForTest": { - "type": "boolean" + "type": "boolean", + "title": "테스트 모드 여부", + "description": "기본값은 false 입니다.
\n" } - } + }, + "description": "주문 정산건 생성을 위한 입력 정보
\n", + "x-portone-title": "주문 정산건 생성을 위한 입력 정보" }, "CreatePlatformOrderTransferBodyAdditionalFee": { + "title": "추가 수수료 정보", "required": [ "policyId" ], "type": "object", "properties": { "policyId": { - "type": "string" + "type": "string", + "title": "추가 수수료 정책 아이디" } - } + }, + "description": "추가 수수료 정보
\n", + "x-portone-title": "추가 수수료 정보" }, "CreatePlatformOrderTransferBodyDiscount": { + "title": "할인 정보", "required": [ "sharePolicyId", "amount" @@ -19984,51 +21047,69 @@ "type": "object", "properties": { "sharePolicyId": { - "type": "string" + "type": "string", + "title": "할인 분담 정책 아이디" }, "amount": { "type": "integer", - "format": "int64" + "format": "int64", + "title": "할인 금액" } - } + }, + "description": "할인 정보
\n", + "x-portone-title": "할인 정보" }, "CreatePlatformOrderTransferBodyExternalPaymentDetail": { + "title": "외부 결제 상세 정보", "required": [ "currency" ], "type": "object", "properties": { "currency": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/Currency", + "title": "통화" }, "orderName": { - "type": "string" + "type": "string", + "title": "주문 명" }, "paidAt": { "type": "string", - "format": "date-time" + "format": "date-time", + "title": "결제 일시" }, "method": { - "$ref": "#/components/schemas/PlatformPaymentMethodInput" + "$ref": "#/components/schemas/PlatformPaymentMethodInput", + "title": "결제 수단" } - } + }, + "description": "외부 결제 상세 정보
\n", + "x-portone-title": "외부 결제 상세 정보" }, "CreatePlatformOrderTransferBodyOrderDetail": { + "title": "주문 정보", "type": "object", "properties": { "orderAmount": { "type": "integer", - "format": "int64" + "format": "int64", + "title": "주문 금액" }, "orderLines": { + "title": "주문 항목 리스트", "type": "array", "items": { "$ref": "#/components/schemas/CreatePlatformOrderTransferBodyOrderLine" } } - } + }, + "description": "주문 정보
\n주문 금액 또는 주문 항목 하나만 입력 가능합니다.
\n", + "x-portone-title": "주문 정보", + "x-portone-description": "주문 금액 또는 주문 항목 하나만 입력 가능합니다.
\n" }, "CreatePlatformOrderTransferBodyOrderLine": { + "title": "주문 항목", "required": [ "product", "quantity", @@ -20038,27 +21119,34 @@ "type": "object", "properties": { "product": { - "$ref": "#/components/schemas/CreatePlatformOrderTransferBodyProduct" + "$ref": "#/components/schemas/CreatePlatformOrderTransferBodyProduct", + "title": "상품" }, "quantity": { "type": "integer", - "format": "int32" + "format": "int32", + "title": "상품 수량" }, "discounts": { + "title": "상품 할인 정보", "type": "array", "items": { "$ref": "#/components/schemas/CreatePlatformOrderTransferBodyDiscount" } }, "additionalFees": { + "title": "상품 추가 수수료 정보", "type": "array", "items": { "$ref": "#/components/schemas/CreatePlatformOrderTransferBodyAdditionalFee" } } - } + }, + "description": "주문 항목
\n", + "x-portone-title": "주문 항목" }, "CreatePlatformOrderTransferBodyProduct": { + "title": "상품", "required": [ "id", "name", @@ -20067,19 +21155,25 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "title": "상품 아이디" }, "name": { - "type": "string" + "type": "string", + "title": "상품 이름" }, "amount": { "type": "integer", - "format": "int64" + "format": "int64", + "title": "상품 금액" }, "tag": { - "type": "string" + "type": "string", + "title": "태그" } - } + }, + "description": "상품
\n", + "x-portone-title": "상품" }, "CreatePlatformOrderTransferError": { "oneOf": [ @@ -20152,7 +21246,8 @@ "contact", "account", "defaultContractId", - "tags" + "tags", + "type" ], "type": "object", "properties": { @@ -20226,6 +21321,10 @@ "holder": { "type": "string", "title": "예금주명" + }, + "accountVerificationId": { + "type": "string", + "title": "계좌 검증 아이디" } }, "description": "파트너 계좌 등록을 위한 정보
\n", @@ -20307,9 +21406,6 @@ } }, "CreatePlatformPartnerBodyTypeWhtPayer": { - "required": [ - "birthdate" - ], "type": "object", "properties": { "birthdate": { @@ -20323,9 +21419,21 @@ { "$ref": "#/components/schemas/InvalidRequestError" }, + { + "$ref": "#/components/schemas/PlatformAccountVerificationAlreadyUsedError" + }, + { + "$ref": "#/components/schemas/PlatformAccountVerificationFailedError" + }, + { + "$ref": "#/components/schemas/PlatformAccountVerificationNotFoundError" + }, { "$ref": "#/components/schemas/PlatformContractNotFoundError" }, + { + "$ref": "#/components/schemas/PlatformCurrencyNotSupportedError" + }, { "$ref": "#/components/schemas/PlatformNotEnabledError" }, @@ -20340,7 +21448,11 @@ "propertyName": "type", "mapping": { "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", + "PLATFORM_ACCOUNT_VERIFICATION_ALREADY_USED": "#/components/schemas/PlatformAccountVerificationAlreadyUsedError", + "PLATFORM_ACCOUNT_VERIFICATION_FAILED": "#/components/schemas/PlatformAccountVerificationFailedError", + "PLATFORM_ACCOUNT_VERIFICATION_NOT_FOUND": "#/components/schemas/PlatformAccountVerificationNotFoundError", "PLATFORM_CONTRACT_NOT_FOUND": "#/components/schemas/PlatformContractNotFoundError", + "PLATFORM_CURRENCY_NOT_SUPPORTED": "#/components/schemas/PlatformCurrencyNotSupportedError", "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", "PLATFORM_PARTNER_ID_ALREADY_EXISTS": "#/components/schemas/PlatformPartnerIdAlreadyExistsError", "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" @@ -20388,6 +21500,9 @@ { "$ref": "#/components/schemas/PlatformContractsNotFoundError" }, + { + "$ref": "#/components/schemas/PlatformCurrencyNotSupportedError" + }, { "$ref": "#/components/schemas/PlatformNotEnabledError" }, @@ -20406,6 +21521,7 @@ "mapping": { "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", "PLATFORM_CONTRACTS_NOT_FOUND": "#/components/schemas/PlatformContractsNotFoundError", + "PLATFORM_CURRENCY_NOT_SUPPORTED": "#/components/schemas/PlatformCurrencyNotSupportedError", "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", "PLATFORM_PARTNER_IDS_ALREADY_EXISTS": "#/components/schemas/PlatformPartnerIdsAlreadyExistError", "PLATFORM_PARTNER_IDS_DUPLICATED": "#/components/schemas/PlatformPartnerIdsDuplicatedError", @@ -20431,61 +21547,6 @@ "description": "파트너 다건 생성 성공 응답
\n", "x-portone-title": "파트너 다건 생성 성공 응답" }, - "CreatePlatformPayoutBody": { - "required": [ - "filter" - ], - "type": "object", - "properties": { - "filter": { - "$ref": "#/components/schemas/PlatformPartnerSettlementFilterInput" - } - } - }, - "CreatePlatformPayoutError": { - "oneOf": [ - { - "$ref": "#/components/schemas/ForbiddenError" - }, - { - "$ref": "#/components/schemas/InvalidRequestError" - }, - { - "$ref": "#/components/schemas/PlatformNoPayablePartnerSettlementsError" - }, - { - "$ref": "#/components/schemas/PlatformNotEnabledError" - }, - { - "$ref": "#/components/schemas/PlatformOngoingPayoutExistsError" - }, - { - "$ref": "#/components/schemas/UnauthorizedError" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "FORBIDDEN": "#/components/schemas/ForbiddenError", - "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", - "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", - "PLATFORM_NO_PAYABLE_PARTNER_SETTLEMENTS": "#/components/schemas/PlatformNoPayablePartnerSettlementsError", - "PLATFORM_ONGOING_PAYOUT_EXISTS": "#/components/schemas/PlatformOngoingPayoutExistsError", - "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" - } - } - }, - "CreatePlatformPayoutResponse": { - "required": [ - "payout" - ], - "type": "object", - "properties": { - "payout": { - "$ref": "#/components/schemas/PlatformPayout" - } - } - }, "Currency": { "title": "통화 단위", "type": "string", @@ -21545,46 +22606,6 @@ "description": "빌링키 삭제 성공 응답
\n", "x-portone-title": "빌링키 삭제 성공 응답" }, - "DeletePlatformPayoutError": { - "oneOf": [ - { - "$ref": "#/components/schemas/ForbiddenError" - }, - { - "$ref": "#/components/schemas/InvalidRequestError" - }, - { - "$ref": "#/components/schemas/PlatformNotEnabledError" - }, - { - "$ref": "#/components/schemas/PlatformPayoutAlreadyCompletedError" - }, - { - "$ref": "#/components/schemas/PlatformPayoutCreatorMismatchedError" - }, - { - "$ref": "#/components/schemas/PlatformPayoutNotFoundError" - }, - { - "$ref": "#/components/schemas/UnauthorizedError" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "FORBIDDEN": "#/components/schemas/ForbiddenError", - "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", - "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", - "PLATFORM_PAYOUT_ALREADY_COMPLETED": "#/components/schemas/PlatformPayoutAlreadyCompletedError", - "PLATFORM_PAYOUT_CREATOR_MISMATCHED": "#/components/schemas/PlatformPayoutCreatorMismatchedError", - "PLATFORM_PAYOUT_NOT_FOUND": "#/components/schemas/PlatformPayoutNotFoundError", - "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" - } - } - }, - "DeletePlatformPayoutResponse": { - "type": "object" - }, "DeletePlatformTransferError": { "oneOf": [ { @@ -21656,19 +22677,130 @@ "description": "배송 완료
\n", "x-portone-title": "배송 완료" }, - "DownloadPlatformPayoutSheetError": { + "DownloadPlatformBulkPayoutsSheetBody": { + "type": "object", + "properties": { + "filter": { + "$ref": "#/components/schemas/PlatformBulkPayoutFilterInput" + }, + "fields": { + "title": "다운로드 할 시트 컬럼", + "type": "array", + "items": { + "$ref": "#/components/schemas/PlatformBulkPayoutsSheetField" + } + }, + "isForTest": { + "type": "boolean" + } + } + }, + "DownloadPlatformBulkPayoutsSheetError": { "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestError" }, { - "$ref": "#/components/schemas/PlatformNotEnabledError" + "$ref": "#/components/schemas/UnauthorizedError" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", + "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" + } + } + }, + "DownloadPlatformPartnerSettlementSheetBody": { + "type": "object", + "properties": { + "filter": { + "$ref": "#/components/schemas/PlatformPartnerSettlementFilterInput" + }, + "fields": { + "title": "다운로드 할 시트 컬럼", + "type": "array", + "items": { + "$ref": "#/components/schemas/PlatformPartnerSettlementSheetField" + } }, + "isForTest": { + "type": "boolean" + } + } + }, + "DownloadPlatformPartnerSettlementSheetError": { + "oneOf": [ { - "$ref": "#/components/schemas/PlatformPayoutNotFoundError" + "$ref": "#/components/schemas/InvalidRequestError" }, { - "$ref": "#/components/schemas/PlatformPayoutSheetNotFoundError" + "$ref": "#/components/schemas/UnauthorizedError" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", + "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" + } + } + }, + "DownloadPlatformPayoutsSheetBody": { + "type": "object", + "properties": { + "filter": { + "$ref": "#/components/schemas/PlatformPayoutFilterInput" + }, + "fields": { + "title": "다운로드 할 시트 컬럼", + "type": "array", + "items": { + "$ref": "#/components/schemas/PlatformPayoutsSheetField" + } + }, + "isForTest": { + "type": "boolean" + } + } + }, + "DownloadPlatformPayoutsSheetError": { + "oneOf": [ + { + "$ref": "#/components/schemas/InvalidRequestError" + }, + { + "$ref": "#/components/schemas/UnauthorizedError" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", + "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" + } + } + }, + "DownloadPlatformTransferSheetBody": { + "type": "object", + "properties": { + "filter": { + "$ref": "#/components/schemas/PlatformTransferFilterInput" + }, + "fields": { + "title": "다운로드 할 시트 컬럼", + "type": "array", + "items": { + "$ref": "#/components/schemas/PlatformTransferSheetField" + } + } + } + }, + "DownloadPlatformTransferSheetError": { + "oneOf": [ + { + "$ref": "#/components/schemas/InvalidRequestError" }, { "$ref": "#/components/schemas/UnauthorizedError" @@ -21678,9 +22810,6 @@ "propertyName": "type", "mapping": { "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", - "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", - "PLATFORM_PAYOUT_NOT_FOUND": "#/components/schemas/PlatformPayoutNotFoundError", - "PLATFORM_PAYOUT_SHEET_NOT_FOUND": "#/components/schemas/PlatformPayoutSheetNotFoundError", "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" } } @@ -24049,9 +25178,6 @@ }, "GetPlatformAdditionalFeePoliciesBody": { "title": "추가 수수료 정책 다건 조회를 위한 입력 정보", - "required": [ - "page" - ], "type": "object", "properties": { "page": { @@ -24160,6 +25286,149 @@ } } }, + "GetPlatformBulkPayoutError": { + "oneOf": [ + { + "$ref": "#/components/schemas/InvalidRequestError" + }, + { + "$ref": "#/components/schemas/PlatformBulkPayoutNotFoundError" + }, + { + "$ref": "#/components/schemas/PlatformNotEnabledError" + }, + { + "$ref": "#/components/schemas/UnauthorizedError" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", + "PLATFORM_BULK_PAYOUT_NOT_FOUND": "#/components/schemas/PlatformBulkPayoutNotFoundError", + "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", + "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" + } + } + }, + "GetPlatformBulkPayoutPartnerSettlementsBody": { + "type": "object", + "properties": { + "filter": { + "$ref": "#/components/schemas/PlatformBulkPayoutPartnerSettlementsFilterInput" + }, + "page": { + "$ref": "#/components/schemas/PageInput" + }, + "isForTest": { + "type": "boolean" + } + } + }, + "GetPlatformBulkPayoutPartnerSettlementsError": { + "oneOf": [ + { + "$ref": "#/components/schemas/InvalidRequestError" + }, + { + "$ref": "#/components/schemas/PlatformBulkPayoutNotFoundError" + }, + { + "$ref": "#/components/schemas/PlatformNotEnabledError" + }, + { + "$ref": "#/components/schemas/UnauthorizedError" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", + "PLATFORM_BULK_PAYOUT_NOT_FOUND": "#/components/schemas/PlatformBulkPayoutNotFoundError", + "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", + "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" + } + } + }, + "GetPlatformBulkPayoutPartnerSettlementsResponse": { + "required": [ + "items", + "page", + "counts" + ], + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PlatformBulkPayoutPartnerSettlement" + } + }, + "page": { + "$ref": "#/components/schemas/PageInfo" + }, + "counts": { + "$ref": "#/components/schemas/PlatformPartnerSettlementStatusStats" + } + } + }, + "GetPlatformBulkPayoutsBody": { + "type": "object", + "properties": { + "isForTest": { + "type": "boolean" + }, + "page": { + "$ref": "#/components/schemas/PageInput" + }, + "filter": { + "$ref": "#/components/schemas/PlatformBulkPayoutFilterInput" + } + } + }, + "GetPlatformBulkPayoutsError": { + "oneOf": [ + { + "$ref": "#/components/schemas/InvalidRequestError" + }, + { + "$ref": "#/components/schemas/PlatformNotEnabledError" + }, + { + "$ref": "#/components/schemas/UnauthorizedError" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", + "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", + "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" + } + } + }, + "GetPlatformBulkPayoutsResponse": { + "required": [ + "items", + "page", + "counts" + ], + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PlatformBulkPayout" + } + }, + "page": { + "$ref": "#/components/schemas/PageInfo" + }, + "counts": { + "$ref": "#/components/schemas/PlatformBulkPayoutStatusStats" + } + } + }, "GetPlatformContractError": { "oneOf": [ { @@ -24429,7 +25698,7 @@ "isForTest": { "type": "boolean", "title": "테스트 조회 여부", - "description": "true 이면 isForTest 가 true 인 파트너들을 조회하고, false 이면 isForTest 가 false 인 파트너들을 조회합니다. 아무 값도 넘기지 않을 경우 기본값은 false 입니다.
\n" + "description": "true 이면 isForTest 가 true 인 파트너들을 조회하고, false 이면 isForTest 가 false 인 파트너들을 조회합니다. 기본값은 false 입니다.
\n" } }, "description": "파트너 현황 조회를 위한 입력 정보
\n", @@ -24527,7 +25796,72 @@ } } }, - "GetPlatformPartnerSettlementFilterOptionsError": { + "GetPlatformPartnerSettlementCurrenciesBody": { + "required": [ + "isForTest" + ], + "type": "object", + "properties": { + "isForTest": { + "type": "boolean" + } + } + }, + "GetPlatformPartnerSettlementCurrenciesError": { + "oneOf": [ + { + "$ref": "#/components/schemas/InvalidRequestError" + }, + { + "$ref": "#/components/schemas/PlatformNotEnabledError" + }, + { + "$ref": "#/components/schemas/UnauthorizedError" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", + "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", + "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" + } + } + }, + "GetPlatformPartnerSettlementCurrenciesResponse": { + "title": "정산내역 통화 조회 결과", + "required": [ + "settlementCurrencies" + ], + "type": "object", + "properties": { + "settlementCurrencies": { + "title": "통화 단위", + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } + } + }, + "description": "정산내역 통화 조회 결과
\n", + "x-portone-title": "정산내역 통화 조회 결과" + }, + "GetPlatformPartnerSettlementDashboardBody": { + "required": [ + "filter", + "isForTest" + ], + "type": "object", + "properties": { + "filter": { + "$ref": "#/components/schemas/PlatformPartnerSettlementFilterInput" + }, + "isForTest": { + "type": "boolean" + } + } + }, + "GetPlatformPartnerSettlementDashboardError": { "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestError" @@ -24548,10 +25882,62 @@ } } }, + "GetPlatformPartnerSettlementDatesBody": { + "required": [ + "isForTest" + ], + "type": "object", + "properties": { + "isForTest": { + "type": "boolean" + } + } + }, + "GetPlatformPartnerSettlementDatesError": { + "oneOf": [ + { + "$ref": "#/components/schemas/InvalidRequestError" + }, + { + "$ref": "#/components/schemas/PlatformNotEnabledError" + }, + { + "$ref": "#/components/schemas/UnauthorizedError" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", + "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", + "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" + } + } + }, + "GetPlatformPartnerSettlementDatesResponse": { + "title": "정산일 리스트 조회 결과", + "required": [ + "settlementDates" + ], + "type": "object", + "properties": { + "settlementDates": { + "type": "array", + "items": { + "type": "string", + "description": "날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
정산일 리스트 조회 결과
\n", + "x-portone-title": "정산일 리스트 조회 결과" + }, "GetPlatformPartnerSettlementsBody": { "title": "정산내역 다건 조회를 위한 입력 정보", "required": [ - "filter" + "filter", + "isForTest" ], "type": "object", "properties": { @@ -24562,6 +25948,9 @@ "filter": { "$ref": "#/components/schemas/PlatformPartnerSettlementFilterInput", "title": "조회할 정산내역 조건 필터" + }, + "isForTest": { + "type": "boolean" } }, "description": "정산내역 다건 조회를 위한 입력 정보
\n", @@ -24592,7 +25981,8 @@ "title": "정산내역 다건 조회 성공 응답 정보", "required": [ "items", - "page" + "page", + "counts" ], "type": "object", "properties": { @@ -24606,6 +25996,10 @@ "page": { "$ref": "#/components/schemas/PageInfo", "title": "조회된 페이지 정보" + }, + "counts": { + "$ref": "#/components/schemas/PlatformPartnerSettlementStatusStats", + "title": "정산내역 상태 별 갯수" } }, "description": "정산내역 다건 조회 성공 응답 정보
\n", @@ -24737,81 +26131,12 @@ } } }, - "GetPlatformPayoutPartnerSettlementsBody": { - "type": "object", - "properties": { - "page": { - "$ref": "#/components/schemas/PageInput" - } - } - }, - "GetPlatformPayoutPartnerSettlementsError": { - "oneOf": [ - { - "$ref": "#/components/schemas/InvalidRequestError" - }, - { - "$ref": "#/components/schemas/PlatformNotEnabledError" - }, - { - "$ref": "#/components/schemas/PlatformPayoutNotFoundError" - }, - { - "$ref": "#/components/schemas/UnauthorizedError" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", - "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", - "PLATFORM_PAYOUT_NOT_FOUND": "#/components/schemas/PlatformPayoutNotFoundError", - "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" - } - } - }, - "GetPlatformPayoutSheetsError": { - "oneOf": [ - { - "$ref": "#/components/schemas/InvalidRequestError" - }, - { - "$ref": "#/components/schemas/PlatformNotEnabledError" - }, - { - "$ref": "#/components/schemas/PlatformPayoutNotFoundError" - }, - { - "$ref": "#/components/schemas/UnauthorizedError" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", - "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", - "PLATFORM_PAYOUT_NOT_FOUND": "#/components/schemas/PlatformPayoutNotFoundError", - "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" - } - } - }, - "GetPlatformPayoutSheetsResponse": { - "required": [ - "items" - ], - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PayoutSheet" - } - } - } - }, "GetPlatformPayoutsBody": { "type": "object", "properties": { + "isForTest": { + "type": "boolean" + }, "page": { "$ref": "#/components/schemas/PageInput" }, @@ -24844,7 +26169,8 @@ "GetPlatformPayoutsResponse": { "required": [ "items", - "page" + "page", + "counts" ], "type": "object", "properties": { @@ -24856,6 +26182,9 @@ }, "page": { "$ref": "#/components/schemas/PageInfo" + }, + "counts": { + "$ref": "#/components/schemas/PlatformPayoutStatusStats" } } }, @@ -24943,15 +26272,20 @@ } }, "GetPlatformTransferSummariesBody": { + "title": "정산건 요약 다건 조회를 위한 입력 정보", "type": "object", "properties": { "page": { - "$ref": "#/components/schemas/PageInput" + "$ref": "#/components/schemas/PageInput", + "title": "요청할 페이지 정보" }, "filter": { - "$ref": "#/components/schemas/PlatformTransferFilterInput" + "$ref": "#/components/schemas/PlatformTransferFilterInput", + "title": "조회할 정산건 조건 필터" } - } + }, + "description": "정산건 요약 다건 조회를 위한 입력 정보
\n", + "x-portone-title": "정산건 요약 다건 조회를 위한 입력 정보" }, "GetPlatformTransferSummariesError": { "oneOf": [ @@ -28755,50 +30089,6 @@ "description": "결제 건 및 커서 정보
\n", "x-portone-title": "결제 건 및 커서 정보" }, - "PayoutPartnerSettlementsResponse": { - "required": [ - "items", - "page" - ], - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PlatformPayoutPartnerSettlement" - } - }, - "page": { - "$ref": "#/components/schemas/PageInfo" - } - } - }, - "PayoutSheet": { - "required": [ - "payoutId", - "settlementCurrency", - "payoutCurrency", - "name" - ], - "type": "object", - "properties": { - "payoutId": { - "type": "string" - }, - "contractId": { - "type": "string" - }, - "settlementCurrency": { - "$ref": "#/components/schemas/Currency" - }, - "payoutCurrency": { - "$ref": "#/components/schemas/Currency" - }, - "name": { - "type": "string" - } - } - }, "PendingPaymentSchedule": { "title": "결제 대기 상태", "required": [ @@ -29195,13 +30485,18 @@ "PlatformAccountHolder": { "title": "예금주 조회 성공 응답 정보", "required": [ - "holderName" + "holderName", + "accountVerificationId" ], "type": "object", "properties": { "holderName": { "type": "string", "title": "계좌 예금주 이름" + }, + "accountVerificationId": { + "type": "string", + "title": "계좌 검증 아이디" } }, "description": "예금주 조회 성공 응답 정보
\n", @@ -29237,6 +30532,60 @@ } } }, + "PlatformAccountVerificationAlreadyUsedError": { + "title": "파트너 계좌 검증 아이디를 이미 사용한 경우", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "description": "파트너 계좌 검증 아이디를 이미 사용한 경우
\n", + "x-portone-title": "파트너 계좌 검증 아이디를 이미 사용한 경우", + "x-portone-status-code": 409 + }, + "PlatformAccountVerificationFailedError": { + "title": "파트너 계좌 인증이 실패한 경우", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "description": "파트너 계좌 인증이 실패한 경우
\n", + "x-portone-title": "파트너 계좌 인증이 실패한 경우", + "x-portone-status-code": 400 + }, + "PlatformAccountVerificationNotFoundError": { + "title": "파트너 계좌 검증 아이디를 찾을 수 없는 경우", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "description": "파트너 계좌 검증 아이디를 찾을 수 없는 경우
\n", + "x-portone-title": "파트너 계좌 검증 아이디를 찾을 수 없는 경우", + "x-portone-status-code": 404 + }, "PlatformAdditionalFeePoliciesNotFoundError": { "required": [ "type", @@ -29280,7 +30629,8 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "title": "추가 수수료 정책 고유 아이디" }, "graphqlId": { "type": "string" @@ -29337,7 +30687,7 @@ "isArchived": { "type": "boolean", "title": "보관 조회 여부", - "description": "true 이면 보관된 추가 수수료 정책의 필터 옵션을 조회하고, false 이면 보관되지 않은 추가 수수료 정책의 필터 옵션을 조회합니다. 아무 값도 넘기지 않을 경우 기본값은 false 입니다.
\n" + "description": "true 이면 보관된 추가 수수료 정책의 필터 옵션을 조회하고, false 이면 보관되지 않은 추가 수수료 정책의 필터 옵션을 조회합니다. 기본값은 false 입니다.
\n" }, "vatPayers": { "title": "금액 부담 주체", @@ -29527,6 +30877,309 @@ "x-portone-title": "보관된 파트너들을 예약 업데이트하려고 하는 경우", "x-portone-status-code": 409 }, + "PlatformBulkPayout": { + "required": [ + "id", + "graphqlId", + "name", + "creatorId", + "method", + "arePayoutsGenerated", + "totalPayoutAmount", + "status", + "payoutStats", + "statusUpdatedAt", + "createdAt", + "updatedAt" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "일괄 지급 고유 아이디" + }, + "graphqlId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "creatorId": { + "type": "string" + }, + "method": { + "$ref": "#/components/schemas/PlatformPayoutMethod" + }, + "arePayoutsGenerated": { + "type": "boolean" + }, + "totalPayoutAmount": { + "type": "integer", + "format": "int64" + }, + "status": { + "$ref": "#/components/schemas/PlatformBulkPayoutStatus" + }, + "payoutStats": { + "$ref": "#/components/schemas/PlatformBulkPayoutStats" + }, + "statusUpdatedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + } + } + }, + "PlatformBulkPayoutFilterInput": { + "type": "object", + "properties": { + "statuses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PlatformBulkPayoutStatus" + } + }, + "methods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PlatformPayoutMethod" + } + }, + "criteria": { + "$ref": "#/components/schemas/PlatformBulkPayoutFilterInputCriteria" + } + } + }, + "PlatformBulkPayoutFilterInputCriteria": { + "type": "object", + "properties": { + "timestampRange": { + "$ref": "#/components/schemas/DateTimeRange" + }, + "bulkPayoutId": { + "type": "string" + } + } + }, + "PlatformBulkPayoutNotFoundError": { + "title": "일괄 지급이 존재하지 않는 경우", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "description": "일괄 지급이 존재하지 않는 경우
\n", + "x-portone-title": "일괄 지급이 존재하지 않는 경우", + "x-portone-status-code": 404 + }, + "PlatformBulkPayoutPartnerSettlement": { + "required": [ + "bulkPayoutId", + "partnerSettlement", + "isSelected" + ], + "type": "object", + "properties": { + "bulkPayoutId": { + "type": "string" + }, + "partnerSettlement": { + "$ref": "#/components/schemas/PlatformPartnerSettlement" + }, + "isSelected": { + "type": "boolean" + } + } + }, + "PlatformBulkPayoutPartnerSettlementsFilterInput": { + "required": [ + "partnerIds", + "statuses" + ], + "type": "object", + "properties": { + "partnerIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "title": "정산 상태", + "type": "array", + "items": { + "$ref": "#/components/schemas/PlatformPartnerSettlementStatus" + } + } + } + }, + "PlatformBulkPayoutStats": { + "required": [ + "amount", + "count" + ], + "type": "object", + "properties": { + "amount": { + "$ref": "#/components/schemas/PlatformPayoutStatusStats" + }, + "count": { + "$ref": "#/components/schemas/PlatformPayoutStatusStats" + } + } + }, + "PlatformBulkPayoutStatus": { + "type": "string", + "enum": [ + "CANCELLED", + "COMPLETED", + "ONGOING", + "PREPARED", + "PREPARING", + "STOPPED" + ], + "x-portone-enum": { + "STOPPED": {}, + "PREPARED": {}, + "CANCELLED": {}, + "COMPLETED": {}, + "PREPARING": {}, + "ONGOING": {} + } + }, + "PlatformBulkPayoutStatusStats": { + "required": [ + "preparing", + "prepared", + "ongoing", + "stopped", + "cancelled", + "completed" + ], + "type": "object", + "properties": { + "preparing": { + "type": "integer", + "format": "int64" + }, + "prepared": { + "type": "integer", + "format": "int64" + }, + "ongoing": { + "type": "integer", + "format": "int64" + }, + "stopped": { + "type": "integer", + "format": "int64" + }, + "cancelled": { + "type": "integer", + "format": "int64" + }, + "completed": { + "type": "integer", + "format": "int64" + } + } + }, + "PlatformBulkPayoutsSheetField": { + "title": "다운로드 할 시트 컬럼", + "type": "string", + "description": "다운로드 할 시트 컬럼
\n", + "enum": [ + "BULK_PAYOUT_ID", + "CREATED_AT", + "CREATOR_ID", + "METHOD", + "NAME", + "PAYOUT_CANCELLED_AMOUNT", + "PAYOUT_CANCELLED_COUNT", + "PAYOUT_FAILED_AMOUNT", + "PAYOUT_FAILED_COUNT", + "PAYOUT_PREPARED_AMOUNT", + "PAYOUT_PREPARED_COUNT", + "PAYOUT_STOPPED_AMOUNT", + "PAYOUT_STOPPED_COUNT", + "PAYOUT_SUCCEEDED_AMOUNT", + "PAYOUT_SUCCEEDED_COUNT", + "STATUS", + "STATUS_UPDATED_AT", + "TOTAL_PAYOUT_AMOUNT" + ], + "x-portone-title": "다운로드 할 시트 컬럼", + "x-portone-enum": { + "PAYOUT_FAILED_AMOUNT": { + "title": "지급 실패 금액" + }, + "NAME": { + "title": "일괄 지급 이름" + }, + "PAYOUT_PREPARED_AMOUNT": { + "title": "지급 대기 금액" + }, + "METHOD": { + "title": "일괄 지급 방식" + }, + "PAYOUT_SUCCEEDED_AMOUNT": { + "title": "지급 성공 금액" + }, + "PAYOUT_SUCCEEDED_COUNT": { + "title": "지급 성공 건수" + }, + "PAYOUT_PREPARED_COUNT": { + "title": "지급 대기 건수" + }, + "PAYOUT_FAILED_COUNT": { + "title": "지급 실패 건수" + }, + "PAYOUT_STOPPED_COUNT": { + "title": "지급 중단 건수" + }, + "STATUS_UPDATED_AT": { + "title": "일괄 지급 상태 변경 시각" + }, + "PAYOUT_CANCELLED_AMOUNT": { + "title": "지급 취소 금액" + }, + "PAYOUT_STOPPED_AMOUNT": { + "title": "지급 중단 금액" + }, + "CREATED_AT": { + "title": "일괄 지급 생성 시각" + }, + "TOTAL_PAYOUT_AMOUNT": { + "title": "총 지급 금액" + }, + "STATUS": { + "title": "일괄 지급 상태" + }, + "BULK_PAYOUT_ID": { + "title": "일괄 지급 아이디" + }, + "CREATOR_ID": { + "title": "생성자 아이디" + }, + "PAYOUT_CANCELLED_COUNT": { + "title": "지급 취소 건수" + } + } + }, "PlatformCancelOrderTransfersExistsError": { "required": [ "type" @@ -29719,53 +31372,6 @@ "x-portone-title": "예약된 업데이트가 있는 파트너를 보관하려고 하는 경우", "x-portone-status-code": 409 }, - "PlatformCompletedPayout": { - "required": [ - "status", - "id", - "graphqlId", - "creatorId", - "settlementDate", - "summary", - "filter", - "createdAt", - "paidOutAt" - ], - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "id": { - "type": "string" - }, - "graphqlId": { - "type": "string" - }, - "creatorId": { - "type": "string" - }, - "settlementDate": { - "type": "string", - "description": "날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
true 이면 보관된 계약을 조회하고, false 이면 보관되지 않은 계약을 조회합니다. 아무 값도 넘기지 않을 경우 기본값은 false 입니다.
\n" + "description": "true 이면 보관된 계약을 조회하고, false 이면 보관되지 않은 계약을 조회합니다. 기본값은 false 입니다.
\n" }, "keyword": { "$ref": "#/components/schemas/PlatformContractFilterInputKeyword", @@ -30016,6 +31622,24 @@ }, "x-portone-status-code": 404 }, + "PlatformCurrencyNotSupportedError": { + "title": "지원 되지 않는 통화를 선택한 경우", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "description": "지원 되지 않는 통화를 선택한 경우
\n", + "x-portone-title": "지원 되지 않는 통화를 선택한 경우", + "x-portone-status-code": 400 + }, "PlatformDiscountCancelExceededOrderCancelAmountError": { "required": [ "type" @@ -30143,7 +31767,7 @@ "isArchived": { "type": "boolean", "title": "보관 조회 여부", - "description": "true 이면 보관된 할인 분담 정책을 조회하고, false 이면 보관되지 않은 할인 분담 정책을 조회합니다. 아무 값도 넘기지 않을 경우 기본값은 false 입니다.
\n" + "description": "true 이면 보관된 할인 분담 정책을 조회하고, false 이면 보관되지 않은 할인 분담 정책을 조회합니다. 기본값은 false 입니다.
\n" }, "partnerShareRates": { "type": "array", @@ -30287,6 +31911,7 @@ "x-portone-status-code": 503 }, "PlatformExternalPayment": { + "title": "외부 결제 정보", "required": [ "type", "id", @@ -30298,22 +31923,29 @@ "type": "string" }, "id": { - "type": "string" + "type": "string", + "title": "결제 아이디" }, "orderName": { - "type": "string" + "type": "string", + "title": "주문 명" }, "currency": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/Currency", + "title": "통화" }, "method": { - "$ref": "#/components/schemas/PlatformPaymentMethod" + "$ref": "#/components/schemas/PlatformPaymentMethod", + "title": "결제 수단" }, "paidAt": { "type": "string", - "format": "date-time" + "format": "date-time", + "title": "결제 일시" } - } + }, + "description": "외부 결제 정보
\n", + "x-portone-title": "외부 결제 정보" }, "PlatformFee": { "title": "플랫폼 중개수수료 정보", @@ -30430,6 +32062,7 @@ "x-portone-status-code": 400 }, "PlatformManualTransfer": { + "title": "수기 정산건", "required": [ "type", "id", @@ -30447,27 +32080,33 @@ "type": "string" }, "id": { - "type": "string" + "type": "string", + "title": "정산건 아이디" }, "graphqlId": { "type": "string" }, "partner": { - "$ref": "#/components/schemas/PlatformPartner" + "$ref": "#/components/schemas/PlatformPartner", + "title": "파트너" }, "status": { - "$ref": "#/components/schemas/PlatformTransferStatus" + "$ref": "#/components/schemas/PlatformTransferStatus", + "title": "정산 상태" }, "memo": { - "type": "string" + "type": "string", + "title": "메모" }, "settlementDate": { "type": "string", "description": "날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
수기 정산건
\n", + "x-portone-title": "수기 정산건" }, "PlatformManualTransferSummary": { "required": [ @@ -30533,7 +32176,8 @@ } } }, - "PlatformNoPayablePartnerSettlementsError": { + "PlatformNonUpdatableStatusError": { + "title": "업데이트 불가능한 상태를 업데이트하려는 경우", "required": [ "type" ], @@ -30546,6 +32190,8 @@ "type": "string" } }, + "description": "업데이트 불가능한 상태를 업데이트하려는 경우
\n", + "x-portone-title": "업데이트 불가능한 상태를 업데이트하려는 경우", "x-portone-status-code": 400 }, "PlatformNotEnabledError": { @@ -30566,64 +32212,8 @@ "x-portone-title": "플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우", "x-portone-status-code": 403 }, - "PlatformOngoingPayout": { - "required": [ - "status", - "id", - "graphqlId", - "creatorId", - "settlementDate", - "summary", - "filter", - "createdAt" - ], - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "id": { - "type": "string" - }, - "graphqlId": { - "type": "string" - }, - "creatorId": { - "type": "string" - }, - "settlementDate": { - "type": "string", - "description": "날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
주문 취소 정산건
\n", + "x-portone-title": "주문 취소 정산건" }, "PlatformOrderCancelTransferSummary": { "required": [ @@ -30794,6 +32401,7 @@ "x-portone-status-code": 400 }, "PlatformOrderSettlementAmount": { + "title": "정산 금액 정보", "required": [ "settlement", "payment", @@ -30865,9 +32473,13 @@ "format": "int64", "title": "할인 분담 금액" } - } + }, + "description": "정산 금액 정보
\n정산 금액과 정산 금액 계산에 사용된 금액 정보들 입니다.
\n", + "x-portone-title": "정산 금액 정보", + "x-portone-description": "정산 금액과 정산 금액 계산에 사용된 금액 정보들 입니다.
\n" }, "PlatformOrderTransfer": { + "title": "주문 정산건", "required": [ "type", "id", @@ -30891,27 +32503,33 @@ "type": "string" }, "id": { - "type": "string" + "type": "string", + "title": "정산건 아이디" }, "graphqlId": { "type": "string" }, "partner": { - "$ref": "#/components/schemas/PlatformPartner" + "$ref": "#/components/schemas/PlatformPartner", + "title": "파트너" }, "status": { - "$ref": "#/components/schemas/PlatformTransferStatus" + "$ref": "#/components/schemas/PlatformTransferStatus", + "title": "정산 상태" }, "memo": { - "type": "string" + "type": "string", + "title": "메모" }, "settlementDate": { "type": "string", "description": "날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
주문 정산건
\n", + "x-portone-title": "주문 정산건" }, "PlatformOrderTransferAdditionalFee": { + "title": "추가 수수료 정보", "required": [ "policy", "amount", @@ -30965,17 +32594,22 @@ "type": "object", "properties": { "policy": { - "$ref": "#/components/schemas/PlatformAdditionalFeePolicy" + "$ref": "#/components/schemas/PlatformAdditionalFeePolicy", + "title": "추가 수수료 정책" }, "amount": { "type": "integer", - "format": "int64" + "format": "int64", + "title": "추가 수수료 금액" }, "vat": { "type": "integer", - "format": "int64" + "format": "int64", + "title": "추가 수수료 부가세 금액" } - } + }, + "description": "추가 수수료 정보
\n", + "x-portone-title": "추가 수수료 정보" }, "PlatformOrderTransferAlreadyCancelledError": { "required": [ @@ -30993,6 +32627,7 @@ "x-portone-status-code": 400 }, "PlatformOrderTransferCancellation": { + "title": "주문 취소 정보", "required": [ "id", "cancelledAt" @@ -31000,15 +32635,20 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "title": "주문 취소 아이디" }, "cancelledAt": { "type": "string", - "format": "date-time" + "format": "date-time", + "title": "취소 일시" } - } + }, + "description": "주문 취소 정보
\n", + "x-portone-title": "주문 취소 정보" }, "PlatformOrderTransferDiscount": { + "title": "할인 정보", "required": [ "sharePolicy", "amount", @@ -31017,19 +32657,25 @@ "type": "object", "properties": { "sharePolicy": { - "$ref": "#/components/schemas/PlatformDiscountSharePolicy" + "$ref": "#/components/schemas/PlatformDiscountSharePolicy", + "title": "할인 분담 정책" }, "amount": { "type": "integer", - "format": "int64" + "format": "int64", + "title": "할인 금액" }, "shareAmount": { "type": "integer", - "format": "int64" + "format": "int64", + "title": "할인 분담 금액" } - } + }, + "description": "할인 정보
\n", + "x-portone-title": "할인 정보" }, "PlatformOrderTransferOrderLine": { + "title": "주문 항목", "required": [ "product", "quantity", @@ -31040,30 +32686,38 @@ "type": "object", "properties": { "product": { - "$ref": "#/components/schemas/PlatformOrderTransferProduct" + "$ref": "#/components/schemas/PlatformOrderTransferProduct", + "title": "상품" }, "quantity": { "type": "integer", - "format": "int32" + "format": "int32", + "title": "상품 수량" }, "discounts": { + "title": "상품 할인 정보", "type": "array", "items": { "$ref": "#/components/schemas/PlatformOrderTransferDiscount" } }, "additionalFees": { + "title": "상품 추가 수수료 정보", "type": "array", "items": { "$ref": "#/components/schemas/PlatformOrderTransferAdditionalFee" } }, "amount": { - "$ref": "#/components/schemas/PlatformOrderSettlementAmount" + "$ref": "#/components/schemas/PlatformOrderSettlementAmount", + "title": "상품 정산 금액 정보" } - } + }, + "description": "주문 항목
\n", + "x-portone-title": "주문 항목" }, "PlatformOrderTransferProduct": { + "title": "상품", "required": [ "id", "name", @@ -31072,19 +32726,25 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "title": "상품 아이디" }, "name": { - "type": "string" + "type": "string", + "title": "상품 이름" }, "amount": { "type": "integer", - "format": "int64" + "format": "int64", + "title": "상품 금액" }, "tag": { - "type": "string" + "type": "string", + "title": "태그" } - } + }, + "description": "상품
\n", + "x-portone-title": "상품" }, "PlatformOrderTransferSummary": { "required": [ @@ -31159,6 +32819,7 @@ "status", "defaultContractId", "tags", + "type", "isArchived", "appliedAt" ], @@ -31188,7 +32849,8 @@ "title": "파트너의 상태" }, "defaultContractId": { - "type": "string" + "type": "string", + "title": "파트너에 설정된 기본 계약 아이디" }, "memo": { "type": "string", @@ -31219,6 +32881,44 @@ "x-portone-title": "파트너", "x-portone-description": "파트너는 가맹점이 정산해주어야 할 대상입니다.\n기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.
\n" }, + "PlatformPartnerBusinessStatus": { + "title": "플랫폼 파트너 사업자 상태", + "type": "string", + "description": "플랫폼 파트너 사업자 상태
\n", + "enum": [ + "CLOSED", + "IN_BUSINESS", + "NOT_FOUND", + "NOT_VERIFIED", + "SUSPENDED", + "VERIFYING", + "VERIFY_FAILED" + ], + "x-portone-title": "플랫폼 파트너 사업자 상태", + "x-portone-enum": { + "SUSPENDED": { + "title": "휴업" + }, + "NOT_VERIFIED": { + "title": "인증 되지 않음" + }, + "IN_BUSINESS": { + "title": "사업 중" + }, + "CLOSED": { + "title": "폐업" + }, + "VERIFY_FAILED": { + "title": "인증 실패" + }, + "NOT_FOUND": { + "title": "대응되는 사업자 없음" + }, + "VERIFYING": { + "title": "인증 대기 중" + } + } + }, "PlatformPartnerContractSummary": { "title": "파트너 계약 요약 정보", "required": [ @@ -31294,7 +32994,7 @@ "isArchived": { "type": "boolean", "title": "보관 조회 여부", - "description": "true 이면 보관된 파트너를 조회하고, false 이면 보관되지 않은 파트너를 조회합니다. 아무 값도 넘기지 않을 경우 기본값은 false 입니다.
\n" + "description": "true 이면 보관된 파트너를 조회하고, false 이면 보관되지 않은 파트너를 조회합니다. 기본값은 false 입니다.
\n" }, "tags": { "type": "array", @@ -31484,11 +33184,13 @@ "PlatformPartnerManualSettlement": { "required": [ "type", + "id", + "graphqlId", "partner", "settlementDate", - "settlementAmount", "settlementCurrency", - "payoutCurrency", + "status", + "amount", "isForTest" ], "type": "object", @@ -31496,26 +33198,43 @@ "type": { "type": "string" }, + "id": { + "type": "string", + "title": "정산내역 아이디" + }, + "graphqlId": { + "type": "string" + }, "partner": { - "$ref": "#/components/schemas/PlatformPartnerSettlementPartner" + "$ref": "#/components/schemas/PlatformPartner", + "title": "파트너" }, "settlementDate": { "type": "string", "description": "날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
정산내역 대시보드
\n", + "x-portone-title": "정산내역 대시보드" }, - "PlatformPartnerSettlementFilterDateOption": { + "PlatformPartnerSettlementDashboardCurrencyStat": { + "title": "정산 통화별 정산내역 통계", "required": [ - "settlementDate", - "settlementStartDateRange" + "currency", + "settlementAmount", + "orderAmount", + "feeAmount", + "manualAmount", + "statusSettlementAmount" ], "type": "object", "properties": { - "settlementDate": { - "type": "string", - "description": "날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
중개 수수료, 중개 수수료 부가세, 추가 수수료, 추가 수수료 부가세, 할인 분담금, 결제금액 부가세 부담금을 더한 금액 입니다.
\n" + }, + "manualAmount": { + "type": "integer", + "format": "int64", + "title": "총 수기 정산 금액" + }, + "statusSettlementAmount": { + "$ref": "#/components/schemas/PlatformPartnerSettlementStatusStats", + "title": "상태별 총 정산 금액" } - } + }, + "description": "정산 통화별 정산내역 통계
\n", + "x-portone-title": "정산 통화별 정산내역 통계" }, "PlatformPartnerSettlementFilterInput": { - "required": [ - "settlementDate", - "settlementStartDateRange" - ], "type": "object", "properties": { - "settlementDate": { - "type": "string", - "description": "날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
날짜를 나타내는 문자열로, yyyy-MM-dd
형식을 따릅니다.
정산내역을 찾을 수 없는 경우
\n", + "x-portone-title": "정산내역을 찾을 수 없는 경우", + "x-portone-status-code": 404 + }, + "PlatformPartnerSettlementSheetField": { + "title": "다운로드 할 시트 컬럼", + "type": "string", + "description": "다운로드 할 시트 컬럼
\n", + "enum": [ + "CONTRACT_ID", + "CONTRACT_NAME", + "MEMO", + "PARTNER_ACCOUNT_BANK", + "PARTNER_ACCOUNT_NUMBER", + "PARTNER_ID", + "PARTNER_NAME", + "PARTNER_SETTLEMENT_ID", + "SETTLEMENT_ADDITIONAL_FEE_AMOUNT", + "SETTLEMENT_ADDITIONAL_FEE_VAT_AMOUNT", + "SETTLEMENT_AMOUNT", + "SETTLEMENT_CURRENCY", + "SETTLEMENT_DATE", + "SETTLEMENT_DISCOUNT_AMOUNT", + "SETTLEMENT_DISCOUNT_SHARE_AMOUNT", + "SETTLEMENT_ORDER_AMOUNT", + "SETTLEMENT_PAYMENT_AMOUNT", + "SETTLEMENT_PAYMENT_VAT_AMOUNT", + "SETTLEMENT_PAYMENT_VAT_BURDEN_AMOUNT", + "SETTLEMENT_PLATFORM_FEE_AMOUNT", + "SETTLEMENT_PLATFORM_FEE_VAT_AMOUNT", + "SETTLEMENT_START_DATE_RANGE", + "SETTLEMENT_TYPE", + "STATUS" + ], + "x-portone-title": "다운로드 할 시트 컬럼", + "x-portone-enum": { + "PARTNER_ID": { + "title": "파트너 아이디" }, - "partnerBusinessRegistrationNumber": { - "type": "string" + "SETTLEMENT_DISCOUNT_SHARE_AMOUNT": { + "title": "할인 분담금" }, - "partnerMemo": { - "type": "string" + "SETTLEMENT_START_DATE_RANGE": { + "title": "정산 시작 일 범위" }, - "platformFee": { - "type": "string" + "STATUS": { + "title": "정산내역 상태" }, - "contractMemo": { - "type": "string" + "MEMO": { + "title": "메모" }, - "additionalFeePolicyId": { - "type": "string" + "SETTLEMENT_ORDER_AMOUNT": { + "title": "주문 금액" }, - "additionalFeePolicyFee": { - "type": "string" + "SETTLEMENT_PAYMENT_AMOUNT": { + "title": "결제 금액" }, - "additionalFeePolicyMemo": { - "type": "string" + "PARTNER_ACCOUNT_NUMBER": { + "title": "파트너 계좌 번호" }, - "discountSharePolicyId": { - "type": "string" + "SETTLEMENT_PAYMENT_VAT_BURDEN_AMOUNT": { + "title": "결제 금액 부가세 부담금" }, - "discountSharePolicyRate": { - "type": "string" + "SETTLEMENT_DATE": { + "title": "정산 일" }, - "discountSharePolicyMemo": { - "type": "string" + "SETTLEMENT_ADDITIONAL_FEE_VAT_AMOUNT": { + "title": "추가 수수료 부가세" }, - "productId": { - "type": "string" + "SETTLEMENT_CURRENCY": { + "title": "정산 통화" + }, + "PARTNER_SETTLEMENT_ID": { + "title": "정산내역 아이디" + }, + "SETTLEMENT_DISCOUNT_AMOUNT": { + "title": "할인 금액" + }, + "CONTRACT_ID": { + "title": "계약 아이디" + }, + "PARTNER_NAME": { + "title": "파트너 이름" + }, + "SETTLEMENT_TYPE": { + "title": "정산 유형" + }, + "SETTLEMENT_PLATFORM_FEE_VAT_AMOUNT": { + "title": "중개 수수료 부가세" + }, + "CONTRACT_NAME": { + "title": "계약 이름" + }, + "SETTLEMENT_ADDITIONAL_FEE_AMOUNT": { + "title": "추가 수수료" + }, + "PARTNER_ACCOUNT_BANK": { + "title": "파트너 계좌 은행" + }, + "SETTLEMENT_PAYMENT_VAT_AMOUNT": { + "title": "결제 금액 부가세" + }, + "SETTLEMENT_AMOUNT": { + "title": "정산 금액" + }, + "SETTLEMENT_PLATFORM_FEE_AMOUNT": { + "title": "중개 수수료" } } }, - "PlatformPartnerSettlementFilterKeywordType": { + "PlatformPartnerSettlementStatus": { + "title": "정산 상태", "type": "string", + "description": "정산 상태
\n", "enum": [ - "ADDITIONAL_FEE_POLICY_FEE", - "ADDITIONAL_FEE_POLICY_ID", - "ADDITIONAL_FEE_POLICY_MEMO", - "CONTRACT_MEMO", - "DISCOUNT_SHARE_POLICY_ID", - "DISCOUNT_SHARE_POLICY_MEMO", - "DISCOUNT_SHARE_POLICY_RATE", - "PARTNER_BUSINESS_REGISTRATION_NUMBER", - "PARTNER_EMAIL", - "PARTNER_ID", - "PARTNER_MEMO", - "PLATFORM_FEE", - "PRODUCT_ID" + "IN_PAYOUT", + "PAID_OUT", + "PAYOUT_FAILED", + "PAYOUT_PREPARED", + "PAYOUT_WITHHELD" ], + "x-portone-title": "정산 상태", "x-portone-enum": { - "PARTNER_EMAIL": {}, - "PARTNER_ID": {}, - "ADDITIONAL_FEE_POLICY_FEE": {}, - "PARTNER_MEMO": {}, - "PARTNER_BUSINESS_REGISTRATION_NUMBER": {}, - "ADDITIONAL_FEE_POLICY_MEMO": {}, - "PLATFORM_FEE": {}, - "DISCOUNT_SHARE_POLICY_MEMO": {}, - "ADDITIONAL_FEE_POLICY_ID": {}, - "DISCOUNT_SHARE_POLICY_ID": {}, - "PRODUCT_ID": {}, - "DISCOUNT_SHARE_POLICY_RATE": {}, - "CONTRACT_MEMO": {} - } - }, - "PlatformPartnerSettlementFilterOptions": { - "required": [ - "contractIds", - "dateOptions", - "banks", - "settlementCurrencies", - "payoutCurrencies", - "partnerTags" - ], - "type": "object", - "properties": { - "contractIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "dateOptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PlatformPartnerSettlementFilterDateOption" - } + "PAYOUT_FAILED": { + "title": "지급 실패" }, - "banks": { - "title": "은행", - "type": "array", - "items": { - "$ref": "#/components/schemas/Bank" - } + "PAYOUT_WITHHELD": { + "title": "지급 보류" }, - "settlementCurrencies": { - "title": "통화 단위", - "type": "array", - "items": { - "$ref": "#/components/schemas/Currency" - } + "PAID_OUT": { + "title": "지급 완료" }, - "payoutCurrencies": { - "title": "통화 단위", - "type": "array", - "items": { - "$ref": "#/components/schemas/Currency" - } + "PAYOUT_PREPARED": { + "title": "지급 예정" }, - "partnerTags": { - "type": "array", - "items": { - "type": "string" - } + "IN_PAYOUT": { + "title": "지급 중" } } }, - "PlatformPartnerSettlementPartner": { + "PlatformPartnerSettlementStatusStats": { "required": [ - "id", - "graphqlId", - "name", - "bank", - "accountHolder", - "accountNumber" + "payoutPrepared", + "payoutWithheld", + "payoutFailed", + "inPayout", + "paidOut" ], "type": "object", "properties": { - "id": { - "type": "string" + "payoutPrepared": { + "type": "integer", + "format": "int64" }, - "graphqlId": { - "type": "string" + "payoutWithheld": { + "type": "integer", + "format": "int64" }, - "name": { - "type": "string" + "payoutFailed": { + "type": "integer", + "format": "int64" }, - "bank": { - "$ref": "#/components/schemas/Bank" + "inPayout": { + "type": "integer", + "format": "int64" }, - "accountHolder": { - "type": "string" + "paidOut": { + "type": "integer", + "format": "int64" + } + } + }, + "PlatformPartnerSettlementType": { + "title": "정산 유형", + "type": "string", + "description": "정산 유형
\n", + "enum": [ + "MANUAL", + "ORDER", + "ORDER_CANCEL" + ], + "x-portone-title": "정산 유형", + "x-portone-enum": { + "MANUAL": { + "title": "수동 정산" }, - "accountNumber": { - "type": "string" + "ORDER": { + "title": "주문 정산" + }, + "ORDER_CANCEL": { + "title": "주문 취소 정산" } } }, @@ -32048,6 +33850,7 @@ "required": [ "type", "companyName", + "businessStatus", "businessRegistrationNumber", "representativeName" ], @@ -32060,6 +33863,10 @@ "type": "string", "title": "상호명" }, + "businessStatus": { + "$ref": "#/components/schemas/PlatformPartnerBusinessStatus", + "title": "사업자 상태" + }, "businessRegistrationNumber": { "type": "string", "title": "사업자등록번호" @@ -32088,8 +33895,7 @@ "PlatformPartnerTypeWhtPayer": { "title": "원천징수대상자 파트너 정보", "required": [ - "type", - "birthdate" + "type" ], "type": "object", "properties": { @@ -32125,6 +33931,8 @@ } }, "PlatformPayment": { + "title": "결제 정보", + "description": "결제 정보
\n", "oneOf": [ { "$ref": "#/components/schemas/PlatformExternalPayment" @@ -32140,12 +33948,18 @@ "PORT_ONE": "#/components/schemas/PlatformPortOnePayment" } }, + "x-portone-title": "결제 정보", "x-portone-discriminator": { - "PORT_ONE": {}, - "EXTERNAL": {} + "PORT_ONE": { + "title": "포트원 결제 정보" + }, + "EXTERNAL": { + "title": "외부 결제 정보" + } } }, "PlatformPaymentChannel": { + "title": "채널", "required": [ "id", "key", @@ -32155,23 +33969,32 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "title": "채널 아이디" }, "key": { - "type": "string" + "type": "string", + "title": "채널 키" }, "name": { - "type": "string" + "type": "string", + "title": "채널 이름" }, "pgMerchantId": { - "type": "string" + "type": "string", + "title": "PG사 가맹점 식별 아이디" }, "pgCompany": { - "$ref": "#/components/schemas/PgCompany" + "$ref": "#/components/schemas/PgCompany", + "title": "PG사" } - } + }, + "description": "채널
\n", + "x-portone-title": "채널" }, "PlatformPaymentMethod": { + "title": "결제 수단", + "description": "결제 수단
\n", "oneOf": [ { "$ref": "#/components/schemas/PlatformPaymentMethodCard" @@ -32203,16 +34026,30 @@ "VIRTUAL_ACCOUNT": "#/components/schemas/PlatformPaymentMethodVirtualAccount" } }, + "x-portone-title": "결제 수단", "x-portone-discriminator": { - "GIFT_CERTIFICATE": {}, - "VIRTUAL_ACCOUNT": {}, - "MOBILE": {}, - "CARD": {}, - "TRANSFER": {}, - "EASY_PAY": {} + "GIFT_CERTIFICATE": { + "title": "상품권" + }, + "VIRTUAL_ACCOUNT": { + "title": "가상계좌" + }, + "MOBILE": { + "title": "모바일" + }, + "CARD": { + "title": "카드" + }, + "TRANSFER": { + "title": "계좌이체" + }, + "EASY_PAY": { + "title": "간편 결제" + } } }, "PlatformPaymentMethodCard": { + "title": "카드", "required": [ "type" ], @@ -32221,12 +34058,15 @@ "type": { "type": "string" } - } + }, + "description": "카드
\n", + "x-portone-title": "카드" }, "PlatformPaymentMethodCardInput": { "type": "object" }, "PlatformPaymentMethodEasyPay": { + "title": "간편 결제", "required": [ "type" ], @@ -32236,25 +34076,35 @@ "type": "string" }, "provider": { - "$ref": "#/components/schemas/EasyPayProvider" + "$ref": "#/components/schemas/EasyPayProvider", + "title": "간편 결제사" }, "methodType": { - "$ref": "#/components/schemas/EasyPayMethodType" + "$ref": "#/components/schemas/EasyPayMethodType", + "title": "간편 결제 수단" } - } + }, + "description": "간편 결제
\n", + "x-portone-title": "간편 결제" }, "PlatformPaymentMethodEasyPayInput": { + "title": "간편 결제 입력 정보", "type": "object", "properties": { "provider": { - "$ref": "#/components/schemas/EasyPayProvider" + "$ref": "#/components/schemas/EasyPayProvider", + "title": "간편 결제사" }, "methodType": { - "$ref": "#/components/schemas/EasyPayMethodType" + "$ref": "#/components/schemas/EasyPayMethodType", + "title": "간편 결제 수단" } - } + }, + "description": "간편 결제 입력 정보
\n", + "x-portone-title": "간편 결제 입력 정보" }, "PlatformPaymentMethodGiftCertificate": { + "title": "상품권", "required": [ "type" ], @@ -32263,35 +34113,47 @@ "type": { "type": "string" } - } + }, + "description": "상품권
\n", + "x-portone-title": "상품권" }, "PlatformPaymentMethodGiftCertificateInput": { "type": "object" }, "PlatformPaymentMethodInput": { + "title": "결제 수단 입력 정보", "type": "object", "properties": { "card": { - "$ref": "#/components/schemas/PlatformPaymentMethodCardInput" + "$ref": "#/components/schemas/PlatformPaymentMethodCardInput", + "title": "카드" }, "transfer": { - "$ref": "#/components/schemas/PlatformPaymentMethodTransferInput" + "$ref": "#/components/schemas/PlatformPaymentMethodTransferInput", + "title": "계좌이체" }, "virtualAccount": { - "$ref": "#/components/schemas/PlatformPaymentMethodVirtualAccountInput" + "$ref": "#/components/schemas/PlatformPaymentMethodVirtualAccountInput", + "title": "가상계좌" }, "giftCertificate": { - "$ref": "#/components/schemas/PlatformPaymentMethodGiftCertificateInput" + "$ref": "#/components/schemas/PlatformPaymentMethodGiftCertificateInput", + "title": "상품권" }, "mobile": { - "$ref": "#/components/schemas/PlatformPaymentMethodMobileInput" + "$ref": "#/components/schemas/PlatformPaymentMethodMobileInput", + "title": "모바일" }, "easyPay": { - "$ref": "#/components/schemas/PlatformPaymentMethodEasyPayInput" + "$ref": "#/components/schemas/PlatformPaymentMethodEasyPayInput", + "title": "간편 결제" } - } + }, + "description": "결제 수단 입력 정보
\n", + "x-portone-title": "결제 수단 입력 정보" }, "PlatformPaymentMethodMobile": { + "title": "모바일", "required": [ "type" ], @@ -32300,12 +34162,15 @@ "type": { "type": "string" } - } + }, + "description": "모바일
\n", + "x-portone-title": "모바일" }, "PlatformPaymentMethodMobileInput": { "type": "object" }, "PlatformPaymentMethodTransfer": { + "title": "계좌이체", "required": [ "type" ], @@ -32314,12 +34179,15 @@ "type": { "type": "string" } - } + }, + "description": "계좌이체
\n", + "x-portone-title": "계좌이체" }, "PlatformPaymentMethodTransferInput": { "type": "object" }, "PlatformPaymentMethodVirtualAccount": { + "title": "가상계좌", "required": [ "type" ], @@ -32328,7 +34196,9 @@ "type": { "type": "string" } - } + }, + "description": "가상계좌
\n", + "x-portone-title": "가상계좌" }, "PlatformPaymentMethodVirtualAccountInput": { "type": "object" @@ -32349,162 +34219,155 @@ "x-portone-status-code": 404 }, "PlatformPayout": { - "oneOf": [ - { - "$ref": "#/components/schemas/PlatformCompletedPayout" - }, - { - "$ref": "#/components/schemas/PlatformOngoingPayout" - } - ], - "discriminator": { - "propertyName": "status", - "mapping": { - "COMPLETED": "#/components/schemas/PlatformCompletedPayout", - "ONGOING": "#/components/schemas/PlatformOngoingPayout" - } - }, - "x-portone-discriminator": { - "ONGOING": {}, - "COMPLETED": {} - } - }, - "PlatformPayoutAlreadyCompletedError": { "required": [ - "type" + "id", + "graphqlId", + "method", + "status", + "statusUpdatedAt", + "partner", + "account", + "currency", + "amount", + "createdAt" ], "type": "object", "properties": { - "type": { + "id": { "type": "string" }, - "message": { + "graphqlId": { "type": "string" - } - }, - "x-portone-status-code": 409 - }, - "PlatformPayoutCreatorMismatchedError": { - "required": [ - "type", - "creatorId" - ], - "type": "object", - "properties": { - "type": { + }, + "method": { + "$ref": "#/components/schemas/PlatformPayoutMethod" + }, + "status": { + "$ref": "#/components/schemas/PlatformPayoutStatus" + }, + "statusUpdatedAt": { + "type": "string", + "format": "date-time" + }, + "memo": { "type": "string" }, - "creatorId": { + "partner": { + "$ref": "#/components/schemas/PlatformPartner" + }, + "account": { + "$ref": "#/components/schemas/PlatformPayoutAccount" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "amount": { + "type": "integer", + "format": "int64" + }, + "withdrawalMemo": { "type": "string" }, - "message": { + "depositMemo": { "type": "string" - } - }, - "x-portone-status-code": 403 - }, - "PlatformPayoutFilterInput": { - "type": "object", - "properties": { - "statuses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PlatformPayoutStatus" - } }, - "isForTest": { - "type": "boolean" + "createdAt": { + "type": "string", + "format": "date-time" } } }, - "PlatformPayoutNotFoundError": { + "PlatformPayoutAccount": { "required": [ - "type" + "bank", + "number", + "holder" ], "type": "object", "properties": { - "type": { + "bank": { + "$ref": "#/components/schemas/Bank" + }, + "number": { "type": "string" }, - "message": { + "holder": { "type": "string" } - }, - "x-portone-status-code": 404 + } }, - "PlatformPayoutPartnerSettlement": { + "PlatformPayoutFilterInput": { "required": [ - "id", - "graphqlId", - "payoutId", - "payoutGraphqlId", - "status", - "partnerSettlement" + "criteria" ], "type": "object", "properties": { - "id": { - "type": "string" + "statuses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PlatformPayoutStatus" + } }, - "graphqlId": { - "type": "string" + "partnerIds": { + "type": "array", + "items": { + "type": "string" + } }, - "payoutId": { - "type": "string" + "criteria": { + "$ref": "#/components/schemas/PlatformPayoutFilterInputCriteria" }, - "payoutGraphqlId": { - "type": "string" + "payoutAccountBanks": { + "title": "은행", + "type": "array", + "items": { + "$ref": "#/components/schemas/Bank" + } }, - "status": { - "$ref": "#/components/schemas/PlatformPayoutPartnerSettlementStatus" + "partnerTags": { + "type": "array", + "items": { + "type": "string" + } }, - "partnerSettlement": { - "$ref": "#/components/schemas/PlatformPartnerSettlement" + "payoutCurrencies": { + "title": "통화 단위", + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } } } }, - "PlatformPayoutPartnerSettlementAlreadyPaidOutError": { - "required": [ - "type" - ], + "PlatformPayoutFilterInputCriteria": { + "title": "검색 기준 입력 정보", "type": "object", "properties": { - "type": { - "type": "string" + "timestampRange": { + "$ref": "#/components/schemas/DateTimeRange" }, - "message": { - "type": "string" - } - }, - "x-portone-status-code": 400 - }, - "PlatformPayoutPartnerSettlementNotFoundError": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { + "payoutId": { "type": "string" }, - "message": { + "bulkPayoutId": { "type": "string" } }, - "x-portone-status-code": 404 + "description": "검색 기준 입력 정보
\n", + "x-portone-title": "검색 기준 입력 정보" }, - "PlatformPayoutPartnerSettlementStatus": { + "PlatformPayoutMethod": { "type": "string", "enum": [ - "PAID_OUT", - "WITHHELD" + "AGENCY", + "DIRECT" ], "x-portone-enum": { - "PAID_OUT": {}, - "WITHHELD": {} + "DIRECT": {}, + "AGENCY": {} } }, - "PlatformPayoutSheetNotFoundError": { + "PlatformPayoutNotFoundError": { "required": [ "type" ], @@ -32522,42 +34385,131 @@ "PlatformPayoutStatus": { "type": "string", "enum": [ - "COMPLETED", - "ONGOING" + "CANCELLED", + "FAILED", + "PREPARED", + "PROCESSING", + "STOPPED", + "SUCCEEDED" ], "x-portone-enum": { - "ONGOING": {}, - "COMPLETED": {} + "STOPPED": {}, + "PREPARED": {}, + "CANCELLED": {}, + "SUCCEEDED": {}, + "PROCESSING": {}, + "FAILED": {} } }, - "PlatformPayoutSummary": { + "PlatformPayoutStatusStats": { "required": [ - "partnerCount", - "totalSettlementAmount", - "paidOutPartnerSettlementCount", - "totalPartnerSettlementCount" + "prepared", + "cancelled", + "stopped", + "processing", + "succeeded", + "failed" ], "type": "object", "properties": { - "partnerCount": { + "prepared": { "type": "integer", - "format": "int32" + "format": "int64" }, - "totalSettlementAmount": { + "cancelled": { "type": "integer", "format": "int64" }, - "paidOutPartnerSettlementCount": { + "stopped": { "type": "integer", - "format": "int32" + "format": "int64" }, - "totalPartnerSettlementCount": { + "processing": { "type": "integer", - "format": "int32" + "format": "int64" + }, + "succeeded": { + "type": "integer", + "format": "int64" + }, + "failed": { + "type": "integer", + "format": "int64" + } + } + }, + "PlatformPayoutsSheetField": { + "title": "다운로드 할 시트 컬럼", + "type": "string", + "description": "다운로드 할 시트 컬럼
\n", + "enum": [ + "ACCOUNT_BANK", + "ACCOUNT_HOLDER", + "ACCOUNT_NUMBER", + "AMOUNT", + "CREATED_AT", + "CURRENCY", + "DEPOSIT_MEMO", + "MEMO", + "METHOD", + "PARTNER_ID", + "PARTNER_NAME", + "PAYOUT_ID", + "STATUS", + "STATUS_UPDATED_AT", + "WITHDRAWAL_MEMO" + ], + "x-portone-title": "다운로드 할 시트 컬럼", + "x-portone-enum": { + "ACCOUNT_HOLDER": { + "title": "지급 계좌 예금주" + }, + "PARTNER_ID": { + "title": "파트너 아이디" + }, + "STATUS_UPDATED_AT": { + "title": "상태 업데이트 시각" + }, + "CREATED_AT": { + "title": "지급 생성 시각" + }, + "STATUS": { + "title": "지급 상태" + }, + "WITHDRAWAL_MEMO": { + "title": "출금 메모" + }, + "MEMO": { + "title": "메모" + }, + "METHOD": { + "title": "지급 방식" + }, + "CURRENCY": { + "title": "지급 통화" + }, + "PAYOUT_ID": { + "title": "지급 아이디" + }, + "PARTNER_NAME": { + "title": "파트너 이름" + }, + "ACCOUNT_NUMBER": { + "title": "지급 계좌 번호" + }, + "AMOUNT": { + "title": "지급 금액" + }, + "ACCOUNT_BANK": { + "title": "지급 계좌 은행" + }, + "DEPOSIT_MEMO": { + "title": "입금 메모" } } }, "PlatformPortOnePayment": { + "title": "포트원 결제 정보", "required": [ "type", "id", @@ -32573,28 +34525,37 @@ "type": "string" }, "id": { - "type": "string" + "type": "string", + "title": "결제 아이디" }, "storeId": { - "type": "string" + "type": "string", + "title": "상점 아이디" }, "channelKey": { - "type": "string" + "type": "string", + "title": "채널 키" }, "orderName": { - "type": "string" + "type": "string", + "title": "주문 명" }, "method": { - "$ref": "#/components/schemas/PlatformPaymentMethod" + "$ref": "#/components/schemas/PlatformPaymentMethod", + "title": "결제 수단" }, "currency": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/Currency", + "title": "통화" }, "paidAt": { "type": "string", - "format": "date-time" + "format": "date-time", + "title": "결제 일시" } - } + }, + "description": "포트원 결제 정보
\n", + "x-portone-title": "포트원 결제 정보" }, "PlatformProductIdDuplicatedError": { "required": [ @@ -33268,6 +35229,8 @@ "x-portone-title": "플랫폼 정산건 처리 방식에 관한 규칙" }, "PlatformTransfer": { + "title": "정산건", + "description": "정산건
\n정산건은 파트너에 정산해줄 정산 금액과 정산 방식 등이 포함되어 있는 정산 정보입니다.\n정산 방식은은 주문 정산, 주문 취소 정산, 수기 정산이 있습니다.
\n", "oneOf": [ { "$ref": "#/components/schemas/PlatformManualTransfer" @@ -33287,10 +35250,18 @@ "ORDER_CANCEL": "#/components/schemas/PlatformOrderCancelTransfer" } }, + "x-portone-title": "정산건", + "x-portone-description": "정산건은 파트너에 정산해줄 정산 금액과 정산 방식 등이 포함되어 있는 정산 정보입니다.\n정산 방식은은 주문 정산, 주문 취소 정산, 수기 정산이 있습니다.
\n", "x-portone-discriminator": { - "MANUAL": {}, - "ORDER": {}, - "ORDER_CANCEL": {} + "MANUAL": { + "title": "수기 정산건" + }, + "ORDER": { + "title": "주문 정산건" + }, + "ORDER_CANCEL": { + "title": "주문 취소 정산건" + } } }, "PlatformTransferAlreadyExistsError": { @@ -33368,101 +35339,138 @@ "x-portone-status-code": 404 }, "PlatformTransferFilterInput": { + "title": "정산건 필터 입력 정보", "type": "object", "properties": { "settlementStartDateRange": { - "$ref": "#/components/schemas/DateRange" + "$ref": "#/components/schemas/DateRange", + "title": "정산 시작일 범위" }, "settlementDateRange": { - "$ref": "#/components/schemas/DateRange" + "$ref": "#/components/schemas/DateRange", + "title": "정산 일 범위" }, "partnerTags": { "type": "array", "items": { "type": "string" - } + }, + "title": "파트너 태그 리스트", + "description": "하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 태그를 하나 이상 가지는 파트너에 대한 정산건만 조회합니다.
\n" }, "contractIds": { "type": "array", "items": { "type": "string" - } + }, + "title": "계약 아이디 리스트", + "description": "하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 계약 아이디를 가지는 정산건만 조회합니다.
\n" }, "discountSharePolicyIds": { "type": "array", "items": { "type": "string" - } + }, + "title": "할인 분담 정책 아이디 리스트", + "description": "하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 할인 분담 정책 아이디를 하나 이상 가지는 정산건만 조회합니다.
\n" }, "additionalFeePolicyIds": { "type": "array", "items": { "type": "string" - } + }, + "title": "추가 수수료 정책 아이디 리스트", + "description": "하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 추가 수수료 아이디를 하나 이상 가지는 정산건만 조회합니다.
\n" }, "paymentMethodTypes": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodType" - } + }, + "title": "결제 수단 리스트", + "description": "하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 결제 수단을 가지는 파트너만 조회합니다.
\n" }, "channelKeys": { "type": "array", "items": { "type": "string" - } + }, + "title": "채널 키 리스트", + "description": "하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 채널 키를 가지는 정산건만 조회합니다.
\n" }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/PlatformTransferType" - } + }, + "title": "정산 방식 리스트", + "description": "하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 정산 방식의 정산건만 조회합니다.
\n" }, "statuses": { + "title": "정산 상태 리스트", "type": "array", "items": { "$ref": "#/components/schemas/PlatformTransferStatus" - } + }, + "description": "하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 정산 상태인 정산건만 조회합니다.
\n" }, "keyword": { - "$ref": "#/components/schemas/PlatformTransferFilterInputKeyword" + "$ref": "#/components/schemas/PlatformTransferFilterInputKeyword", + "title": "검색 키워드" }, "isForTest": { - "type": "boolean" + "type": "boolean", + "title": "테스트 모드 여부" } - } + }, + "description": "정산건 필터 입력 정보
\n정산 시작일 범위와 정산 일 범위는 둘 중 하나만 입력 가능합니다.
\n", + "x-portone-title": "정산건 필터 입력 정보", + "x-portone-description": "정산 시작일 범위와 정산 일 범위는 둘 중 하나만 입력 가능합니다.
\n" }, "PlatformTransferFilterInputKeyword": { + "title": "정산건 검색 키워드 입력 정보", "type": "object", "properties": { "all": { - "type": "string" + "type": "string", + "description": "해당 값이 포함된 정보를 가진 정산건만 조회합니다.
\n" }, "paymentId": { - "type": "string" + "type": "string", + "description": "해당 값이랑 일치하는 paymentId 를 가진 정산건만 조회합니다.
\n" }, "transferId": { - "type": "string" + "type": "string", + "description": "해당 값이랑 일치하는 transferId 를 가진 정산건만 조회합니다.
\n" }, "transferMemo": { - "type": "string" + "type": "string", + "description": "해당 값이 포함된 transferMemo 를 가진 정산건만 조회합니다.
\n" }, "productId": { - "type": "string" + "type": "string", + "description": "해당 값이랑 일치하는 productId 를 가진 정산건만 조회합니다.
\n" }, "productName": { - "type": "string" + "type": "string", + "description": "해당 값이랑 일치하는 productName 을 가진 정산건만 조회합니다.
\n" }, "partnerId": { - "type": "string" + "type": "string", + "description": "해당 값이랑 일치하는 partnerId 를 가진 정산건만 조회합니다.
\n" }, "partnerName": { - "type": "string" + "type": "string", + "description": "해당 값이 포함된 partnerName 을 가진 정산건만 조회합니다.
\n" }, "partnerMemo": { - "type": "string" + "type": "string", + "description": "해당 값이 포함된 partnerMemo 를 가진 정산건만 조회합니다.
\n" } - } + }, + "description": "정산건 검색 키워드 입력 정보
\n검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 정산건만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.
\n", + "x-portone-title": "정산건 검색 키워드 입력 정보", + "x-portone-description": "검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 정산건만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.
\n" }, "PlatformTransferFilterOptions": { "required": [ @@ -33499,6 +35507,7 @@ } }, "paymentChannels": { + "title": "채널", "type": "array", "items": { "$ref": "#/components/schemas/PlatformPaymentChannel" @@ -33536,8 +35545,104 @@ }, "x-portone-status-code": 404 }, + "PlatformTransferSheetField": { + "title": "다운로드 할 시트 컬럼", + "type": "string", + "description": "다운로드 할 시트 컬럼
\n", + "enum": [ + "ORDER_NAME", + "PARTNER_NAME", + "PAYMENT_ID", + "PAYMENT_METHOD", + "SETTLEMENT_ADDITIONAL_FEE_AMOUNT", + "SETTLEMENT_ADDITIONAL_FEE_VAT_AMOUNT", + "SETTLEMENT_AMOUNT", + "SETTLEMENT_CURRENCY", + "SETTLEMENT_DATE", + "SETTLEMENT_DISCOUNT_AMOUNT", + "SETTLEMENT_DISCOUNT_SHARE_AMOUNT", + "SETTLEMENT_ORDER_AMOUNT", + "SETTLEMENT_PAYMENT_AMOUNT", + "SETTLEMENT_PAYMENT_VAT_AMOUNT", + "SETTLEMENT_PAYMENT_VAT_BURDEN_AMOUNT", + "SETTLEMENT_PLATFORM_FEE_AMOUNT", + "SETTLEMENT_PLATFORM_FEE_VAT_AMOUNT", + "SETTLEMENT_START_DATE", + "STATUS", + "TRANSFER_ID", + "TYPE" + ], + "x-portone-title": "다운로드 할 시트 컬럼", + "x-portone-enum": { + "SETTLEMENT_DISCOUNT_SHARE_AMOUNT": { + "title": "할인 분담금" + }, + "PAYMENT_ID": { + "title": "결제 내역 아이디" + }, + "SETTLEMENT_DISCOUNT_AMOUNT": { + "title": "할인 금액" + }, + "STATUS": { + "title": "정산 건 상태" + }, + "SETTLEMENT_ORDER_AMOUNT": { + "title": "주문 금액" + }, + "TRANSFER_ID": { + "title": "정산 건 아이디" + }, + "SETTLEMENT_START_DATE": { + "title": "정산 시작 일" + }, + "SETTLEMENT_PAYMENT_VAT_BURDEN_AMOUNT": { + "title": "결제 금액 부가세 부담금" + }, + "ORDER_NAME": { + "title": "주문 명" + }, + "SETTLEMENT_DATE": { + "title": "정산 일" + }, + "TYPE": { + "title": "정산 구분" + }, + "SETTLEMENT_ADDITIONAL_FEE_VAT_AMOUNT": { + "title": "추가 수수료 부가세" + }, + "SETTLEMENT_CURRENCY": { + "title": "정산 통화" + }, + "PARTNER_NAME": { + "title": "파트너 이름" + }, + "SETTLEMENT_PLATFORM_FEE_VAT_AMOUNT": { + "title": "중개 수수료 부가세" + }, + "PAYMENT_METHOD": { + "title": "결제 수단" + }, + "SETTLEMENT_PAYMENT_AMOUNT": { + "title": "결제 금액" + }, + "SETTLEMENT_ADDITIONAL_FEE_AMOUNT": { + "title": "추가 수수료" + }, + "SETTLEMENT_PAYMENT_VAT_AMOUNT": { + "title": "결제 금액 부가세" + }, + "SETTLEMENT_AMOUNT": { + "title": "정산 금액" + }, + "SETTLEMENT_PLATFORM_FEE_AMOUNT": { + "title": "중개 수수료" + } + } + }, "PlatformTransferStatus": { + "title": "정산 상태", "type": "string", + "description": "정산 상태
\n", "enum": [ "IN_PAYOUT", "IN_PROCESS", @@ -33545,12 +35650,23 @@ "SCHEDULED", "SETTLED" ], + "x-portone-title": "정산 상태", "x-portone-enum": { - "SETTLED": {}, - "SCHEDULED": {}, - "PAID_OUT": {}, - "IN_PROCESS": {}, - "IN_PAYOUT": {} + "SETTLED": { + "title": "정산 완료" + }, + "SCHEDULED": { + "title": "정산 예약" + }, + "PAID_OUT": { + "title": "지급 완료" + }, + "IN_PROCESS": { + "title": "정산 중" + }, + "IN_PAYOUT": { + "title": "지급 중" + } } }, "PlatformTransferSummary": { @@ -35491,6 +37607,15 @@ { "$ref": "#/components/schemas/InvalidRequestError" }, + { + "$ref": "#/components/schemas/PlatformAccountVerificationAlreadyUsedError" + }, + { + "$ref": "#/components/schemas/PlatformAccountVerificationFailedError" + }, + { + "$ref": "#/components/schemas/PlatformAccountVerificationNotFoundError" + }, { "$ref": "#/components/schemas/PlatformArchivedPartnerError" }, @@ -35514,6 +37639,9 @@ "propertyName": "type", "mapping": { "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", + "PLATFORM_ACCOUNT_VERIFICATION_ALREADY_USED": "#/components/schemas/PlatformAccountVerificationAlreadyUsedError", + "PLATFORM_ACCOUNT_VERIFICATION_FAILED": "#/components/schemas/PlatformAccountVerificationFailedError", + "PLATFORM_ACCOUNT_VERIFICATION_NOT_FOUND": "#/components/schemas/PlatformAccountVerificationNotFoundError", "PLATFORM_ARCHIVED_PARTNER": "#/components/schemas/PlatformArchivedPartnerError", "PLATFORM_CONTRACT_NOT_FOUND": "#/components/schemas/PlatformContractNotFoundError", "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", @@ -35740,6 +37868,10 @@ "holder": { "type": "string", "title": "예금주명" + }, + "accountVerificationId": { + "type": "string", + "title": "계좌 검증 아이디" } }, "description": "파트너 계좌 업데이트를 위한 입력 정보
\n", @@ -36753,65 +38885,6 @@ "description": "연동 사업자 정보 수정 응답
\n", "x-portone-title": "연동 사업자 정보 수정 응답" }, - "UpdatePayoutAllPartnerSettlementsBody": { - "required": [ - "status" - ], - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/PlatformPayoutPartnerSettlementStatus" - } - } - }, - "UpdatePayoutAllPartnerSettlementsError": { - "oneOf": [ - { - "$ref": "#/components/schemas/ForbiddenError" - }, - { - "$ref": "#/components/schemas/InvalidRequestError" - }, - { - "$ref": "#/components/schemas/PlatformNotEnabledError" - }, - { - "$ref": "#/components/schemas/PlatformPayoutAlreadyCompletedError" - }, - { - "$ref": "#/components/schemas/PlatformPayoutCreatorMismatchedError" - }, - { - "$ref": "#/components/schemas/PlatformPayoutNotFoundError" - }, - { - "$ref": "#/components/schemas/UnauthorizedError" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "FORBIDDEN": "#/components/schemas/ForbiddenError", - "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", - "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", - "PLATFORM_PAYOUT_ALREADY_COMPLETED": "#/components/schemas/PlatformPayoutAlreadyCompletedError", - "PLATFORM_PAYOUT_CREATOR_MISMATCHED": "#/components/schemas/PlatformPayoutCreatorMismatchedError", - "PLATFORM_PAYOUT_NOT_FOUND": "#/components/schemas/PlatformPayoutNotFoundError", - "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" - } - } - }, - "UpdatePayoutAllPartnerSettlementsResponse": { - "required": [ - "payout" - ], - "type": "object", - "properties": { - "payout": { - "$ref": "#/components/schemas/PlatformPayout" - } - } - }, "UpdatePlatformAdditionalFeePolicyBody": { "title": "추가 수수료 정책 업데이트를 위한 입력 정보", "type": "object", @@ -37174,6 +39247,10 @@ "holder": { "type": "string", "title": "예금주명" + }, + "accountVerificationId": { + "type": "string", + "title": "계좌 검증 아이디" } }, "description": "파트너 계좌 업데이트를 위한 입력 정보
\n", @@ -37259,6 +39336,15 @@ { "$ref": "#/components/schemas/InvalidRequestError" }, + { + "$ref": "#/components/schemas/PlatformAccountVerificationAlreadyUsedError" + }, + { + "$ref": "#/components/schemas/PlatformAccountVerificationFailedError" + }, + { + "$ref": "#/components/schemas/PlatformAccountVerificationNotFoundError" + }, { "$ref": "#/components/schemas/PlatformArchivedPartnerError" }, @@ -37279,6 +39365,9 @@ "propertyName": "type", "mapping": { "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", + "PLATFORM_ACCOUNT_VERIFICATION_ALREADY_USED": "#/components/schemas/PlatformAccountVerificationAlreadyUsedError", + "PLATFORM_ACCOUNT_VERIFICATION_FAILED": "#/components/schemas/PlatformAccountVerificationFailedError", + "PLATFORM_ACCOUNT_VERIFICATION_NOT_FOUND": "#/components/schemas/PlatformAccountVerificationNotFoundError", "PLATFORM_ARCHIVED_PARTNER": "#/components/schemas/PlatformArchivedPartnerError", "PLATFORM_CONTRACT_NOT_FOUND": "#/components/schemas/PlatformContractNotFoundError", "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", @@ -37302,72 +39391,37 @@ "description": "파트너 업데이트 성공 응답
\n", "x-portone-title": "파트너 업데이트 성공 응답" }, - "UpdatePlatformPayoutPartnerSettlementBody": { + "UpdatePlatformPartnerSettlementStatusBody": { "required": [ + "partnerSettlementId", "status" ], "type": "object", "properties": { - "status": { - "$ref": "#/components/schemas/PlatformPayoutPartnerSettlementStatus" - } - } - }, - "UpdatePlatformPayoutPartnerSettlementError": { - "oneOf": [ - { - "$ref": "#/components/schemas/ForbiddenError" - }, - { - "$ref": "#/components/schemas/InvalidRequestError" - }, - { - "$ref": "#/components/schemas/PlatformNotEnabledError" - }, - { - "$ref": "#/components/schemas/PlatformPayoutCreatorMismatchedError" - }, - { - "$ref": "#/components/schemas/PlatformPayoutNotFoundError" - }, - { - "$ref": "#/components/schemas/PlatformPayoutPartnerSettlementAlreadyPaidOutError" + "partnerSettlementId": { + "type": "string" }, - { - "$ref": "#/components/schemas/PlatformPayoutPartnerSettlementNotFoundError" + "status": { + "$ref": "#/components/schemas/PlatformPartnerSettlementStatus" }, - { - "$ref": "#/components/schemas/UnauthorizedError" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "FORBIDDEN": "#/components/schemas/ForbiddenError", - "INVALID_REQUEST": "#/components/schemas/InvalidRequestError", - "PLATFORM_NOT_ENABLED": "#/components/schemas/PlatformNotEnabledError", - "PLATFORM_PAYOUT_CREATOR_MISMATCHED": "#/components/schemas/PlatformPayoutCreatorMismatchedError", - "PLATFORM_PAYOUT_NOT_FOUND": "#/components/schemas/PlatformPayoutNotFoundError", - "PLATFORM_PAYOUT_PARTNER_SETTLEMENT_ALREADY_PAID_OUT": "#/components/schemas/PlatformPayoutPartnerSettlementAlreadyPaidOutError", - "PLATFORM_PAYOUT_PARTNER_SETTLEMENT_NOT_FOUND": "#/components/schemas/PlatformPayoutPartnerSettlementNotFoundError", - "UNAUTHORIZED": "#/components/schemas/UnauthorizedError" + "memo": { + "type": "string" } } }, - "UpdatePlatformPayoutPartnerSettlementResponse": { + "UpdatePlatformPartnerSettlementStatusResponse": { + "title": "정산내역 상태 업데이트 결과", "required": [ - "payoutPartnerSettlement", - "payout" + "partnerSettlement" ], "type": "object", "properties": { - "payoutPartnerSettlement": { - "$ref": "#/components/schemas/PlatformPayoutPartnerSettlement" - }, - "payout": { - "$ref": "#/components/schemas/PlatformPayout" + "partnerSettlement": { + "$ref": "#/components/schemas/PlatformPartnerSettlement" } - } + }, + "description": "정산내역 상태 업데이트 결과
\n", + "x-portone-title": "정산내역 상태 업데이트 결과" }, "UpdatePlatformResponse": { "title": "플랫폼 업데이트 결과 정보", @@ -37584,6 +39638,10 @@ "country": { "$ref": "#/components/schemas/Country", "title": "국가 코드" + }, + "pgTxId": { + "type": "string", + "title": "PG사 거래 아이디" } }, "description": "가상계좌 발급 완료 상태 건
\n", @@ -37719,10 +39777,37 @@ "title": "B2B 서비스 API", "description": "B2B 관련 API 기능을 제공합니다. alpha 버전의 API 로서, 사용을 원하실 경우 관리자콘솔 및 홈페이지를 통해 문의해주세요.
\n" }, + { + "id": "platform", + "title": "파트너 정산 관련 API", + "description": "파트너 정산 서비스 API 기능을 제공합니다.
\n", + "children": [ + { + "id": "platform.policy", + "title": "정책 관련 API", + "description": "파트너 정산에 적용할 정책에 관한 API 입니다.
\n" + }, + { + "id": "platform.partner", + "title": "파트너 관련 API", + "description": "파트너 정산에 적용할 파트너에 관한 API 입니다.
\n" + }, + { + "id": "platform.transfer", + "title": "정산 상세내역 관련 API", + "description": "파트너 정산 서비스의 정산 상세내역과 관련된 API 입니다.
\n" + }, + { + "id": "platform.account", + "title": "계좌 관련 API", + "description": "파트너 정산 서비스의 계좌와 관련된 API 입니다.
\n" + } + ] + }, { "id": "pgSpecific", "title": "특정 PG사 관련 API", "description": "특정 PG사에 국한된 API 기능을 제공합니다.
\n" } ] -} +} \ No newline at end of file