Billing Payment Methods
Billing Payment Methods

Start a card registration

자동결제 카드 등록을 시작한다 - 고객이 동의하면 카드등록창을 여는 값을 돌려준다.

카드 정보는 이 API 를 지나지 않는다. 고객은 결제대행사의 창에서 직접 입력하고, 결과는 서버가 받아 결제수단을 만든다. 같은 Idempotency-Key 로 다시 부르면 같은 등록을 돌려준다. 결과는 등록 상태 조회로 안다.

post/v1/payment-methods/payup-hub/registrations

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/payment-methods/payup-hub/registrations
  • 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

Idempotency-Keystring required
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. 주체 조직과 일치해야 한다.

labelstring nullable

사용자 표시 라벨.

user_agent'PC' | 'MW' required

카드등록창을 여는 환경(PC 웹 · 모바일 웹).

Response

Successful Response

registration_idstring required

등록의 불투명 식별자. 상태 조회에 쓴다.

status'PENDING' required

시작 직후는 항상 PENDING.

sdk_urlstring required

카드등록창 스크립트 주소. 서버가 준다(시험과 운영이 다르다).

formobject required

창을 여는 폼의 숨은 입력 값. 그대로 폼에 넣는다(키 이름 포함). ReturnURL 은 서버가 만든 복귀 주소다.

expires_atstring date-time required

이 시각이 지나면 등록은 EXPIRED 가 된다.

Changes

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