sayren Docs
스토어 설정

결제 설정 조회

결제 도메인과 지원하는 모든 PG의 연결 상태(간편결제 포함)를 조회한다. 비밀 값(시크릿 키·API Secret·웹훅 시크릿)은 앞 4자리 마스킹만 나오고 평문은 어떤 응답에도 없다. 콘솔에 로그인한 **OWNER 전용**이다. ADMIN·STAFF, API 토큰(PAT), M2M 클라이언트, 3rd-party 앱이 위임받은 토큰은 스코프가 있어도 `403 INSUFFICIENT_ROLE`이다.

GET
/v1/store/payment-settings

결제 도메인과 지원하는 모든 PG의 연결 상태(간편결제 포함)를 조회한다. 비밀 값(시크릿 키·API Secret·웹훅 시크릿)은 앞 4자리 마스킹만 나오고 평문은 어떤 응답에도 없다. 콘솔에 로그인한 OWNER 전용이다. ADMIN·STAFF, API 토큰(PAT), M2M 클라이언트, 3rd-party 앱이 위임받은 토큰은 스코프가 있어도 403 INSUFFICIENT_ROLE이다.

Authorization

bearer
AuthorizationBearer <token>

userToken(계정 스코프) 또는 storeToken(스토어 스코프)

In: header

Response Body

application/json

curl -X GET "https://example.com/v1/store/payment-settings"
{  "meta": {    "status": 200,    "code": "OK",    "message": "OK",    "isSuccess": true  },  "data": {    "checkoutOrigins": [      "string"    ],    "providers": [      {        "provider": "tosspayments",        "displayName": "string",        "connected": true,        "enabled": true,        "priority": 0,        "environment": "TEST",        "publicConfig": {          "clientKey": "string"        },        "secrets": [          {            "field": "string",            "configured": true,            "masked": "string"          }        ],        "lastVerification": {          "result": "SUCCESS",          "message": "string",          "checkedAt": "string"        },        "updatedAt": "string",        "sandboxMode": true,        "credentialSets": {          "TEST": {            "environment": "TEST",            "publicConfig": {              "clientKey": "string"            },            "secrets": [              {                "field": "string",                "configured": true,                "masked": "string"              }            ],            "lastVerification": {              "result": "SUCCESS",              "message": "string",              "checkedAt": "string"            },            "updatedAt": "string"          },          "LIVE": {            "environment": "TEST",            "publicConfig": {              "clientKey": "string"            },            "secrets": [              {                "field": "string",                "configured": true,                "masked": "string"              }            ],            "lastVerification": {              "result": "SUCCESS",              "message": "string",              "checkedAt": "string"            },            "updatedAt": "string"          }        },        "liveGate": {          "status": "LOCKED",          "conditions": [            {              "code": "TEST_CONNECTION",              "met": true,              "message": "string"            }          ],          "openedAt": "string"        },        "easyPayProviders": [          "string"        ],        "retiredCredentialCount": 0,        "routingExclusion": null      }    ],    "environment": "TEST",    "candidates": []  },  "error": null}

앱(OAuth 클라이언트) 비활성화 POST

클라이언트를 `REVOKED`로 바꾼다. 되돌릴 수 없다. 이후 이 클라이언트로는 토큰 발급·갱신이 거부되고, 이미 발급된 access token도 즉시 무효가 되며 refresh token은 폐기된다. 이미 비활성화된 클라이언트에 다시 호출하면 현재 상태를 그대로 반환한다.

결제 설정 변경 (우선순위·결제 도메인) PUT

PG 우선순위(스토어프론트 결제 옵션 목록의 PG 순서)와 결제 도메인을 바꾼다. 보낸 항목만 바꾼다. `priority`에는 연결된 PG를 모두 한 번씩 나열한다. `checkoutOrigins`는 결제를 마친 구매자가 돌아올 스토어프론트 origin 목록이다(https, 경로 없음) — 결제 시작의 `returnUrl`이 이 안이어야 하고, 비어 있으면 실결제를 시작할 수 없다. 콘솔에 로그인한 **OWNER 전용**이다. ADMIN·STAFF, API 토큰(PAT), M2M 클라이언트, 3rd-party 앱이 위임받은 토큰은 스코프가 있어도 `403 INSUFFICIENT_ROLE`이다.