Ctrlk
X2BEE 바로가기
For the complete documentation index, see llms.txt. This page is also available as Markdown.

마일리지 지급 관리

마일리지 지급 대상자 일괄변경

post

기능설명

  • 마일리지 지급 등록/상세 - 대상자 일괄변경

상세설명

  • 지급예정금액, 담당자메모, 재무메모 값이 없으면 해당 컬럼은 변경을 하지 않습니다.

  • 지급정보 진행상태가 '임시저장' 일 경우만, 변경이 가능합니다.

  • 권한 : 요청자/승인자 모두 가능합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
astPayNostringOptional

지급번호

Example: 1
payFcstAmtnumberOptional

지급예정금액

Example: 10000
aempMemostringOptional

담당자메모

Example: 서비스 불만
finMemostringOptional

재무메모

Example: 매출클레임
mbrNoListstring[]Optional

회원번호리스트

Responses
200

성공

*/*
stringOptional
post/v2/marketing/milgPayMgmt/updateMilgPayMbrMany
POST /api/bo/v2/marketing/milgPayMgmt/updateMilgPayMbrMany HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "astPayNo": 1,
  "payFcstAmt": 10000,
  "aempMemo": "서비스 불만",
  "finMemo": "매출클레임",
  "mbrNoList": [
    "text"
  ]
}
text

마일리지 지급대상자 일괄등록

post

기능 설명

  • 마일리지 지급 등록/상세 - 지급대상자 일괄등록을 합니다.

상세 설명

  • 지급정보 진행상태가 '임시저장' 일 경우만, 등록이 가능합니다.

  • 지급자 검증이 성공인 데이터들만 일괄등록 진행합니다.

  • 재검증 작업을 하며 대상자 등록이 실패할 경우, 메시지를 발생시킵니다.

  • 실패할 경우는 아래와 같습니다

    • 이미 지급정보에 해당 회원이 존재하는 경우

    • 회원 정보가 회원 테이블에 없는 경우

    • 해당 회원번호로 조회된 회원ID가 기입된 회원ID와 다른 경우

    • 지급예정금액(payFcstAmt) 기입을 안한 경우

    • 회원번호(mbrNo) 기입을 안한 경우

  • 권한 : 요청자/승인자 모두 가능합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodyobject · MilgPayMbrRequest[]
astPayNostringOptional

자산지급번호

Example: 1
mbrNostringOptional

회원번호

Example: 10000123
loginIdstringOptional

회원ID

Example: x2bee
payFcstAmtnumberOptional

지급예정금액

Example: 10000
realPayAmtnumberOptional

실지급금액

Example: 10000
ordNostringOptional

주문번호

Example: 20231107O01234
aempMemostringOptional

담당자 메모

Example: 담당자 메모입니다.
finMemostringOptional

재무 메모

Example: 재무 메모입니다.
Responses
200

회원 조회 성공

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

post/v2/marketing/milgPayMgmt/saveMilgPayMbrInfoList
POST /api/bo/v2/marketing/milgPayMgmt/saveMilgPayMbrInfoList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 190

[
  {
    "astPayNo": 1,
    "mbrNo": 10000123,
    "loginId": "x2bee",
    "payFcstAmt": 10000,
    "realPayAmt": 10000,
    "ordNo": "20231107O01234",
    "aempMemo": "담당자 메모입니다.",
    "finMemo": "재무 메모입니다."
  }
]
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": [
    {
      "astPayNo": 1,
      "mbrNo": 10000123,
      "loginId": "x2***",
      "mbrNm": "홍*동",
      "payFcstAmt": 10000,
      "aempMemo": "서비스 불만",
      "finMemo": "매출클레임",
      "ordNo": "20231027O63615",
      "realPayAmt": 10000,
      "successYn": "Y",
      "payFnshmnDtm": "2023-11-06 23:53:46.915",
      "aplyYn": "Y",
      "failCont": "회원번호 불일치"
    }
  ],
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

마일리지 지급 등록/상세 저장

post

기능설명

  • 마일리지 지급 정보를 저장합니다.

상세설명

  • 마일리지 지급 정보 중, 기본정보만 등록합니다.

  • 다음과 같은 유효성 체크가 있습니다.

    • 지급 예정일자는 과거일자 입력이 안됩니다.

    • 유효기간이 '일수' 일때, 입력값은 '730'이 넘으면 안됩니다.

    • 유효기간이 '개월수' 일때, 입력값은 '24'가 넘으면 안됩니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
astPayNostringOptional

자산지급번호

Example: 1
astPayNmstringOptional

자산지급명

Example: 9월 컴플레인 고객 지급
astGbCdstringOptional

자산구분코드(ME015)

Example: 10
payFcstDtstringOptional

지급예정일자

astPayCausCdstringOptional

자산지급사유코드(ME011)

Example: 10
astPayPrgsStatCdstringOptional

자산지급진행상태코드(ME012)

Example: 10
valiTermGbCdstringOptional

유효기간구분코드(ME013)

Example: DD
valiTerminteger · int32Optional

유효기간

Example: 10
aprvReqDtmstring · date-timeOptional

요청접수일시

Example: 2023-01-01 12:00:00
cnfrContsstringOptional

품의내용

Example: 품의내용 입니다.
rtrnCausContsstringOptional

반려사유내용

Example: 반려사유내용 입니다.
delYnstringOptional

삭제여부

Example: N
Responses
200

성공

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

post/v2/marketing/milgPayMgmt/saveMilgPayDtl
POST /api/bo/v2/marketing/milgPayMgmt/saveMilgPayDtl HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 298

{
  "astPayNo": 1,
  "astPayNm": "9월 컴플레인 고객 지급",
  "astGbCd": 10,
  "payFcstDt": "text",
  "astPayCausCd": 10,
  "astPayPrgsStatCd": 10,
  "valiTermGbCd": "DD",
  "valiTerm": 10,
  "aprvReqDtm": "2023-01-01 12:00:00",
  "cnfrConts": "품의내용 입니다.",
  "rtrnCausConts": "반려사유내용 입니다.",
  "delYn": "N"
}
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

마일리지 수동 소멸 처리

post

기능설명

  • 지급된 마일리지를 수동으로 소멸처리 합니다.

상세설명

  • 마일리지 중 오지급 된 마일리지를 수동으로 소멸 처리 합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodyobject · MilgExtctValidateRequestV2[]

마일리지 소멸처리 Grid Request

astMgrSeqstringOptional

자산관리순번

Example: 4364734
condxAstMgrMemostringOptional

소멸사유

Example: 오지급
astRsrvUseGbCdstringOptional

적립사용구분코드(ME016)

Example: 20
balAmtnumberOptional

잔액

Example: 1000
astMgrSeqListstring[]Optional

자산관리순번 목록 API-BO 전달용

astMgrMemostringOptional

소멸사유 API-BO 전달용

Responses
200

성공

*/*
messagestringOptional
dataanyOptional
succeededbooleanOptional
post/v2/marketing/milgPayMgmt/saveMilgExtct
POST /api/bo/v2/marketing/milgPayMgmt/saveMilgExtct HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 132

[
  {
    "astMgrSeq": 4364734,
    "condxAstMgrMemo": "오지급",
    "astRsrvUseGbCd": 20,
    "balAmt": 1000,
    "astMgrSeqList": [
      "text"
    ],
    "astMgrMemo": "text"
  }
]
{
  "message": "text",
  "data": null,
  "succeeded": true
}

