Billing Payment Methods
Billing Payment Methods

Cancel Card Registration

고객이 카드 등록 창을 닫았다 - 진행 중인 등록을 취소로 닫는다. 이미 끝난 등록은 그 상태 그대로 돌려준다.

post/v1/payment-methods/payup-hub/registrations/{registration_id}/cancel

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/{registration_id}/cancel
  • 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)

Path parameters

registration_idstring required

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 입니다.

Response

Successful Response

registration_idstring required

등록의 불투명 식별자.

status'PENDING' | 'ACTIVE' | 'FAILED' | 'CANCELED' | 'EXPIRED' required

등록의 상태.

failure_code'AUTH_FAILED' | 'PROVIDER_ERROR' | 'SERVER_ERROR' nullable

status 가 FAILED 일 때만 있다.

card_namestring nullable

status 가 ACTIVE 일 때 발급사 이름.

labelstring nullable

시작할 때 적은 표시 라벨.

payment_method_idinteger nullable

status 가 ACTIVE 일 때 만들어진 결제수단 PK.

expires_atstring date-time required

등록의 시한.

Changes

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