> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/store-front-api-reference/order-api/auto-payment-card-management.md).
# Auto Payment Card Management
## Delete Auto-payment Card
> \## 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.\
\
```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/autoPaymentCard/deleteCard":{"put":{"tags":["Auto-Payment Card Management"],"summary":"Delete Auto-payment Card","description":"## Function Description\nDeletes an auto-payment card.\n
\n---\n## Detailed Description\n* This API is only provided when logged in.
\n* Deletes the auto-payment credit card registered for subscription delivery.
\n* When a credit card is deleted, the deletion status value is updated to 'Y'.
\n* Deletion is not allowed if there is an ongoing subscription order application.
\n","operationId":"deleteCard","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoPaymentCardRequest"}}},"required":true},"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"AutoPaymentCardRequest":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"orderInfo":{"$ref":"#/components/schemas/PaymentOrderInfo"},"payInfoList":{"type":"array","description":"Order/Claim DTO Requesting Payment","items":{"$ref":"#/components/schemas/PaymentInfo"}}},"description":"Auto-Payment Card Request DTO"},"PaymentOrderInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."},"goodsNm":{"type":"string","description":"Product Name"},"ordManNm":{"type":"string","description":"Orderer Name"},"ordmnCellNo":{"type":"string","description":"Orderer's Mobile Phone Number"},"ordmnEmailAddr":{"type":"string","description":"Orderer Email Address"},"crcUnitCd":{"type":"string","description":"Currency Unit Code"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)"},"mbrNo":{"type":"string","description":"Member No."},"ordDtlGbCd":{"type":"string","description":"Order Detail Classification Code (OM003)"},"clientIp":{"type":"string","description":"Client IP"},"taxFreeAmt":{"type":"integer","description":"Tax-Exempt Amount","format":"int64"}},"description":"Order DTO Required for Payment"},"PaymentInfo":{"type":"object","properties":{"payNo":{"type":"string","description":"Payment Number"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"mersNo":{"type":"string","description":"Merchant Number"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"selectCardCd":{"type":"string","description":"Payment Request Card Company Code (OM057)"},"termlId":{"type":"string","description":"Terminal ID (mid)"},"billKey":{"type":"string","description":"Billing Key Value to Request Approval"},"authResultMap":{"type":"object","additionalProperties":{"type":"string","description":"Verification Result Information"},"description":"Verification Result Information"}},"description":"Payment DTO"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}},"description":"validation error list"}}}}
```
## Register/Modify Auto-Payment Card
> \## 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.\
\
```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/autoPaymentCard/registerCard":{"post":{"tags":["Auto-Payment Card Management"],"summary":"Register/Modify Auto-Payment Card","description":"## Function Description\nRegisters and changes the auto-payment card.\n
\n---\n## Detailed Description\n* This API is only available when logged in.
\n* The order media code (OM007) value in the order information is required.
\n* The PG type code (OM030) value in the payment information is required.
\n* 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)'.
\n* If the order media is 'PC', additionally requests a billing key from INICIS.
\n* Registers the credit card information based on the billing key and card code received as a result of the INICIS billing key issuance request.
\n* When changing the card, deletes the previously registered card and then saves the newly registered card information.
\n","operationId":"registerCard","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoPaymentCardRequest"}}},"required":true},"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"AutoPaymentCardRequest":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"orderInfo":{"$ref":"#/components/schemas/PaymentOrderInfo"},"payInfoList":{"type":"array","description":"Order/Claim DTO Requesting Payment","items":{"$ref":"#/components/schemas/PaymentInfo"}}},"description":"Auto-Payment Card Request DTO"},"PaymentOrderInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."},"goodsNm":{"type":"string","description":"Product Name"},"ordManNm":{"type":"string","description":"Orderer Name"},"ordmnCellNo":{"type":"string","description":"Orderer's Mobile Phone Number"},"ordmnEmailAddr":{"type":"string","description":"Orderer Email Address"},"crcUnitCd":{"type":"string","description":"Currency Unit Code"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)"},"mbrNo":{"type":"string","description":"Member No."},"ordDtlGbCd":{"type":"string","description":"Order Detail Classification Code (OM003)"},"clientIp":{"type":"string","description":"Client IP"},"taxFreeAmt":{"type":"integer","description":"Tax-Exempt Amount","format":"int64"}},"description":"Order DTO Required for Payment"},"PaymentInfo":{"type":"object","properties":{"payNo":{"type":"string","description":"Payment Number"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"mersNo":{"type":"string","description":"Merchant Number"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"selectCardCd":{"type":"string","description":"Payment Request Card Company Code (OM057)"},"termlId":{"type":"string","description":"Terminal ID (mid)"},"billKey":{"type":"string","description":"Billing Key Value to Request Approval"},"authResultMap":{"type":"object","additionalProperties":{"type":"string","description":"Verification Result Information"},"description":"Verification Result Information"}},"description":"Payment DTO"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}},"description":"validation error list"}}}}
```
## Search Auto-Payment Card Info
> \## 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
```json
{"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/autoPaymentCard/getCardInfo":{"get":{"tags":["Auto-Payment Card Management"],"summary":"Search Auto-Payment Card Info","description":"## Function Description\nRetrieves the auto-payment card information.\n
\n---\n## Detailed Description\n* This API is only available when logged in.
\n* For logged-in users, retrieves the already registered auto-payment credit card information.
\n* Retrieves, based on the member number (mbrNo), the credit card that has not been deleted and whose applicable period is valid.
\n* 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.
\n---\n## Revision Number\n* Release v2.00_240627: Added site number to the auto-payment card lookup\n","operationId":"getCardInfo","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/AutoPaymentCardRequest"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AutoPaymentCardResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"AutoPaymentCardRequest":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"orderInfo":{"$ref":"#/components/schemas/PaymentOrderInfo"},"payInfoList":{"type":"array","description":"Order/Claim DTO Requesting Payment","items":{"$ref":"#/components/schemas/PaymentInfo"}}},"description":"Auto-Payment Card Request DTO"},"PaymentOrderInfo":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No."},"claimNo":{"type":"string","description":"Claim No."},"goodsNm":{"type":"string","description":"Product Name"},"ordManNm":{"type":"string","description":"Orderer Name"},"ordmnCellNo":{"type":"string","description":"Orderer's Mobile Phone Number"},"ordmnEmailAddr":{"type":"string","description":"Orderer Email Address"},"crcUnitCd":{"type":"string","description":"Currency Unit Code"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)"},"mbrNo":{"type":"string","description":"Member No."},"ordDtlGbCd":{"type":"string","description":"Order Detail Classification Code (OM003)"},"clientIp":{"type":"string","description":"Client IP"},"taxFreeAmt":{"type":"integer","description":"Tax-Exempt Amount","format":"int64"}},"description":"Order DTO Required for Payment"},"PaymentInfo":{"type":"object","properties":{"payNo":{"type":"string","description":"Payment Number"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payAmt":{"type":"integer","description":"Payment Amount","format":"int64"},"mersNo":{"type":"string","description":"Merchant Number"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"trdNo":{"type":"string","description":"Transaction No. (tid)"},"selectCardCd":{"type":"string","description":"Payment Request Card Company Code (OM057)"},"termlId":{"type":"string","description":"Terminal ID (mid)"},"billKey":{"type":"string","description":"Billing Key Value to Request Approval"},"authResultMap":{"type":"object","additionalProperties":{"type":"string","description":"Verification Result Information"},"description":"Verification Result Information"}},"description":"Payment DTO"},"AutoPaymentCardResponse":{"type":"object","properties":{"cardInfo":{"$ref":"#/components/schemas/OpMbrAutoPayInfo"}},"description":"Auto-Payment Card Response DTO","nullable":true},"OpMbrAutoPayInfo":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"mbrNo":{"type":"string","description":"Customer No."},"aplyStrDtm":{"type":"string","description":"Application Start Date/Time","format":"date-time"},"aplyEndDtm":{"type":"string","description":"Application End Date/Time","format":"date-time"},"pgGbCd":{"type":"string","description":"OM030 (PG Type Code)\n 10: INICIS\n,20: TOSS\n","enum":["INICIS","TOSS"]},"pgGbCdNm":{"type":"string","description":"PG Classification Code Name (OM030)"},"acqrCd":{"type":"string","description":"Purchasing Company Code (OM028)"},"acqrCdNm":{"type":"string","description":"Acquirer Code Name (OM028)"},"cardNo":{"type":"string","description":"Card No."},"bllgKeyNo":{"type":"string","description":"Billing Key No."},"bllgKeyRegDtm":{"type":"string","description":"Billing Key Registration Date/Time","format":"date-time"},"delYn":{"type":"string","description":"Deletion Status"}},"description":"Member Auto-Payment Info","nullable":true},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}},"description":"validation error list"}}}}
```