마일리지 지급 관리 저장

post

기능설명

  • 마일리지 지급 목록과 자산지급내역정보 목록의 업데이트 정보를 저장합니다.

상세설명

  • 마일리지지급 목록의 삭제여부를 업데이트하고 자산지급내역정보 목록을 삭제합니다.

  • 다음과 같은 유효성 체크가 있습니다.

    • 1건씩 처리 가능합니다.

    • 진행상태가 임시저장일 경우에만 삭제 처리 합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

성공

*/*
integer · int32Optional
post/v2/marketing/milgPayMgmt/milgPaySave
POST /api/bo/v2/marketing/milgPayMgmt/milgPaySave HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 194

{
  "all": [
    {
      "astPayNo": 121,
      "sysModId": "test123"
    }
  ],
  "create": [
    {
      "astPayNo": 121,
      "sysModId": "test123"
    }
  ],
  "update": [
    {
      "astPayNo": 121,
      "sysModId": "test123"
    }
  ],
  "delete": [
    {
      "astPayNo": 121,
      "sysModId": "test123"
    }
  ]
}
1

마일리지 지급 관리 승인요청

post

기능설명

  • 마일리지 지급 관리 승인요청을 진행 합니다.

상세설명

  • 마일리지지급 관리 승인요청을 진행 합니다.

  • 다음과 같은 유효성 체크가 있습니다.

    • 진행상태가 임시저장일 경우에만 승인요청을 진행합니다.

    • 지급대상자가 1이상인 경우에만 승인요청을 진행합니다.

    • 지급대상금액이 1이상일 경우에만 승인요청을 진행합니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodyobject · MilgPayUpdateRequest[]
astPayNostringOptional

지급번호

Example: 121
astPayPrgsStatCdstringOptional

자산지급진행상태코드(ME012)

Example: 10
aprvReqmnIdstringOptional

승인요청자ID

Example: test123
sysModIdstringOptional

시스템수정ID

Example: test123
aprmnIdstringOptional

승인자ID

Example: test123
Responses
200

성공

*/*
integer · int32Optional
post/v2/marketing/milgPayMgmt/milgPayRequestApproval
POST /api/bo/v2/marketing/milgPayMgmt/milgPayRequestApproval HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

[
  {
    "astPayNo": 121,
    "astPayPrgsStatCd": 10,
    "aprvReqmnId": "test123",
    "sysModId": "test123",
    "aprmnId": "test123"
  }
]
1

마일리지 지급 관리 반려

post

기능설명

  • 마일리지 지급 관리 반려 처리를 진행합니다.

상세설명

  • 마일리지 지급 관리 반려 처리를 진행합니다.

  • 다음과 같은 유효성 체크가 있습니다.

    • 진행상태가 승인대기일 경우에만 반려를 진행합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
sysModIdstringOptional

시스템수정ID

Example: test123
astPayNostringOptional

지급번호

Example: 121
rtrnCausContsstringOptional

반려사유내용

Example: 반려사유내용
retnProcmnIdstringOptional

반려처리자ID

Example: test123
Responses
200

성공

*/*
integer · int32Optional
post/v2/marketing/milgPayMgmt/milgPayReject
POST /api/bo/v2/marketing/milgPayMgmt/milgPayReject HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "sysModId": "test123",
  "astPayNo": 121,
  "rtrnCausConts": "반려사유내용",
  "retnProcmnId": "test123"
}
1

마일리지 지급 관리 승인

post

기능설명

  • 마일리지 지급 관리 승인을 진행합니다.

상세설명

  • 마일리지 지급 관리 승인을 진행합니다.

  • 다음과 같은 유효성 체크가 있습니다.

    • 1건씩만 처리 가능합니다.

    • 진행상태가 승인대기일 경우에만 승인을 진행합니다.

    • 요청자 ID와 승인자 ID가 동일하지 않은 경우에만 승인을 진행합니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodyobject · MilgPayUpdateRequest[]
astPayNostringOptional

지급번호

Example: 121
astPayPrgsStatCdstringOptional

자산지급진행상태코드(ME012)

Example: 10
aprvReqmnIdstringOptional

승인요청자ID

Example: test123
sysModIdstringOptional

시스템수정ID

Example: test123
aprmnIdstringOptional

승인자ID

Example: test123
Responses
200

성공

*/*
integer · int32Optional
post/v2/marketing/milgPayMgmt/milgPayApproval
POST /api/bo/v2/marketing/milgPayMgmt/milgPayApproval HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

[
  {
    "astPayNo": 121,
    "astPayPrgsStatCd": 10,
    "aprvReqmnId": "test123",
    "sysModId": "test123",
    "aprmnId": "test123"
  }
]
1

마일리지 지급대상자 검증

post

기능 설명

  • 마일리지 지급 등록/상세 - 지급대상자 일괄등록 업로드 데이터를 검증합니다.

상세 설명

  • 대상자 검증이 실패할 경우, 해당 경우의 실패 메시지를 노출합니다.

  • 실패할 경우는 아래와 같습니다

    • 이미 지급정보에 해당 회원이 존재하는 경우

    • 회원 정보가 회원 테이블에 없는 경우

    • 해당 회원번호로 조회된 회원ID가 기입된 회원ID와 다른 경우

    • 지급예정금액(payFcstAmt) 기입을 안한 경우

    • 회원번호(mbrNo) 기입을 안한 경우

  • 권한 : 요청자/승인자 모두 가능합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodyobject · MilgPayMbrRequest[]
astPayNostringOptional

자산지급번호

Example: 1
mbrNostringOptional

회원번호

Example: 10000123
loginIdstringOptional

회원ID

Example: x2bee
payFcstAmtnumberOptional

지급예정금액

Example: 10000
realPayAmtnumberOptional

실지급금액

Example: 10000
ordNostringOptional

주문번호

Example: 20231107O01234
aempMemostringOptional

담당자 메모

Example: 담당자 메모입니다.
finMemostringOptional

재무 메모

Example: 재무 메모입니다.
Responses
200

회원 검증 성공

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

post/v2/marketing/milgPayMgmt/getMilgPayMbrValidList
POST /api/bo/v2/marketing/milgPayMgmt/getMilgPayMbrValidList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 190

[
  {
    "astPayNo": 1,
    "mbrNo": 10000123,
    "loginId": "x2bee",
    "payFcstAmt": 10000,
    "realPayAmt": 10000,
    "ordNo": "20231107O01234",
    "aempMemo": "담당자 메모입니다.",
    "finMemo": "재무 메모입니다."
  }
]
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "milgPayDtlSucsList": [
      {
        "astPayNo": 1,
        "mbrNo": 10000123,
        "loginId": "x2***",
        "mbrNm": "홍*동",
        "payFcstAmt": 10000,
        "aempMemo": "서비스 불만",
        "finMemo": "매출클레임",
        "ordNo": "20231027O63615",
        "realPayAmt": 10000,
        "successYn": "Y",
        "payFnshmnDtm": "2023-11-06 23:53:46.915",
        "aplyYn": "Y",
        "failCont": "회원번호 불일치"
      }
    ],
    "milgPayDtlFailList": [
      {
        "astPayNo": 1,
        "mbrNo": 10000123,
        "loginId": "x2***",
        "mbrNm": "홍*동",
        "payFcstAmt": 10000,
        "aempMemo": "서비스 불만",
        "finMemo": "매출클레임",
        "ordNo": "20231027O63615",
        "realPayAmt": 10000,
        "successYn": "Y",
        "payFnshmnDtm": "2023-11-06 23:53:46.915",
        "aplyYn": "Y",
        "failCont": "회원번호 불일치"
      }
    ],
    "totCnt": 1,
    "sucsCnt": 0,
    "failCnt": 1
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

