Billing Standard Checkout

Prepare Checkout

서버가 금액을 확정하고 서명한다 (DB 쓰기 0건).

post/v1/subscriptions/payup-standard/prepare

Request

  • Base URL: https://api.xdata.kr (the document declares no server; this is the origin it was published from)
  • URL: https://api.xdata.kr/v1/subscriptions/payup-standard/prepare
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://api.xdata.kr/oauth/authorize, token URL https://api.xdata.kr/oauth/token)

Query parameters

env_scope'production' | 'real_test' | 'sandbox' nullable

환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.

Headers

Authorizationstring nullable
X-Env-Scope'production' | 'real_test' | 'sandbox' nullable

환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.

Request body

organization_idinteger required

결제 주체 조직 PK.

plan_idinteger required

plans.id.

addon_product_idsinteger[] nullable

함께 구매할 추가 상품 api_products.id 목록.

payer_namestring required

결제창에 표시할 결제자명.

subscription_idinteger nullable

대상 구독. 추가 상품을 더하거나(기본) 실패한 결제를 다시 시도할 때 필수.

mode'subscription' | 'addon' | 'retry' nullable

결제 갈래를 명시한다. 생략하면 subscription_id 유무로 정한다. 'retry' 는 결제가 실패한 구독의 미결제 금액을 다시 내는 갈래.

Response

Successful Response

merchant_idstring required

결제창이 요구하는 가맹점 식별자(시크릿 아님).

sdk_urlstring required

결제창 스크립트 주소.

item_namestring required

결제창에 표시할 상품명.

amountinteger required

결제 금액 (minor unit).

currency'KRW' required

통화 코드.

order_numberstring required

우리 주문번호.

checkout_tokenstring required

서버 서명 체크아웃 토큰.

return_urlstring required

모바일 결제창 복귀 주소.

Changes

No recorded changes to this operation across all 1 revision of this API.