계약 수정

patch

https://public-api-service.dev.iamport.co/platform/contracts/{id}

주어진 아이디에 대응되는 계약을 업데이트합니다.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

업데이트할 계약 아이디

Body Params

계약 업데이트를 위한 입력 정보. 값이 명시되지 않은 필드는 업데이트되지 않습니다.

값이 명시되지 않은 필드는 업데이트되지 않습니다.

name

string

memo

string

platformFee

object

수수료 계산 방식을 특정하기 위한 입력 정보

정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다.
두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.

settlementCycle

object

플랫폼 정산 주기 입력 정보

platformFeeVatPayer

string

enum

금액 부담 주체

플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.

Allowed:

subtractPaymentVatAmount

boolean

Responses

`InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우

계약 수정

`InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우

`UnauthorizedError`: 인증 정보가 올바르지 않은 경우

`PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

`PlatformContractNotFoundError`

`PlatformArchivedContractError`: 보관된 계약을 업데이트하려고 하는 경우

200성공 응답으로 업데이트된 계약 객체가 반환됩니다.

400 InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우

401 UnauthorizedError: 인증 정보가 올바르지 않은 경우

403 PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

404 PlatformContractNotFoundError

409 PlatformArchivedContractError: 보관된 계약을 업데이트하려고 하는 경우

`InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우

`UnauthorizedError`: 인증 정보가 올바르지 않은 경우

`PlatformNotEnabledError`: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

`PlatformContractNotFoundError`

`PlatformArchivedContractError`: 보관된 계약을 업데이트하려고 하는 경우