마일리지 지급대상자 검증

post

기능 설명

  • 마일리지 지급 등록/상세 - 지급대상자 일괄등록 업로드 데이터를 검증합니다.

상세 설명

  • 대상자 검증이 실패할 경우, 해당 경우의 실패 메시지를 노출합니다.

  • 실패할 경우는 아래와 같습니다

    • 이미 지급정보에 해당 회원이 존재하는 경우

    • 회원 정보가 회원 테이블에 없는 경우

    • 해당 회원번호로 조회된 회원ID가 기입된 회원ID와 다른 경우

    • 지급예정금액(payFcstAmt) 기입을 안한 경우

    • 회원번호(mbrNo) 기입을 안한 경우

  • 권한 : 요청자/승인자 모두 가능합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodyobject · MilgPayMbrRequest[]
astPayNostringOptional

자산지급번호

Example: 1
mbrNostringOptional

회원번호

Example: 10000123
loginIdstringOptional

회원ID

Example: x2bee
payFcstAmtnumberOptional

지급예정금액

Example: 10000
realPayAmtnumberOptional

실지급금액

Example: 10000
ordNostringOptional

주문번호

Example: 20231107O01234
aempMemostringOptional

담당자 메모

Example: 담당자 메모입니다.
finMemostringOptional

재무 메모

Example: 재무 메모입니다.
Responses
200

회원 검증 성공

*/*
astPayNostringOptional

자산지급번호

Example: 1
mbrNostringOptional

회원번호

Example: 10000123
loginIdstringOptional

회원ID

Example: x2***
mbrNmstringOptional

회원명

Example: 홍*동
payFcstAmtnumberOptional

지급예정금액

Example: 10000
aempMemostringOptional

담당자메모

Example: 서비스 불만
finMemostringOptional

재무메모

Example: 매출클레임
ordNostringOptional

관련주문번호

Example: 20231027O63615
realPayAmtnumberOptional

실지급금액

Example: 10000
successYnstringOptional

성공여부

Example: Y
payFnshmnDtmstring · date-timeOptional

지급완료일시

Example: 2023-11-06 23:53:46.915
aplyYnstringOptional

적용여부

Example: Y
failContstringOptional

실패사유

Example: 회원번호 불일치
post/v2/marketing/milgPayMgmt/getMilgPayMbrCheckList
POST /api/bo/v2/marketing/milgPayMgmt/getMilgPayMbrCheckList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 190

[
  {
    "astPayNo": 1,
    "mbrNo": 10000123,
    "loginId": "x2bee",
    "payFcstAmt": 10000,
    "realPayAmt": 10000,
    "ordNo": "20231107O01234",
    "aempMemo": "담당자 메모입니다.",
    "finMemo": "재무 메모입니다."
  }
]
[
  {
    "astPayNo": 1,
    "mbrNo": 10000123,
    "loginId": "x2***",
    "mbrNm": "홍*동",
    "payFcstAmt": 10000,
    "aempMemo": "서비스 불만",
    "finMemo": "매출클레임",
    "ordNo": "20231027O63615",
    "realPayAmt": 10000,
    "successYn": "Y",
    "payFnshmnDtm": "2023-11-06 23:53:46.915",
    "aplyYn": "Y",
    "failCont": "회원번호 불일치"
  }
]

마일리지 지급 승인 처리

post

기능설명

  • 마일리지 지급 승인 처리

상세설명

  • **자산관리번호(astPayNo)**는 필수로 있어야 합니다.

  • **자산지급진행상태코드(astPayPrgsStatCd)**는 필수로 있어야 합니다.

  • 마일리지 지급상세에서 승인대기의 마일리지를 승인 처리

  • 권한 : 승인자만 가능합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
astPayNostringOptional

자산지급번호

Example: 1
astPayNmstringOptional

자산지급명

Example: 9월 컴플레인 고객 지급
astGbCdstringOptional

자산구분코드(ME015)

Example: 10
payFcstDtstringOptional

지급예정일자

astPayCausCdstringOptional

자산지급사유코드(ME011)

Example: 10
astPayPrgsStatCdstringOptional

자산지급진행상태코드(ME012)

Example: 10
valiTermGbCdstringOptional

유효기간구분코드(ME013)

Example: DD
valiTerminteger · int32Optional

유효기간

Example: 10
aprvReqDtmstring · date-timeOptional

요청접수일시

Example: 2023-01-01 12:00:00
cnfrContsstringOptional

품의내용

Example: 품의내용 입니다.
rtrnCausContsstringOptional

반려사유내용

Example: 반려사유내용 입니다.
delYnstringOptional

삭제여부

Example: N
Responses
200

성공

No content
post/v2/marketing/milgPayMgmt/changeAstPayPrgsStatCd
POST /api/bo/v2/marketing/milgPayMgmt/changeAstPayPrgsStatCd HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 298

{
  "astPayNo": 1,
  "astPayNm": "9월 컴플레인 고객 지급",
  "astGbCd": 10,
  "payFcstDt": "text",
  "astPayCausCd": 10,
  "astPayPrgsStatCd": 10,
  "valiTermGbCd": "DD",
  "valiTerm": 10,
  "aprvReqDtm": "2023-01-01 12:00:00",
  "cnfrConts": "품의내용 입니다.",
  "rtrnCausConts": "반려사유내용 입니다.",
  "delYn": "N"
}
No content

마일리지 지급 대상자 일괄변경

post

기능설명

  • 마일리지 지급 등록/상세 - 대상자 일괄변경

상세설명

  • 지급예정금액, 담당자메모, 재무메모 값이 없으면 해당 컬럼은 변경을 하지 않습니다.

  • 지급정보 진행상태가 '임시저장' 일 경우만, 변경이 가능합니다.

  • 권한 : 요청자/승인자 모두 가능합니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
astPayNostringOptional

지급번호

Example: 1
payFcstAmtnumberOptional

지급예정금액

Example: 10000
aempMemostringOptional

담당자메모

Example: 서비스 불만
finMemostringOptional

재무메모

Example: 매출클레임
mbrNoListstring[]Optional

회원번호리스트

Responses
200

성공

*/*
stringOptional
post/v1/marketing/milgPayMgmt/updateMilgPayMbrMany
POST /api/bo/v1/marketing/milgPayMgmt/updateMilgPayMbrMany HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "astPayNo": 1,
  "payFcstAmt": 10000,
  "aempMemo": "서비스 불만",
  "finMemo": "매출클레임",
  "mbrNoList": [
    "text"
  ]
}
text

마일리지 지급대상자 추가 저장

post

기능설명

  • 마일리지 지급 등록/상세 - 지급대상자 추가 저장을 합니다.

상세설명

  • 자산지급번호(astPayNo), 지급예정금 (payFcstAmt) 는 필수값입니다.

  • 지급정보 진행상태가 '임시저장' 일 경우만, 저장이 가능합니다.

  • 해당 지급 정보에 이미 동일 회원이 존재하는 경우, 등록이 안됩니다.

  • 권한 : 요청자/승인자 모두 가능합니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
