하위사업장 가입 및 등록

하위 사업장 등록 URL 발급

post

파트너사의 하위 사업장 등록을 위한 접근 URL을 발급합니다. 발급된 URL을 파트너 내부 화면에 연결하여 하위 사업장 등록을 진행할 수 있습니다.

Body

application/json

apiKeystringRequired

파트너 연동을 위한 고유키

Example: partner-api-key

memberIdstringRequired

파트너 사용자 코드

Example: partner-user-1

merchantIdstringRequired

파트너 매장 코드

Example: partner-merchant-1

businessNumberstringOptional

사업자번호

Example: 1000012345

callbackUrlstringOptional

하위사업장 가입 시에 결과를 전송 받기 위한 파트너사의 callbackUrl

Example: https://partner.url.com/callback

redirectUrlstringOptional

하위사업장 가입 완료 이후 페이지 이동을 위한 redirectUrl

Example: redirectUrl

Responses

200

성공

application/json

공통 API 응답 포맷 (api.spec: code/message/data)

codestringOptional

응답 코드

Example: 0000

messagestringOptional

응답 메시지

Example: 성공하였습니다.

post

/auth/mapping

HTTPcURLJavaScriptPython

POST /auth/mapping HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "apiKey": "partner-api-key",
  "memberId": "partner-user-1",
  "merchantId": "partner-merchant-1",
  "businessNumber": 1000012345,
  "callbackUrl": "https://partner.url.com/callback",
  "redirectUrl": "redirectUrl"
}

200

성공

{
  "code": "0000",
  "message": "성공하였습니다.",
  "data": {
    "url": "https://manager-stg.paymint.co.kr/partner_v2/paths"
  }
}

파트너 하위 사업장 연동 결과 동기화 콜백

post

파트너 하위 사업장 연동 과정에서 연동 상태 변경을 페이민트 -> 파트너사에게 전달합니다. 파트너사는 아래 전문을 수신할 수 있는 엔드포인트를 구축해야 해야 합니다. 구축하신 엔드포인트의 URL을 '하위 사업장 등록 URL 발급(/auth/mapping)'의 callbackUrl 파라미터로 입력하면, 하위 사업장 연동 결과를 페이민트가 파트너사에 실시간으로 제공합니다.

Body

application/json

파트너 인증 맵핑 결과 콜백 페이로드

memberIdstringOptional

파트너 사용자 코드

Example: partner-user-1

merchantIdstringOptional

파트너 매장 코드

Example: partner-merchant-1

Responses

200

파트너 측 수신 성공

application/json

파트너 콜백 응답 포맷

codestringRequired

응답 코드. 0000으로 응답합니다.

Example: 0000

post

/(파트너사가 제공하는 callbackUrl)

HTTPcURLJavaScriptPython

POST /(파트너사가 제공하는 callbackUrl) HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "memberId": "partner-user-1",
  "merchantId": "partner-merchant-1",
  "member": {
    "id": "[email protected]"
  },
  "merchant": {
    "companyName": "결제선생",
    "branchName": "뚝섬점",
    "businessNumber": 1234567890,
    "reviewStatus": "O",
    "reviewMessage": "심사완료",
    "isDeleted": "N"
  }
}

200

파트너 측 수신 성공

{
  "code": "0000"
}