Auto Payment Card Management

Delete Auto-payment Card

put

Function Description

Deletes an auto-payment card.

Detailed Description

This API is only provided when logged in.
Deletes the auto-payment credit card registered for subscription delivery.
When a credit card is deleted, the deletion status value is updated to 'Y'.
Deletion is not allowed if there is an ongoing subscription order application.

Header parameters

AuthorizationanyOptional

Access Token

Body

Auto-Payment Card Request DTO

siteNostringOptional

Site No.

Example: 1

Responses

200

Success

No content

900

Business processing error details

*/*

put/v1/autoPaymentCard/deleteCard

PUT /api/order/v1/autoPaymentCard/deleteCard HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 713

{
  "siteNo": "1",
  "orderInfo": {
    "ordNo": "20990101O000001",
    "claimNo": "20990101C000001",
    "goodsNm": "플래티어커피",
    "ordManNm": "김플래티어",
    "ordmnCellNo": 1012345678,
    "ordmnEmailAddr": "kim@plateer.com",
    "crcUnitCd": "KRW",
    "ordMediaCd": "30",
    "mbrNo": "100000001",
    "ordDtlGbCd": "10",
    "clientIp": "127.0.0.1",
    "taxFreeAmt": 1
  },
  "payInfoList": [
    {
      "payNo": "1",
      "payWayCd": "11",
      "payAmt": 1000,
      "mersNo": "1",
      "pgGbCd": "10",
      "trdNo": "INIMX_DBNKINIpayTest20990101090000685510",
      "selectCardCd": "01",
      "termlId": "INIBillTst",
      "billKey": "text",
      "authResultMap": "{P_STATUS:결과코드, P_RMESG1:결과메시지, P_TID:인증거래번호, P_AMT:거래금액, idc_name:IDC센터코드P_REQ_URL:승인요청 URL, P_NOTI:가맹점 임의 데이터}"
    }
  ]
}

No content

Register/Modify Auto-Payment Card

post

Function Description

Registers and changes the auto-payment card.

Detailed Description

This API is only available when logged in.
The order media code (OM007) value in the order information is required.
The PG type code (OM030) value in the payment information is required.
Processing succeeds normally only when the payment method (OM013, Payment Method Code) is 'Credit Card (11)' and the PG type (OM030, PG Type Code) is 'INICIS (10)/Toss (20)'.
If the order media is 'PC', additionally requests a billing key from INICIS.
Registers the credit card information based on the billing key and card code received as a result of the INICIS billing key issuance request.
When changing the card, deletes the previously registered card and then saves the newly registered card information.

Header parameters

AuthorizationanyOptional

Access Token

Body

Auto-Payment Card Request DTO

siteNostringOptional

Site No.

Example: 1

Responses

200

Success

No content

900

Business processing error details

*/*

post/v1/autoPaymentCard/registerCard

POST /api/order/v1/autoPaymentCard/registerCard HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 713

{
  "siteNo": "1",
  "orderInfo": {
    "ordNo": "20990101O000001",
    "claimNo": "20990101C000001",
    "goodsNm": "플래티어커피",
    "ordManNm": "김플래티어",
    "ordmnCellNo": 1012345678,
    "ordmnEmailAddr": "kim@plateer.com",
    "crcUnitCd": "KRW",
    "ordMediaCd": "30",
    "mbrNo": "100000001",
    "ordDtlGbCd": "10",
    "clientIp": "127.0.0.1",
    "taxFreeAmt": 1
  },
  "payInfoList": [
    {
      "payNo": "1",
      "payWayCd": "11",
      "payAmt": 1000,
      "mersNo": "1",
      "pgGbCd": "10",
      "trdNo": "INIMX_DBNKINIpayTest20990101090000685510",
      "selectCardCd": "01",
      "termlId": "INIBillTst",
      "billKey": "text",
      "authResultMap": "{P_STATUS:결과코드, P_RMESG1:결과메시지, P_TID:인증거래번호, P_AMT:거래금액, idc_name:IDC센터코드P_REQ_URL:승인요청 URL, P_NOTI:가맹점 임의 데이터}"
    }
  ]
}

No content

Search Auto-Payment Card Info

get

Function Description

Retrieves the auto-payment card information.

Detailed Description

This API is only available when logged in.
For logged-in users, retrieves the already registered auto-payment credit card information.
Retrieves, based on the member number (mbrNo), the credit card that has not been deleted and whose applicable period is valid.
If there is no registered credit card information, returns the member information and a randomly generated order number needed to register an auto-payment credit card.

Revision Number

Release v2.00_240627: Added site number to the auto-payment card lookup

Query parameters

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

Auto-Payment Card Response DTO

900

Business processing error details

*/*

get/v1/autoPaymentCard/getCardInfo

GET /api/order/v1/autoPaymentCard/getCardInfo?request=[object+Object] HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

{
  "cardInfo": {
    "siteNo": "1",
    "mbrNo": "100000001",
    "aplyStrDtm": "2026-01-01T00:00:00.000Z",
    "aplyEndDtm": "2026-01-01T00:00:00.000Z",
    "pgGbCd": "10",
    "pgGbCdNm": "이니시스(INICIS)",
    "acqrCd": "102",
    "acqrCdNm": "삼성카드",
    "cardNo": "123456*********7",
    "bllgKeyNo": "371837374a8dcc1f8a04c15c802dfc40954cf5e7",
    "bllgKeyRegDtm": "2026-01-01T00:00:00.000Z",
    "delYn": "N"
  }
}

PreviousCart

NextProduct Provision

Last updated 2 months ago