astPayNostringOptional

자산지급번호

Example: 1
mbrNostringOptional

회원번호

Example: 10000123
loginIdstringOptional

회원ID

Example: x2bee
payFcstAmtnumberOptional

지급예정금액

Example: 10000
realPayAmtnumberOptional

실지급금액

Example: 10000
ordNostringOptional

주문번호

Example: 20231107O01234
aempMemostringOptional

담당자 메모

Example: 담당자 메모입니다.
finMemostringOptional

재무 메모

Example: 재무 메모입니다.
Responses
200

성공

*/*
stringOptional
post/v1/marketing/milgPayMgmt/saveMilgPayMbrInfo
POST /api/bo/v1/marketing/milgPayMgmt/saveMilgPayMbrInfo HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "astPayNo": 1,
  "mbrNo": 10000123,
  "loginId": "x2bee",
  "payFcstAmt": 10000,
  "realPayAmt": 10000,
  "ordNo": "20231107O01234",
  "aempMemo": "담당자 메모입니다.",
  "finMemo": "재무 메모입니다."
}
text

마일리지 지급대상 회원 그리드 저장

post

기능설명

  • 마일리지 지급 등록/상세 - 지급대상 회원 그리드 저장

상세설명

  • 지급대상 회원의 삭제여부를 업데이트하고 지급대상자 목록을 삭제합니다.

  • 지급정보 진행상태가 '임시저장' 일 경우만, 저장이 가능합니다.

  • 권한 : 요청자/승인자 모두 가능합니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

성공

No content
post/v1/marketing/milgPayMgmt/saveMilgPayGrid
POST /api/bo/v1/marketing/milgPayMgmt/saveMilgPayGrid HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 798

{
  "all": [
    {
      "astPayNo": 1,
      "mbrNo": 10000123,
      "loginId": "x2bee",
      "payFcstAmt": 10000,
      "realPayAmt": 10000,
      "ordNo": "20231107O01234",
      "aempMemo": "담당자 메모입니다.",
      "finMemo": "재무 메모입니다."
    }
  ],
  "create": [
    {
      "astPayNo": 1,
      "mbrNo": 10000123,
      "loginId": "x2bee",
      "payFcstAmt": 10000,
      "realPayAmt": 10000,
      "ordNo": "20231107O01234",
      "aempMemo": "담당자 메모입니다.",
      "finMemo": "재무 메모입니다."
    }
  ],
  "update": [
    {
      "astPayNo": 1,
      "mbrNo": 10000123,
      "loginId": "x2bee",
      "payFcstAmt": 10000,
      "realPayAmt": 10000,
      "ordNo": "20231107O01234",
      "aempMemo": "담당자 메모입니다.",
      "finMemo": "재무 메모입니다."
    }
  ],
  "delete": [
    {
      "astPayNo": 1,
      "mbrNo": 10000123,
      "loginId": "x2bee",
      "payFcstAmt": 10000,
      "realPayAmt": 10000,
      "ordNo": "20231107O01234",
      "aempMemo": "담당자 메모입니다.",
      "finMemo": "재무 메모입니다."
    }
  ]
}
No content

마일리지 지급 등록/상세 저장

post

기능설명

  • 마일리지 지급 정보를 저장합니다.

상세설명

  • 마일리지 지급 정보 중, 기본정보만 등록합니다.

  • 다음과 같은 유효성 체크가 있습니다.

    • 지급 예정일자는 과거일자 입력이 안됩니다.

    • 유효기간이 '일수' 일때, 입력값은 '730'이 넘으면 안됩니다.

    • 유효기간이 '개월수' 일때, 입력값은 '24'가 넘으면 안됩니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
astPayNostringOptional

자산지급번호

Example: 1
astPayNmstringOptional

자산지급명

Example: 9월 컴플레인 고객 지급
astGbCdstringOptional

자산구분코드(ME015)

Example: 10
payFcstDtstringOptional

지급예정일자

astPayCausCdstringOptional

자산지급사유코드(ME011)

Example: 10
astPayPrgsStatCdstringOptional

자산지급진행상태코드(ME012)

Example: 10
valiTermGbCdstringOptional

유효기간구분코드(ME013)

Example: DD
valiTerminteger · int32Optional

유효기간

Example: 10
aprvReqDtmstring · date-timeOptional

요청접수일시

Example: 2023-01-01 12:00:00
cnfrContsstringOptional

품의내용

Example: 품의내용 입니다.
rtrnCausContsstringOptional

반려사유내용

Example: 반려사유내용 입니다.
delYnstringOptional

삭제여부

Example: N
Responses
200

성공

*/*
stringOptional
post/v1/marketing/milgPayMgmt/saveMilgPayDtl
POST /api/bo/v1/marketing/milgPayMgmt/saveMilgPayDtl HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 298

{
  "astPayNo": 1,
  "astPayNm": "9월 컴플레인 고객 지급",
  "astGbCd": 10,
  "payFcstDt": "text",
  "astPayCausCd": 10,
  "astPayPrgsStatCd": 10,
  "valiTermGbCd": "DD",
  "valiTerm": 10,
  "aprvReqDtm": "2023-01-01 12:00:00",
  "cnfrConts": "품의내용 입니다.",
  "rtrnCausConts": "반려사유내용 입니다.",
  "delYn": "N"
}
text

마일리지 지급 관리 저장

post

기능설명

  • 마일리지 지급 목록과 자산지급내역정보 목록의 업데이트 정보를 저장합니다.

상세설명

  • 마일리지지급 목록의 삭제여부를 업데이트하고 자산지급내역정보 목록을 삭제합니다.

  • 다음과 같은 유효성 체크가 있습니다.

    • 1건씩 처리 가능합니다.

    • 진행상태가 임시저장일 경우에만 삭제 처리 합니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

성공

*/*
integer · int32Optional
post/v1/marketing/milgPayMgmt/milgPaySave
POST /api/bo/v1/marketing/milgPayMgmt/milgPaySave HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 194

{
  "all": [
    {
      "astPayNo": 121,
      "sysModId": "test123"
    }
  ],
  "create": [
    {
      "astPayNo": 121,
      "sysModId": "test123"
    }
  ],
  "update": [
    {
      "astPayNo": 121,
      "sysModId": "test123"
    }
  ],
  "delete": [
    {
      "astPayNo": 121,
      "sysModId": "test123"
    }
  ]
}
1

마일리지 지급대상자 일괄등록

post

기능 설명

  • 마일리지 지급 등록/상세 - 지급대상자 일괄등록을 합니다.

상세 설명

  • 지급정보 진행상태가 '임시저장' 일 경우만, 등록이 가능합니다.

  • 대상자 등록이 실패할 경우, 해당 경우의 실패 메시지를 노출합니다.

  • 실패할 경우는 아래와 같습니다

    • 이미 지급정보에 해당 회원이 존재하는 경우

    • 회원 정보가 회원 테이블에 없는 경우

    • 해당 회원번호로 조회된 회원ID가 기입된 회원ID와 다른 경우

    • 지급예정금액(payFcstAmt) 기입을 안한 경우

    • 회원번호(mbrNo) 기입을 안한 경우

  • 권한 : 요청자/승인자 모두 가능합니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodyobject · MilgPayMbrRequest[]
astPayNostringOptional

자산지급번호

Example: 1
mbrNostringOptional

회원번호

Example: 10000123
loginIdstringOptional

회원ID

Example: x2bee
payFcstAmtnumberOptional

지급예정금액

Example: 10000
realPayAmtnumberOptional

실지급금액

Example: 10000
ordNostringOptional

주문번호

Example: 20231107O01234
aempMemostringOptional

담당자 메모

Example: 담당자 메모입니다.
finMemostringOptional

재무 메모

Example: 재무 메모입니다.
Responses
200

회원 조회 성공

*/*
astPayNostringOptional

자산지급번호

Example: 1
mbrNostringOptional

회원번호

Example: 10000123
loginIdstringOptional

회원ID

Example: x2***
mbrNmstringOptional

회원명

Example: 홍*동
payFcstAmtnumberOptional

지급예정금액

Example: 10000
aempMemostringOptional

담당자메모

Example: 서비스 불만
finMemostringOptional

재무메모

Example: 매출클레임
ordNostringOptional

관련주문번호

Example: 20231027O63615
realPayAmtnumberOptional

실지급금액

Example: 10000
successYnstringOptional

성공여부

Example: Y
payFnshmnDtmstring · date-timeOptional

지급완료일시

Example: 2023-11-06 23:53:46.915
aplyYnstringOptional

적용여부

Example: Y
failContstringOptional

실패사유

Example: 회원번호 불일치
post/v1/marketing/milgPayMgmt/getMilgPayMbrCheckList
POST /api/bo/v1/marketing/milgPayMgmt/getMilgPayMbrCheckList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 190

[
  {
    "astPayNo": 1,
    "mbrNo": 10000123,
    "loginId": "x2bee",
    "payFcstAmt": 10000,
    "realPayAmt": 10000,
    "ordNo": "20231107O01234",
    "aempMemo": "담당자 메모입니다.",
    "finMemo": "재무 메모입니다."
  }
]
[
  {
    "astPayNo": 1,
    "mbrNo": 10000123,
    "loginId": "x2***",
    "mbrNm": "홍*동",
    "payFcstAmt": 10000,
    "aempMemo": "서비스 불만",
    "finMemo": "매출클레임",
    "ordNo": "20231027O63615",
    "realPayAmt": 10000,
    "successYn": "Y",
    "payFnshmnDtm": "2023-11-06 23:53:46.915",
    "aplyYn": "Y",
    "failCont": "회원번호 불일치"
  }
]

마일리지 지급 승인 처리

post

기능설명

  • 마일리지 지급 승인 처리

상세설명

  • **자산관리번호(astPayNo)**는 필수로 있어야 합니다.

  • **자산지급진행상태코드(astPayPrgsStatCd)**는 필수로 있어야 합니다.

  • 마일리지 지급상세에서 승인대기의 마일리지를 승인 처리

  • 권한 : 승인자만 가능합니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
astPayNostringOptional

자산지급번호

Example: 1
astPayNmstringOptional

자산지급명

Example: 9월 컴플레인 고객 지급
astGbCdstringOptional

자산구분코드(ME015)

Example: 10
payFcstDtstringOptional

지급예정일자

astPayCausCdstringOptional

자산지급사유코드(ME011)

Example: 10
astPayPrgsStatCdstringOptional

자산지급진행상태코드(ME012)

Example: 10
valiTermGbCdstringOptional

유효기간구분코드(ME013)

Example: DD
valiTerminteger · int32Optional

유효기간

Example: 10
aprvReqDtmstring · date-timeOptional

요청접수일시

Example: 2023-01-01 12:00:00
cnfrContsstringOptional

품의내용

Example: 품의내용 입니다.
rtrnCausContsstringOptional

반려사유내용

Example: 반려사유내용 입니다.
delYnstringOptional

삭제여부

Example: N
Responses
200

성공

No content
post/v1/marketing/milgPayMgmt/changeAstPayPrgsStatCd
POST /api/bo/v1/marketing/milgPayMgmt/changeAstPayPrgsStatCd HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 298

{
  "astPayNo": 1,
  "astPayNm": "9월 컴플레인 고객 지급",
  "astGbCd": 10,
  "payFcstDt": "text",
  "astPayCausCd": 10,
  "astPayPrgsStatCd": 10,
  "valiTermGbCd": "DD",
  "valiTerm": 10,
  "aprvReqDtm": "2023-01-01 12:00:00",
  "cnfrConts": "품의내용 입니다.",
  "rtrnCausConts": "반려사유내용 입니다.",
  "delYn": "N"
}
No content

마일리지 지급 관리 승인요청

patch

기능설명

  • 마일리지 지급 관리 승인요청을 진행 합니다.

상세설명

  • 마일리지지급 관리 승인요청을 진행 합니다.

  • 다음과 같은 유효성 체크가 있습니다.

    • 진행상태가 임시저장일 경우에만 승인요청을 진행합니다.

    • 지급대상자가 1이상인 경우에만 승인요청을 진행합니다.

    • 지급대상금액이 1이상일 경우에만 승인요청을 진행합니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodyobject · MilgPayUpdateRequest[]
astPayNostringOptional

지급번호

Example: 121
astPayPrgsStatCdstringOptional

자산지급진행상태코드(ME012)

Example: 10
aprvReqmnIdstringOptional

승인요청자ID

Example: test123
sysModIdstringOptional

시스템수정ID

Example: test123
aprmnIdstringOptional

승인자ID

Example: test123
Responses
200

성공

*/*
integer · int32Optional
patch/v1/marketing/milgPayMgmt/milgPayRequestApproval
PATCH /api/bo/v1/marketing/milgPayMgmt/milgPayRequestApproval HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

[
  {
    "astPayNo": 121,
    "astPayPrgsStatCd": 10,
    "aprvReqmnId": "test123",
    "sysModId": "test123",
    "aprmnId": "test123"
  }
]
1

마일리지 지급 관리 반려

patch

기능설명

  • 마일리지 지급 관리 반려 처리를 진행합니다.

상세설명

  • 마일리지 지급 관리 반려 처리를 진행합니다.

  • 다음과 같은 유효성 체크가 있습니다.

    • 진행상태가 승인대기일 경우에만 반려를 진행합니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
sysModIdstringOptional

시스템수정ID

Example: test123
astPayNostringOptional

지급번호

Example: 121
rtrnCausContsstringOptional

반려사유내용

Example: 반려사유내용
retnProcmnIdstringOptional

반려처리자ID

Example: test123
Responses
200

성공

*/*
integer · int32Optional
patch/v1/marketing/milgPayMgmt/milgPayReject
PATCH /api/bo/v1/marketing/milgPayMgmt/milgPayReject HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "sysModId": "test123",
  "astPayNo": 121,
  "rtrnCausConts": "반려사유내용",
  "retnProcmnId": "test123"
}
1

마일리지 지급 관리 승인

patch

기능설명

  • 마일리지 지급 관리 승인을 진행합니다.

상세설명

  • 마일리지 지급 관리 승인을 진행합니다.

  • 다음과 같은 유효성 체크가 있습니다.

    • 1건씩만 처리 가능합니다.

    • 진행상태가 승인대기일 경우에만 승인을 진행합니다.

    • 요청자 ID와 승인자 ID가 동일하지 않은 경우에만 승인을 진행합니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodyobject · MilgPayUpdateRequest[]
astPayNostringOptional

지급번호

Example: 121
astPayPrgsStatCdstringOptional

자산지급진행상태코드(ME012)

Example: 10
aprvReqmnIdstringOptional

승인요청자ID

Example: test123
sysModIdstringOptional

시스템수정ID

Example: test123
aprmnIdstringOptional

승인자ID

Example: test123
Responses
200

성공

*/*
integer · int32Optional
patch/v1/marketing/milgPayMgmt/milgPayApproval
PATCH /api/bo/v1/marketing/milgPayMgmt/milgPayApproval HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

[
  {
    "astPayNo": 121,
    "astPayPrgsStatCd": 10,
    "aprvReqmnId": "test123",
    "sysModId": "test123",
    "aprmnId": "test123"
  }
]
1

마일리지 집계 현황 사용 목록 조회

get

기능설명

  • 마일리지 집계 현황 사용 리스트 정보를 조회합니다.

상세설명

  • 검색조건에 맞는 마일리지 집계 현황 사용 리스트 정보를 조회합니다. 검색조건은 아래와 같습니다.

    • 시작일

    • 종료일

    • 자산적립사용구분

    • 자산적립사용사유

    • 회원정보

    • 자산관리번호

코드정리

  • 회원정보(mbrOpt): 회원명(NAME), 회원ID(ID), 회원번호(MBRNO)

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Responses
200

성공

*/*
totalCountinteger · int32Optional
get/v2/marketing/milgPayMgmt/milgStatusUseList
GET /api/bo/v2/marketing/milgPayMgmt/milgStatusUseList?milgStatusGridReadRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "standardDate": "2023-10-17 ~ 2023-11-22",
      "astRsrvUseCausNm": "주문사용",
      "milgCount": 370,
      "milgSum": 26471859,
      "astRsrvUseCausCd": 50,
      "astRsrvUseGbCd": 20
    }
  ]
}

마일리지 집계 현황 적립 목록 조회

get

기능설명

  • 마일리지 집계 현황 적립 리스트 정보를 조회합니다.

상세설명

  • 검색조건에 맞는 마일리지 집계 현황 적립 리스트 정보를 조회합니다. 검색조건은 아래와 같습니다.

    • 시작일

    • 종료일

    • 자산적립사용구분

    • 자산적립사용사유

    • 회원정보

    • 자산관리번호

코드정리

  • 회원정보(mbrOpt): 회원명(NAME), 회원ID(ID), 회원번호(MBRNO)

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Responses
200

성공

*/*
totalCountinteger · int32Optional
get/v2/marketing/milgPayMgmt/milgStatusAccumList
GET /api/bo/v2/marketing/milgPayMgmt/milgStatusAccumList?milgStatusGridReadRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "standardDate": "2023-10-17 ~ 2023-11-22",
      "astRsrvUseCausNm": "주문사용",
      "milgCount": 370,
      "milgSum": 26471859,
      "astRsrvUseCausCd": 50,
      "astRsrvUseGbCd": 20
    }
  ]
}

마일리지 지급 관리 목록 조회

get

기능설명

  • 마일리지 지급 관리 정보를 조회합니다.

상세설명

  • 검색조건에 맞는 마일리지 지급 정보를 조회합니다. 검색조건은 아래와 같습니다.

    • 기간(지급예정일, 지급완료일)

    • 지급사유

    • 담당자(요청자, 승인자, 반려자)

    • 진행 상태(저장완료, 요청완료, 승인완료, 반려, 지급완료)

코드정리

  • 날짜 조회 구분 코드 : payFcst(지급예정일), payFnshmn(지급완료일)

  • 담당자 조회 구분 코드 : aprvReqmnId(요청자), aprmn(승인자), retnProcmn(반려자)

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
searchDateTypestringOptional

기간(지급예정일, 지급완료일) 조건

Example: payFcst
startDatestring · dateOptional

시작일자

Example: 2023-11-13
endDatestring · dateOptional

종료일자

Example: 2023-11-13
astPayCausCdstringOptional

지급사유

Example: 10
searchManagerTypestringOptional

담당자(요청자, 승인자, 반려자) 조건

Example: aprvReqmn
userIdstringOptional

담당자 ID

Example: test
astPayPrgsStatCdstringOptional

진행상태

Example: 10
astPayNostringOptional

지급번호

Example: 10
astPayNmstringOptional

지급명

Example: 지급 테스트
dateSelectstringOptional

날짜선택옵션

Example: all_day
rowsPerPagestringRequired

string

Example: 10
pageIdxstringRequired

string

Example: 1
Responses
200

성공

*/*
totalCountinteger · int32Optional
get/v2/marketing/milgPayMgmt/milgPayList
GET /api/bo/v2/marketing/milgPayMgmt/milgPayList?rowsPerPage=text&pageIdx=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "astPayNo": 10,
      "astPayNm": "지급 테스트",
      "astPayCausNm": "이벤트",
      "valiTermGbNm": "일수",
      "valiTerm": 10,
      "astPayPrgsStatNm": "지급완료",
      "fcstPayTgtCnt": 1,
      "fcstPayTgtTotAmt": 1000,
      "realPayTgtCnt": 1,
      "realPayTgtTotAmt": 1000,
      "aprvReqmnNm": "테스트",
      "aprmnNm": "테스트",
      "retnProcmnNm": "테스트",
      "payFcstDt": "2023-11-22",
      "payFnshmnDtm": "2023-11-22 10:05:03",
      "aprvReqDtm": "2023-11-21 16:56:53",
      "aprvDtm": "2023-11-21 16:57:12",
      "retnDtm": "2023-11-21 16:57:12",
      "astPayPrgsStatCd": 21,
      "aprvReqmnId": "x2bee",
      "aprmnId": "x2bee",
      "retnProcmnId": "x2bee"
    }
  ]
}

마일리지 지급대상 회원 목록 조회

get

기능설명

  • 마일리지 지급 등록/상세 - 지급대상 회원 목록을 조회합니다.

상세설명

  • 자산지급번호(astPayNo) 는 필수값입니다.

  • 자산지급번호(astPayNo) 값으로 해당 지급대상 회원 목록을 조회합니다.

  • v2 신규 controller

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Responses
200

성공

*/*
totalCountinteger · int32Optional
get/v2/marketing/milgPayMgmt/getMilgPayMbrInfoList
GET /api/bo/v2/marketing/milgPayMgmt/getMilgPayMbrInfoList?milgPayDtlGridRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "astPayNo": 1,
      "mbrNo": 10000123,
      "loginId": "x2***",
      "mbrNm": "홍*동",
      "payFcstAmt": 10000,
      "aempMemo": "서비스 불만",
      "finMemo": "매출클레임",
      "ordNo": "20231027O63615",
      "realPayAmt": 10000,
      "successYn": "Y",
      "payFnshmnDtm": "2023-11-06 23:53:46.915",
      "aplyYn": "Y",
      "failCont": "회원번호 불일치"
    }
  ]
}

마일리지 소멸 조회

get

기능설명

  • 마일리지 내역을 조회합니다.

상세설명

  • 마일리지 소멸 처리를 위한 마일리지 내역을 조회합니다.

  • 검색조건에 맞는 마일리지 내역을 조회합니다. 검색조건은 아래와 같습니다.

    • 기준일자

    • 조회구분(전체, 적립, 사용)

    • 회원정보(회원명, 회원ID, 회원번호)

    • 자산관리번호

수정번호

  • Release v1.05_231204: 마일리지 적립 내역 조회

  • Release v2.00_240530: 날짜조회 쿼리 변경

코드정리

  • 회원정보(mbrOpt) : 회원명(NAME), 회원ID(ID), 회원번호(MBRNO)

  • 조회구분(condxAstRsrvUseGbOpt) : 전체(ALL)

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Responses
200

성공

*/*
totalCountinteger · int32Optional
get/v2/marketing/milgPayMgmt/getMilgExtctMgmtList
GET /api/bo/v2/marketing/milgPayMgmt/getMilgExtctMgmtList?milgExtctMgmtRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "astMgrSeq": 4369084,
      "mbrNo": 100000390,
      "mbrNm": "홍*동",
      "loginId": "tes****",
      "astRsrvUseGbCd": 20,
      "astRsrvUseGbNm": "사용",
      "astRsrvUseCausNm": "주문사용",
      "astMgrNo": "20231101O062955",
      "ocurAmt": -260000,
      "balAmt": 0,
      "valiStrDt": "2023-11-01",
      "valiEndDt": "2023-11-01",
      "astMgrMemo": "text",
      "sysRegId": 999999999,
      "sysRegDtm": "2023-11-01 09:04:53",
      "sysModId": 999999999,
      "sysModDtm": "2023-11-01 09:04:53"
    }
  ]
}

마일리지 지급 관리 반려 팝업 정보 조회

get

기능설명

  • 마일리지지급 관리 반려 팝업 정보 조회를 조회합니다.

상세설명

  • 검색조건에 맞는 마일리지 정보를 조회합니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
astPayNostringRequired
Responses
200

성공

*/*
astPayNmstringOptional

지급명

Example: 지급 테스트
aprvReqDtmstring · date-timeOptional

승인요청일시

Example: 2023-11-21 16:56:53
astPayCausNmstringOptional

지급사유

Example: 이벤트
valiTermGbNmstringOptional

유효기간구분

Example: 일수
valiTerminteger · int32Optional

유효기간

Example: 10
fcstPayTgtCntinteger · int32Optional

지급대상수

Example: 1
fcstPayTgtTotAmtinteger · int64Optional

지급대상금액

Example: 1000
astPayPrgsStatCdstringOptional

자산지급상태코드

Example: 21
get/v1/marketing/milgPayMgmt/milgPayRejectPopupList
GET /api/bo/v1/marketing/milgPayMgmt/milgPayRejectPopupList?astPayNo=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "astPayNm": "지급 테스트",
  "aprvReqDtm": "2023-11-21 16:56:53",
  "astPayCausNm": "이벤트",
  "valiTermGbNm": "일수",
  "valiTerm": 10,
  "fcstPayTgtCnt": 1,
  "fcstPayTgtTotAmt": 1000,
  "astPayPrgsStatCd": 21
}

마일리지 지급 관리 목록 조회

get

기능설명

  • 마일리지 지급 관리 정보를 조회합니다.

상세설명

  • 검색조건에 맞는 마일리지 지급 정보를 조회합니다. 검색조건은 아래와 같습니다.

    • 기간(지급예정일, 지급완료일)

    • 지급사유

    • 담당자(요청자, 승인자, 반려자)

    • 진행 상태(저장완료, 요청완료, 승인완료, 반려, 지급완료)

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

  • Release v2.00_240530: 날짜조회 쿼리 변경

코드정리

  • 날짜 조회 구분 코드 : payFcst(지급예정일), payFnshmn(지급완료일)

  • 담당자 조회 구분 코드 : aprvReqmnId(요청자), aprmn(승인자), retnProcmn(반려자)

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
searchDateTypestringOptional

기간(지급예정일, 지급완료일) 조건

Example: payFcst
startDatestring · dateOptional

시작일자

Example: 2023-11-13
endDatestring · dateOptional

종료일자

Example: 2023-11-13
astPayCausCdstringOptional

지급사유

Example: 10
searchManagerTypestringOptional

담당자(요청자, 승인자, 반려자) 조건

Example: aprvReqmn
userIdstringOptional

담당자 ID

Example: test
astPayPrgsStatCdstringOptional

진행상태

Example: 10
astPayNostringOptional

지급번호

Example: 10
astPayNmstringOptional

지급명

Example: 지급 테스트
dateSelectstringOptional

날짜선택옵션

Example: all_day
rowsPerPagestringRequired

string

Example: 10
pageIdxstringRequired

string

Example: 1
Responses
200

성공

*/*
astPayNostringOptional

지급번호

Example: 10
astPayNmstringOptional

지급명

Example: 지급 테스트
astPayCausNmstringOptional

지급사유

Example: 이벤트
valiTermGbNmstringOptional

유효기간구분

Example: 일수
valiTerminteger · int32Optional

유효기간

Example: 10
astPayPrgsStatNmstringOptional

진행상태

Example: 지급완료
fcstPayTgtCntinteger · int32Optional

지급대상수

Example: 1
fcstPayTgtTotAmtinteger · int64Optional

지급대상금액

Example: 1000
realPayTgtCntinteger · int32Optional

실지급건수

Example: 1
realPayTgtTotAmtinteger · int64Optional

실지급금액

Example: 1000
aprvReqmnNmstringOptional

승인요청자명

Example: 테스트
aprmnNmstringOptional

승인자명

Example: 테스트
retnProcmnNmstringOptional

반려자명

Example: 테스트
payFcstDtstringOptional

지급예정일

Example: 2023-11-22
payFnshmnDtmstring · date-timeOptional

지급완료일

Example: 2023-11-22 10:05:03
aprvReqDtmstring · date-timeOptional

승인요청일시

Example: 2023-11-21 16:56:53
aprvDtmstring · date-timeOptional

승인일시

Example: 2023-11-21 16:57:12
retnDtmstring · date-timeOptional

반려일시

Example: 2023-11-21 16:57:12
astPayPrgsStatCdstringOptional

자산지급상태코드

Example: 21
aprvReqmnIdstringOptional

승인요청자ID

Example: x2bee
aprmnIdstringOptional

승인자ID

Example: x2bee
retnProcmnIdstringOptional

반려처리자ID

Example: x2bee
get/v1/marketing/milgPayMgmt/milgPayList
GET /api/bo/v1/marketing/milgPayMgmt/milgPayList?rowsPerPage=text&pageIdx=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "astPayNo": 10,
    "astPayNm": "지급 테스트",
    "astPayCausNm": "이벤트",
    "valiTermGbNm": "일수",
    "valiTerm": 10,
    "astPayPrgsStatNm": "지급완료",
    "fcstPayTgtCnt": 1,
    "fcstPayTgtTotAmt": 1000,
    "realPayTgtCnt": 1,
    "realPayTgtTotAmt": 1000,
    "aprvReqmnNm": "테스트",
    "aprmnNm": "테스트",
    "retnProcmnNm": "테스트",
    "payFcstDt": "2023-11-22",
    "payFnshmnDtm": "2023-11-22 10:05:03",
    "aprvReqDtm": "2023-11-21 16:56:53",
    "aprvDtm": "2023-11-21 16:57:12",
    "retnDtm": "2023-11-21 16:57:12",
    "astPayPrgsStatCd": 21,
    "aprvReqmnId": "x2bee",
    "aprmnId": "x2bee",
    "retnProcmnId": "x2bee"
  }
]

마일리지 지급 관리 목록 건수 조회

get

기능설명

  • 마일리지 지급 목록의 건수를 조회합니다.

상세설명

  • 검색조건에 맞는 마일리지 지급 목록의 건수를 조회합니다. 검색조건은 아래와 같습니다.

    • 기간(지급예정일, 지급완료일)

    • 지급사유

    • 담당자(요청자, 승인자, 반려자)

    • 진행 상태(저장완료, 요청완료, 승인완료, 반려, 지급완료)

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

  • Release v2.00_240530: 날짜조회 쿼리 변경

코드정리

  • 날짜 조회 구분 코드 : payFcst(지급예정일), payFnshmn(지급완료일)

  • 담당자 조회 구분 코드 : aprvReqmnId(요청자), aprmn(승인자), retnProcmn(반려자)

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
searchDateTypestringOptional

기간(지급예정일, 지급완료일) 조건

Example: payFcst
startDatestring · dateOptional

시작일자

Example: 2023-11-13
endDatestring · dateOptional

종료일자

Example: 2023-11-13
astPayCausCdstringOptional

지급사유

Example: 10
searchManagerTypestringOptional

담당자(요청자, 승인자, 반려자) 조건

Example: aprvReqmn
userIdstringOptional

담당자 ID

Example: test
astPayPrgsStatCdstringOptional

진행상태

Example: 10
astPayNostringOptional

지급번호

Example: 10
astPayNmstringOptional

지급명

Example: 지급 테스트
dateSelectstringOptional

날짜선택옵션

Example: all_day
Responses
200

성공

*/*
integer · int32Optional
get/v1/marketing/milgPayMgmt/milgPayListCount
GET /api/bo/v1/marketing/milgPayMgmt/milgPayListCount HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

1

마일리지 지급대상 회원 목록 조회

get

기능설명

  • 마일리지 지급 등록/상세 - 지급대상 회원 목록을 조회합니다.

상세설명

  • 자산지급번호(astPayNo) 는 필수값입니다.

  • 자산지급번호(astPayNo) 값으로 해당 지급대상 회원 목록을 조회합니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Responses
200

성공

*/*
astPayNostringOptional

자산지급번호

Example: 1
mbrNostringOptional

회원번호

Example: 10000123
loginIdstringOptional

회원ID

Example: x2***
mbrNmstringOptional

회원명

Example: 홍*동
payFcstAmtnumberOptional

지급예정금액

Example: 10000
aempMemostringOptional

담당자메모

Example: 서비스 불만
finMemostringOptional

재무메모

Example: 매출클레임
ordNostringOptional

관련주문번호

Example: 20231027O63615
realPayAmtnumberOptional

실지급금액

Example: 10000
successYnstringOptional

성공여부

Example: Y
payFnshmnDtmstring · date-timeOptional

지급완료일시

Example: 2023-11-06 23:53:46.915
aplyYnstringOptional

적용여부

Example: Y
failContstringOptional

실패사유

Example: 회원번호 불일치
get/v1/marketing/milgPayMgmt/getMilgPayMbrInfoList
GET /api/bo/v1/marketing/milgPayMgmt/getMilgPayMbrInfoList?milgPayDtlGridRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "astPayNo": 1,
    "mbrNo": 10000123,
    "loginId": "x2***",
    "mbrNm": "홍*동",
    "payFcstAmt": 10000,
    "aempMemo": "서비스 불만",
    "finMemo": "매출클레임",
    "ordNo": "20231027O63615",
    "realPayAmt": 10000,
    "successYn": "Y",
    "payFnshmnDtm": "2023-11-06 23:53:46.915",
    "aplyYn": "Y",
    "failCont": "회원번호 불일치"
  }
]

마일리지 지급대상 회원 목록 건수 조회

get

기능설명

  • 마일리지 지급 등록/상세 - 지급대상 회원 목록 건수를 조회합니다.

상세설명

  • 자산지급번호(astPayNo) 는 필수값입니다.

  • 자산지급번호(astPayNo) 값으로 해당 지급대상 회원 목록 건수를 조회합니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
astPayNostringOptional

지급번호

Responses
200

성공

*/*
integer · int32Optional
get/v1/marketing/milgPayMgmt/getMilgPayMbrInfoListCount
GET /api/bo/v1/marketing/milgPayMgmt/getMilgPayMbrInfoListCount HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

1

마일리지 지급정보 조회

get

기능설명

  • 마일리지 지급 등록/상세 - 지급정보를 조회합니다.

상세설명

  • 자산지급번호(astPayNo) 는 필수값입니다.

  • 자산지급번호(astPayNo) 값으로 해당 마일리지 지급정보를 조회합니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
astPayNostringRequired

string

Example: 1
Responses
200

성공

*/*
astPayNostringOptional

자산지급번호

Example: 1
astPayNmstringOptional

자산지급명

Example: 9월 컴플레인 고객 지급
astGbCdstringOptional

자산구분코드(ME015)

Example: 10
payFcstDtstringOptional

지급예정일자

astPayCausCdstringOptional

자산지급사유코드(ME011)

Example: 10
valiTermGbCdstringOptional

유효기간구분코드(ME013)

Example: DD
valiTerminteger · int32Optional

유효기간

Example: 10
cnfrContsstringOptional

품의내용

Example: 품의내용 입니다.
rtrnCausContsstringOptional

반려사유내용

Example: 반려사유내용 입니다.
astPayPrgsStatCdstringOptional

자산지급진행상태코드(ME012)

Example: 10
astPayPrgsStatNmstringOptional

자산지급진행상태

Example: 임시저장
fcstPayTgtCntinteger · int32Optional

지급대상수

fcstPayTgtTotAmtinteger · int64Optional

지급대상금액

realPayTgtCntinteger · int32Optional

실지급건수

realPayTgtTotAmtinteger · int64Optional

실지급금액

payFnshmnDtmstring · date-timeOptional

지급완료일시

get/v1/marketing/milgPayMgmt/getMilgPayDetail
GET /api/bo/v1/marketing/milgPayMgmt/getMilgPayDetail?astPayNo=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "astPayNo": 1,
  "astPayNm": "9월 컴플레인 고객 지급",
  "astGbCd": 10,
  "payFcstDt": "text",
  "astPayCausCd": 10,
  "valiTermGbCd": "DD",
  "valiTerm": 10,
  "cnfrConts": "품의내용 입니다.",
  "rtrnCausConts": "반려사유내용 입니다.",
  "astPayPrgsStatCd": 10,
  "astPayPrgsStatNm": "임시저장",
  "fcstPayTgtCnt": 1,
  "fcstPayTgtTotAmt": 1,
  "realPayTgtCnt": 1,
  "realPayTgtTotAmt": 1,
  "payFnshmnDtm": "2026-01-01T00:00:00.000Z"
}

마일리지 지급상세 엑셀다운로드

get

기능 설명

  • 마일리지 지급상세 엑셀다운로드

상세 설명

  • **자산관리번호(astPayNo)**는 필수로 있어야 합니다.

  • 마일리지 지급상세의 회원목록을 다운로드합니다.

  • 권한 : 요청자/승인자 모두 가능합니다.

수정번호

  • Release v1.05_231204 : 마일리지 지급관리

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
astPayNostringRequired

자산관리번호

Example: 791
Responses
200

엑셀 다운로드 성공

No content
get/v1/marketing/milgPayMgmt/downLoadExcelPayMbrList
GET /api/bo/v1/marketing/milgPayMgmt/downLoadExcelPayMbrList?astPayNo=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
이전마케팅(Marketing) BO API
다음이벤트 템플릿 관리

마지막 업데이트