{"openapi":"3.1.0","info":{"title":"Gift Voucher Service","termsOfService":"https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/6.51+Gift+Voucher","contact":{"name":"#gift-voucher-dev","url":"https://thebaymaxproject.slack.com/archives/C03P0GDESKS"},"version":"1.0"},"servers":[{"url":"https://stg.paypay-corp.co.jp/gift-voucher","description":"Generated server url"}],"security":[{"Bearer Authentication":[]}],"tags":[{"name":"Issuer","description":"APIs to perform CRUD operations on issuer entities"},{"name":"Store","description":"APIs to perform CRUD operations on store entities"},{"name":"Merchant-Store","description":"APIs to perform CRUD operations on store as well as merchant entities"},{"name":"Ledger","description":"Ledger operations including debit, refunds, and reversals"},{"name":"Recovery","description":"Various recovery endpoints for internal uses"},{"name":"Gift Voucher","description":"APIs to perform CRUD operations on gift voucher entities"},{"name":"Configuration","description":"APIs to perform CRUD operations on configuration entities"},{"name":"Merchant","description":"APIs to perform CRUD operations on merchant entities"}],"paths":{"/v1/merchant-stores":{"put":{"tags":["Merchant-Store"],"summary":"API for creating new merchants connected to the config with optional storeID","operationId":"putMerchantStoresV1","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"4be8012d-b7fd-4f41-9697-bc770f50295f"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutMerchantStoresV1Request"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[CONFIG_EXPIRED, CONFIG_TYPE_MISMATCH, INVALID_AVAILABILITY_DATE, AVAILABILITY_DATE_EDIT_NOT_ALLOWED]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[CONFIG_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"[DUPLICATE_MERCHANT_ID, CONFIGURATION_NOT_ALLOWED, PENDING_SCHEDULED_UPLOAD_ERROR]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"204":{"description":"No Content"},"200":{"description":"OK"}}},"delete":{"tags":["Merchant-Store"],"summary":"Delete merchant stores connected to the config","operationId":"deleteMerchantStoresV1","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"6a455787-a64f-4772-8303-98bc3a0276a2"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMerchantStoresV1Request"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[CONFIG_EXPIRED, CONFIG_TYPE_MISMATCH]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[CONFIG_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"204":{"description":"No Content"},"200":{"description":"OK"}}}},"/v1/issuer/merchants":{"get":{"tags":["Issuer"],"summary":"API for fetching issuer merchants connected to the config","operationId":"getIssuerMerchantsV1","parameters":[{"name":"configUUID","in":"query","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"identifierOffset","in":"query","required":false,"schema":{"type":"integer"}},{"name":"sortOrder","in":"query","required":true,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}},{"name":"sortBy","in":"query","required":true,"schema":{"type":"string","enum":["MERCHANT_ID"]}},{"name":"limit","in":"query","required":true,"schema":{"type":"string","format":"byte","maximum":20}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[CONFIG_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIssuerMerchantsV1Response"}}}}}},"put":{"tags":["Issuer"],"summary":"API for creating new issuer merchants connected to the config","operationId":"putIssuerMerchantsV1","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"bcfa423a-f31c-4943-b8fa-9db039f0880d"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutIssuerMerchantsV1Request"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[CONFIG_EXPIRED]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[CONFIG_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"204":{"description":"No Content"},"200":{"description":"OK"}}},"delete":{"tags":["Issuer"],"summary":"Delete issuer merchants connected to the config","operationId":"deleteIssuerMerchantsV1","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"088ad5c8-af23-4e6d-b935-8e088bf7a293"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteIssuerMerchantsV1Request"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[CONFIG_EXPIRED]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[CONFIG_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"204":{"description":"No Content"},"200":{"description":"OK"}}}},"/v3/ledger/debit":{"post":{"tags":["Ledger"],"summary":"Debit gift vouchers with the given amount","description":"This API debits from a list of gift vouchers only if it is accepted on the given store","operationId":"debitV3","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"ab6a2076-bf93-44c6-9397-156864d6ed91"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitV3Request"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[DEBIT_NOT_POSSIBLE, GIFT_VOUCHER_INVALID_PAY_METHOD]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"[GIFT_VOUCHER_ACCESS_DENIED]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitV3Response"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitV3Response"}}}}}}},"/v2/ledger/debit/reversal":{"post":{"tags":["Ledger"],"summary":"Reverse a debit transaction with support for multiple gv","operationId":"debitReversalV2","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"37f137d1-100c-4456-9e8c-630907739fa1"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitReversalV2Request"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[REVERSAL_NOT_POSSIBLE, MAX_GV_BALANCE_LIMIT_EXCEEDED]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitReversalV2Response"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitReversalV2Response"}}}}}}},"/v2/ledger/debit/refund":{"post":{"tags":["Ledger"],"summary":"Refund an existing debit transaction using multiple gift vouchers (partially or fully)","operationId":"debitRefundV2","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"0bffe5d3-5444-4ce1-a137-1ee6f24f6832"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitRefundV2Request"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[REFUND_NOT_POSSIBLE]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitRefundV2Response"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitRefundV2Response"}}}}}}},"/v2/config":{"post":{"tags":["Configuration"],"summary":"Create a new config","description":"This API creates a new config","operationId":"addConfigV2","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"4be059a1-6258-420a-b5af-8041f938229e"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddConfigV2Request"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddConfigV2Response"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddConfigV2Response"}}}}}}},"/v1/recovery/publisher/user-gift-voucher-info":{"post":{"tags":["Recovery"],"summary":"Republishes the latest information about a gift voucher with a given UUID to the topic user.gift-voucher.info","operationId":"publishUserGiftVoucherInfoV1","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"77593f02-eae0-4f6e-9de0-ec3662479e07"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishUserGiftVoucherInfoV1Request"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[GIFT_VOUCHER_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"204":{"description":"No Content"},"200":{"description":"OK"}}}},"/v1/ledger/re-authorize":{"post":{"tags":["Ledger"],"summary":"Re-authorize an existing pre-auth transaction","description":"Adjust the amount on existing pre-auth gift vouchers value.\nAllows merchants to modify preauthorized payment amounts after initial preauthorization.\nIdempotent via Idempotency-Key. Returns processedAt and ledgerDetails.\n","operationId":"reAuthorize","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"321ebcce-bc2b-43f0-997b-fc9b9a3ee06f"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReAuthRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[GIFT_VOUCHER_INSUFFICIENT_BALANCE, INVALID_RE_AUTH_PAYMENT_AMOUNT, MAX_GV_BALANCE_LIMIT_EXCEEDED]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[PARENT_UUID_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReAuthResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReAuthResponse"}}}}}}},"/v1/ledger/pre-authorize":{"post":{"tags":["Ledger"],"summary":"Create a pre-authorization","description":"Reserve (HOLD) balance on one or more Gift Vouchers for a given user/order/merchant/store/serviceType.\nIdempotent via Idempotency-Key. Returns parentUUID/referenceUUID and the HOLD breakdown.\nGV auto-selection follows \"nearest expiry, then higher balance\" strategy.\nUse giftVouchersHoldInfo for manual GV selection; or amount for auto-selection.\nExactly one of giftVouchersHoldInfo and amount must be present.\n","operationId":"preAuthorize","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"27d45d75-9f34-4037-84b8-766b032a2051"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreAuthRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[GIFT_VOUCHER_INSUFFICIENT_BALANCE, PREAUTH_NOT_POSSIBLE, GIFT_VOUCHER_INVALID_PAY_METHOD]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"[GIFT_VOUCHER_ACCESS_DENIED]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreAuthResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreAuthResponse"}}}}}}},"/v1/ledger/pre-authorize/reversal":{"post":{"tags":["Ledger"],"summary":"Reverse a pre-authorization transaction","description":"Release the held amount corresponding to the given parentUUID from pre-authorization.\nAPI is idempotent via Idempotency-Key header.\nReturns parentUUID, order ID, GV IDs and corresponding reversed amounts.\nSupports partial reversal failures (e.g., expired/disabled GVs result in RELEASE_FAILED operations).\nWhen CC-GV max limit is exceeded, throws MAX_GV_BALANCE_LIMIT_EXCEEDED for retry capability.\n","operationId":"preAuthorizeReversal","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"2790094c-87f7-41d3-8a32-c4ad40dac87f"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreAuthorizeReversalRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[REVERSAL_NOT_POSSIBLE, MAX_GV_BALANCE_LIMIT_EXCEEDED]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreAuthorizeReversalResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreAuthorizeReversalResponse"}}}}}}},"/v1/ledger/pre-authorize/capture":{"post":{"tags":["Ledger"],"summary":"Capture pre-authorized amounts","description":"Convert held balances (HOLD entries) into confirmed debits (DEBIT entries) against Gift Vouchers.\nCalled when the order is completed to finalize the transaction\n            Requires the parentUUID from the original pre-auth request\nIdempotent via Idempotency-Key\n","operationId":"capture","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"ab9f36d5-21c5-4a1b-a241-7ad8a35f31e9"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptureRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[CAPTURE_NOT_POSSIBLE]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[PARENT_UUID_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptureResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptureResponse"}}}}}}},"/v1/ledger/gift-voucher/breakdown":{"post":{"tags":["Ledger"],"summary":"Publish Gift Voucher Transaction Breakdown","description":"Publish Gift Voucher Transaction Breakdown based on referenceUUID","operationId":"ledgerGiftVoucherBreakdownV1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerGiftVoucherBreakdownV1Request"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"204":{"description":"No Content"}}}},"/v1/gift-voucher":{"get":{"tags":["Gift Voucher"],"summary":"Get a gift voucher","description":"This API returns a gift voucher by UUID","operationId":"getGiftVoucherV1","parameters":[{"name":"giftVoucherUUID","in":"query","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[GIFT_VOUCHER_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGiftVoucherV1Response"}}}}}},"post":{"tags":["Gift Voucher"],"summary":"Create a new gift voucher","description":"This API creates a new gift voucher corresponding to an existing config","operationId":"addGiftVoucherV1","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"a1c6e5e3-21c7-4234-9eb4-2852ab6c2c51"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddGiftVoucherV1Request"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[CONFIG_STATUS_MISMATCH, CONFIG_EXPIRED, CONFIG_NOT_STARTED, CONFIG_DEFAULT_DURATION_EXCEEDED, MAX_GV_BALANCE_LIMIT_EXCEEDED]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[CONFIG_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddGiftVoucherV1Response"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddGiftVoucherV1Response"}}}}}},"patch":{"tags":["Gift Voucher"],"summary":"Update Gift Voucher","description":"This API updates gift voucher fields, specified by the gift voucher's UUID","operationId":"updateGiftVoucherV1","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"b331ec01-80ac-4143-b569-b9f44e48d7e0"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGiftVoucherV1Request"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[GIFT_VOUCHER_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGiftVoucherV1Response"}}}}}}},"/v1/gift-voucher/status/expire":{"patch":{"tags":["Gift Voucher"],"summary":"Expire a gift voucher","description":"This API expires a gift voucher, specified by the gift voucher's UUID","operationId":"expireGiftVoucherV1","parameters":[{"name":"giftVoucherUUID","in":"query","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"d009c98e-6048-4974-b522-000b733b0039"}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[GIFT_VOUCHER_STATUS_MISMATCH, GIFT_VOUCHER_NOT_EXPIRED]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[GIFT_VOUCHER_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"204":{"description":"No Content"},"200":{"description":"OK"}}}},"/v1/gift-voucher/status/disable":{"patch":{"tags":["Gift Voucher"],"summary":"Disable a gift voucher","description":"This API disables a gift voucher, specified by the gift voucher's UUID","operationId":"disableGiftVoucherV1","parameters":[{"name":"giftVoucherUUID","in":"query","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"59c4ae84-4af8-46cc-94df-88d24123f153"}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[GIFT_VOUCHER_STATUS_MISMATCH, GIFT_VOUCHER_EXPIRED]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[GIFT_VOUCHER_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"204":{"description":"No Content"},"200":{"description":"OK"}}}},"/v1/gift-voucher/dispute":{"patch":{"tags":["Gift Voucher"],"summary":"Create a gift voucher dispute","description":"This API creates a new gift voucher dispute corresponding to an existing gift voucher uuid","operationId":"addGiftVoucherDisputeV1","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"86b102a0-3dcc-4a64-9ac7-fbeab663a5ef"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddGiftVoucherDisputeV1Request"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[DISPUTE_GIFT_VOUCHER_INSUFFICIENT_BALANCE, NON_CC_GV_DISPUTE_NOT_ALLOWED]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[GIFT_VOUCHER_NOT_FOUND, CONFIG_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddGiftVoucherDisputeV1Response"}}}}}}},"/v1/config":{"get":{"tags":["Configuration"],"summary":"Get a config","description":"This API returns a config by UUID","operationId":"getConfigV1","parameters":[{"name":"configUUID","in":"query","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[CONFIG_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigV1Response"}}}}}},"patch":{"tags":["Configuration"],"summary":"Modify existing config","description":"Modify existing config identified by its config UUID","operationId":"updateConfigV1","parameters":[{"name":"Idempotency-Key","in":"header","description":"[Gift Voucher service's HTTP request headers reference page](https://paypay-corp.rickcloud.jp/wiki/display/ProductDevDiv/Idempotency-Key)","required":true,"example":"1f8b0a45-f25c-43bb-9fd7-fe3caefba838"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConfigV1Request"}}},"required":true},"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[DEFAULT_DURATION_DAYS_UPDATE_NOT_ALLOWED_FOR_CC_GV]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[CONFIG_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"204":{"description":"No Content"},"200":{"description":"OK"}}}},"/v2/ledger/debit/refund/consult":{"get":{"tags":["Ledger"],"summary":"Returns refundable amount for an existing ledger entry","description":"This API checks returns the refundable amount for an existing ledger entry","operationId":"debitRefundConsultV2","parameters":[{"name":"orderID","in":"query","required":true,"schema":{"type":"integer"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitRefundConsultV2Response"}}}}}}},"/v2/ledger/debit/consult":{"get":{"tags":["Ledger"],"summary":"Checks whether the user will be able to completely cover the payment amount using Gift Vouchers","description":"This API returns the amount that can be covered using gift vouchers and details for gift vouchers to be used for the transaction","operationId":"debitConsultV2","parameters":[{"name":"userID","in":"query","required":true,"schema":{"type":"integer"}},{"name":"merchantID","in":"query","required":true,"schema":{"type":"integer"}},{"name":"storeID","in":"query","required":false,"schema":{"type":"integer"}},{"name":"currency","in":"query","required":true,"schema":{"type":"string","enum":["JPY"]}},{"name":"cents","in":"query","required":true,"schema":{"type":"integer","format":"int64","example":500}},{"name":"serviceType","in":"query","required":false,"schema":{"type":"string"}},{"name":"orderID","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[ORDER_ID_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitConsultV2Response"}}}}}}},"/v2/gift-vouchers/usable":{"get":{"tags":["Gift Voucher"],"summary":"Get details of usable vouchers, which excludes expired and exhausted vouchers.Gift Voucher can belong to online merchant or offline merchant store. ","description":"When MerchantID is present, exactly one of includeGvType, excludeGvType, or serviceType must be set per request. When MerchantID is absent, at most one of includeGvType, excludeGvType, or serviceType can be set.Refer https://docs.google.com/spreadsheets/d/1RKdPF2nXzOeEtvoklty2E69cqMBVOoDSJLYaUXKpT14/edit?usp=sharing for CC GV inclusion/exclusion matrix.","operationId":"getUsableGiftVouchersV2","parameters":[{"name":"merchantID","in":"query","required":false,"schema":{"type":"integer"}},{"name":"storeID","in":"query","required":false,"schema":{"type":"integer"}},{"name":"includeGvTypes","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["SATOFULL_GV","G2C_GV","CC_GV","MERCHANT_GV"]}}},{"name":"excludeGvTypes","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["SATOFULL_GV","G2C_GV","CC_GV","MERCHANT_GV"]}}},{"name":"userID","in":"query","required":false,"schema":{"type":"integer"}},{"name":"serviceType","in":"query","required":false,"schema":{"type":"string"}},{"name":"identifierOffset","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"dateTimeOffset","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"sortOrder","in":"query","required":true,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}},{"name":"sortBy","in":"query","required":true,"schema":{"type":"string","enum":["CREATION_DATE_TIME","EXPIRATION_DATE_TIME"]}},{"name":"limit","in":"query","description":"Maximum number of gift vouchers to return. If not provided, defaults to 2147483646 (effectively no limit).","required":false,"schema":{"type":"integer","format":"int32","description":"Maximum number of gift vouchers to return. If not provided, defaults to 2147483646 (effectively no limit).","maximum":2147483646}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUsableGiftVouchersV2Response"}}}}}}},"/v2/gift-vouchers/usable/balances":{"get":{"tags":["Gift Voucher"],"summary":"Get sum of CC_GV usable balance and other GV's usable balance and balance to be expired of all gift vouchers of a user","operationId":"getUsableGiftVouchersBalancesV2","parameters":[{"name":"expiryWithinDays","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUsableGiftVouchersBalancesV2Response"}}}}}}},"/v2/gift-vouchers/usable/balance":{"get":{"tags":["Gift Voucher"],"summary":"Get sum CC_GV usable balance and other GV's usable balance of a user","operationId":"getUsableGiftVouchersBalanceV2","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUsableGiftVouchersBalanceV2Response"}}}}}}},"/v1/stores":{"get":{"tags":["Store"],"summary":"API for fetching stores connected to the config","operationId":"getStoresV1","parameters":[{"name":"configUUID","in":"query","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"recordType","in":"query","required":false,"schema":{"type":"string","default":"LIVE","enum":["LIVE","SCHEDULED"]}},{"name":"identifierOffset","in":"query","required":false,"schema":{"type":"integer"}},{"name":"merchantIDOffset","in":"query","required":false,"schema":{"type":"integer"}},{"name":"sortOrder","in":"query","required":true,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}},{"name":"sortBy","in":"query","required":true,"schema":{"type":"string","enum":["STORE_ID","MERCHANT_ID"]}},{"name":"limit","in":"query","required":true,"schema":{"type":"integer","format":"int32","maximum":1000}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[CONFIG_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStoresV1Response"}}}}}}},"/v1/merchants":{"get":{"tags":["Merchant"],"summary":"API for fetching merchants connected to the config","operationId":"getMerchantsV1","parameters":[{"name":"configUUID","in":"query","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"recordType","in":"query","required":false,"schema":{"type":"string","default":"LIVE","enum":["LIVE","SCHEDULED"]}},{"name":"identifierOffset","in":"query","required":false,"schema":{"type":"integer"}},{"name":"sortOrder","in":"query","required":true,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}},{"name":"sortBy","in":"query","required":true,"schema":{"type":"string","enum":["MERCHANT_ID"]}},{"name":"limit","in":"query","required":true,"schema":{"type":"integer","format":"int32","maximum":1000}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[CONFIG_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMerchantsV1Response"}}}}}}},"/v1/ledger/entries":{"get":{"tags":["Ledger"],"summary":"Provides the list of ledger entries associated with the gift-voucher","description":"This API returns the list of all the ledger entries associated with the gift-voucher","operationId":"getLedgerEntriesV1","parameters":[{"name":"giftVoucherUUID","in":"query","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLedgerEntriesV1Response"}}}}}}},"/v1/ledger/debit/aggregated":{"get":{"tags":["Ledger"],"summary":"monthly aggregated debit data for credit card gift vouchers","description":"This API returns the monthly aggregated debit data for credit card gift vouchers","operationId":"debitAggregatedV1","parameters":[{"name":"endYearMonth","in":"query","required":false,"schema":{"type":"string"}},{"name":"monthsCount","in":"query","required":false,"schema":{"type":"integer","format":"int32","maximum":12,"minimum":1}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitAggregatedV1Response"}}}}}}},"/v1/ledger/credit/consult":{"get":{"tags":["Ledger"],"summary":"maximum possible amount that can be credited to the credit card gift voucher","description":"This API returns the maximum possible amount that can be credited to a credit card gift voucher. It provides details on the total amount that can be covered using credit card gift vouchers and the specific gift vouchers to be used for the transaction.","operationId":"creditConsultV1","parameters":[{"name":"gvType","in":"query","required":true,"schema":{"type":"string","enum":["CC_GV"]}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditConsultV1Response"}}}}}}},"/v1/gift-vouchers":{"get":{"tags":["Gift Voucher"],"summary":"Fetch details of gift vouchers with given conditions","description":"This API fetches details of gift vouchers with given conditions. Supports filtering by gvType (G2C_GV, SATOFULL_GV, MERCHANT_GV).","operationId":"getGiftVouchersV1","parameters":[{"name":"configUUID","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"userID","in":"query","required":false,"schema":{"type":"integer"}},{"name":"createdBefore","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"createdAfter","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"balanceType","in":"query","required":false,"schema":{"type":"string","enum":["PREPAID","POINT"]}},{"name":"billingMerchantID","in":"query","required":false,"schema":{"type":"integer"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["ENABLED","DISABLED","EXPIRED"]}},{"name":"updatedBefore","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"updatedAfter","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"gvType","in":"query","required":false,"schema":{"type":"string","enum":["SATOFULL_GV","G2C_GV","CC_GV","MERCHANT_GV"]}},{"name":"identifierOffset","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"dateTimeOffset","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"sortOrder","in":"query","required":true,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}},{"name":"sortBy","in":"query","required":true,"schema":{"type":"string","enum":["CREATION_DATE_TIME","EXPIRATION_DATE_TIME"]}},{"name":"limit","in":"query","required":true,"schema":{"type":"integer","format":"int32","maximum":5000}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[CONFIG_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGiftVouchersV1Response"}}}}}}},"/v1/gift-vouchers/usable":{"get":{"tags":["Gift Voucher"],"summary":"Get details of usable vouchers, which excludes expired and exhausted vouchers.","operationId":"getUsableGiftVouchersV1","parameters":[{"name":"merchantID","in":"query","required":false,"schema":{"type":"integer"}},{"name":"storeID","in":"query","required":false,"schema":{"type":"integer"}},{"name":"identifierOffset","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"dateTimeOffset","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"sortOrder","in":"query","required":true,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}},{"name":"sortBy","in":"query","required":true,"schema":{"type":"string","enum":["CREATION_DATE_TIME","EXPIRATION_DATE_TIME"]}},{"name":"limit","in":"query","required":true,"schema":{"type":"string","format":"byte","maximum":20}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUsableGiftVouchersV1Response"}}}}}}},"/v1/gift-vouchers/usable/balances":{"get":{"tags":["Gift Voucher"],"summary":"Get sum of total usable balance and balance to be expired of all gift vouchers of a user","operationId":"getUsableGiftVouchersBalancesV1","parameters":[{"name":"expiryWithinDays","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUsableGiftVouchersBalancesV1Response"}}}}}}},"/v1/gift-vouchers/usable/balance":{"get":{"tags":["Gift Voucher"],"summary":"Get sum of usable balances of all gift vouchers of a user","operationId":"getUsableGiftVouchersBalanceV1","responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUsableGiftVouchersBalanceV1Response"}}}}}}},"/v1/gift-vouchers/query":{"get":{"tags":["Gift Voucher"],"summary":"Fetch details of gift vouchers for given query","description":"This API fetches details of gift vouchers for given query","operationId":"queryGiftVouchersV1","parameters":[{"name":"state","in":"query","required":true,"schema":{"type":"string","enum":["ALL","AVAILABLE","USED","EXPIRED"]}},{"name":"includeGvTypes","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["SATOFULL_GV","G2C_GV","CC_GV","MERCHANT_GV"]}}},{"name":"excludeGvTypes","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["SATOFULL_GV","G2C_GV","CC_GV","MERCHANT_GV"]}}},{"name":"identifierOffset","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"dateTimeOffset","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"numberOffset","in":"query","required":false,"schema":{"type":"integer"}},{"name":"sortOrder","in":"query","required":true,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}},{"name":"sortBy","in":"query","required":true,"schema":{"type":"string","enum":["CREATION_DATE_TIME","EXPIRATION_DATE_TIME","CURRENT_BALANCE"]}},{"name":"limit","in":"query","required":true,"schema":{"type":"string","format":"byte","maximum":20}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftVouchersQueryV1Response"}}}}}}},"/v1/gift-vouchers/enabled":{"get":{"tags":["Gift Voucher"],"summary":"Get details of enabled vouchers, including recently expired and exhausted","description":"This API return details of enabled vouchers, including recently expired and exhausted","operationId":"getEnabledGiftVouchersV1","parameters":[{"name":"daysAfterExpiry","in":"query","required":true,"schema":{"type":"integer","format":"int32","maximum":182,"minimum":0}},{"name":"identifierOffset","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"dateTimeOffset","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"sortOrder","in":"query","required":true,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}},{"name":"sortBy","in":"query","required":true,"schema":{"type":"string","enum":["CREATION_DATE_TIME","EXPIRATION_DATE_TIME"]}},{"name":"limit","in":"query","required":true,"schema":{"type":"string","format":"byte","maximum":20}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEnabledGiftVouchersV1Response"}}}}}}},"/v1/gift-voucher/disputes":{"get":{"tags":["Gift Voucher"],"summary":"List gift voucher disputes","description":"This API returns list of gift voucher disputes corresponding to an existing gift voucher uuid","operationId":"getGiftVoucherDisputesV1","parameters":[{"name":"giftVoucherUUID","in":"query","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"identifierOffset","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"dateTimeOffset","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"sortOrder","in":"query","required":true,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}},{"name":"sortBy","in":"query","required":true,"schema":{"type":"string","enum":["CREATED_AT"]}},{"name":"limit","in":"query","required":true,"schema":{"type":"string","format":"byte","maximum":20}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"[NON_CC_GV_DISPUTE_NOT_ALLOWED]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[GIFT_VOUCHER_NOT_FOUND, CONFIG_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGiftVoucherDisputesV1Response"}}}}}}},"/v1/gift-voucher/breakdown":{"get":{"tags":["Gift Voucher"],"summary":"Fetch gift voucher breakdown for given referenceUUID","description":"This API fetches details of gift voucher breakdown for given referenceUUID","operationId":"getGiftVoucherBreakdownV1","parameters":[{"name":"referenceUUID","in":"query","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[REFERENCE_UUID_NOT_FOUND, REFERENCE_UUID_AND_USER_ID_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGiftVoucherBreakdownV1Response"}}}}}}},"/v1/configs":{"get":{"tags":["Configuration"],"summary":"Fetch details of configs for a given issuer","description":"This API fetches details of configs for a given issuer","operationId":"getConfigsV1","parameters":[{"name":"issuerName","in":"query","required":false,"schema":{"type":"string"}},{"name":"issuerMerchantID","in":"query","required":false,"schema":{"type":"integer"}},{"name":"balanceType","in":"query","required":false,"schema":{"type":"string","enum":["PREPAID","POINT"]}},{"name":"startsAfter","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"startsBefore","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"expiresAfter","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"expiresBefore","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"identifierOffset","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"dateTimeOffset","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"sortOrder","in":"query","required":true,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}},{"name":"sortBy","in":"query","required":true,"schema":{"type":"string","enum":["START_DATE_TIME","EXPIRATION_DATE_TIME"]}},{"name":"limit","in":"query","required":true,"schema":{"type":"integer","format":"int32","maximum":200}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigsV1Response"}}}}}}},"/internal/v1/gift-voucher/breakdown":{"get":{"tags":["Gift Voucher"],"summary":"Fetch gift voucher breakdown for given referenceUUID and userID","description":"This API fetches details of gift voucher breakdown for given referenceUUID and userUUID","operationId":"getGiftVoucherBreakdownInternalV1","parameters":[{"name":"referenceUUID","in":"query","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"userID","in":"query","required":true,"schema":{"type":"integer"}}],"responses":{"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"[REFERENCE_UUID_AND_USER_ID_NOT_FOUND]","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGiftVoucherBreakdownV1Response"}}}}}}}},"components":{"schemas":{"ErrorResult":{"type":"object","properties":{"code":{"type":"string","description":"Corresponding codeId shares index with this Enum array","enum":["MALFORMED_REQUEST_SYNTAX","UNAUTHORIZED","FORBIDDEN","METHOD_NOT_ALLOWED","UNSUPPORTED_MEDIA_TYPE","IDEMPOTENCE_DUPLICATE_KEY","IDEMPOTENCE_CHECKSUM_MISMATCH","IDEMPOTENCE_MALFORMED_RESULT","CONFIG_STATUS_MISMATCH","CONFIG_EXPIRED","CONFIG_NOT_FOUND","STORE_NOT_FOUND","GIFT_VOUCHER_STATUS_MISMATCH","GIFT_VOUCHER_EXPIRED","GIFT_VOUCHER_CURRENCY_MISMATCH","GIFT_VOUCHER_INSUFFICIENT_BALANCE","GIFT_VOUCHER_NOT_FOUND","LEDGER_INVALID_OPERATION","LEDGER_INSUFFICIENT_BALANCE","LEDGER_NOT_FOUND","CONFIG_NOT_STARTED","CONFIG_TYPE_MISMATCH","GIFT_VOUCHER_NOT_STARTED","CONFIG_DEFAULT_DURATION_EXCEEDED","GV_TYPE_FEATURE_NOT_ENABLED","GIFT_VOUCHER_NOT_EXPIRED","REVERSAL_NOT_POSSIBLE","DEBIT_NOT_POSSIBLE","REFUND_NOT_POSSIBLE","REFERENCE_UUID_NOT_FOUND","NO_VALID_GIFT_VOUCHERS","REFERENCE_UUID_AND_USER_ID_NOT_FOUND","MERCHANT_NOT_FOUND","DUPLICATE_MERCHANT_ID","CONFIGURATION_NOT_ALLOWED","MAX_GV_BALANCE_LIMIT_EXCEEDED","DUPLICATE_ENABLED_CC_GV_CONFIG_FOUND","NON_CC_GV_DISPUTE_NOT_ALLOWED","DISPUTE_GIFT_VOUCHER_INSUFFICIENT_BALANCE","GIFT_VOUCHER_INVALID_PAY_METHOD","PREAUTH_NOT_POSSIBLE","FEATURE_NOT_ENABLED","CAPTURE_NOT_POSSIBLE","PARENT_UUID_NOT_FOUND","INVALID_RE_AUTH_PAYMENT_AMOUNT","ORDER_ID_NOT_FOUND","REAUTH_NOT_POSSIBLE","GIFT_VOUCHER_ACCESS_DENIED","INVALID_AVAILABILITY_DATE","PENDING_SCHEDULED_UPLOAD_ERROR","AVAILABILITY_DATE_EDIT_NOT_ALLOWED","DEFAULT_DURATION_DAYS_UPDATE_NOT_ALLOWED_FOR_CC_GV","NOT_IMPLEMENTED","UNKNOWN"]},"codeId":{"type":"string","description":"Corresponding code shares index with this Enum array","enum":["05100000","05100001","05100002","05100003","05100004","05100005","05100006","05100007","05100008","05100009","05100010","05100011","05100012","05100013","05100014","05100015","05100016","05100017","05100018","05100019","05100023","05100024","05100025","05100026","05100027","05100028","05100029","05100030","05100031","05100032","05100033","05100034","05100035","05100036","05100037","05100038","05100039","05100040","05100041","05100042","05100043","05100044","05100045","05100046","05100047","05100048","05100049","05100050","05100051","05100052","05100053","05100054","05199998","05199999"]},"status":{"type":"string","enum":["F"]},"message":{"type":"string","minLength":1}},"required":["code","codeId","message","status"]},"MerchantStore":{"type":"object","properties":{"merchantID":{"type":"integer"},"storeID":{"type":"integer"}},"required":["merchantID"]},"PutMerchantStoresV1Request":{"type":"object","properties":{"configUUID":{"type":"string","format":"uuid"},"merchantStores":{"type":"array","items":{"$ref":"#/components/schemas/MerchantStore"},"maxItems":1000,"minItems":0,"uniqueItems":true},"availabilityDate":{"type":"string","format":"date"}},"required":["configUUID","merchantStores"]},"PutIssuerMerchantsV1Request":{"type":"object","properties":{"configUUID":{"type":"string","format":"uuid"},"merchantIDs":{"type":"array","items":{"type":"integer"},"maxItems":20,"minItems":0,"uniqueItems":true}},"required":["configUUID","merchantIDs"]},"DebitMoney":{"type":"object","properties":{"currency":{"type":"string","enum":["JPY"]},"cents":{"type":"integer","format":"int64","example":500}},"required":["cents","currency"]},"DebitV3Request":{"type":"object","properties":{"userID":{"type":"integer"},"orderID":{"type":"integer"},"merchantStore":{"$ref":"#/components/schemas/MerchantStore","description":"the debiting merchant store"},"giftVouchersDebitInfo":{"type":"array","items":{"$ref":"#/components/schemas/GiftVoucherDebitInfo"}},"amount":{"$ref":"#/components/schemas/DebitMoney"},"sourceOrderCreatedAt":{"type":"string","format":"date-time"},"serviceType":{"type":"string"}},"required":["merchantStore","orderID","userID"]},"GiftVoucherDebitInfo":{"type":"object","properties":{"giftVoucherUUID":{"type":"string","format":"uuid"},"amount":{"$ref":"#/components/schemas/DebitMoney"}},"required":["amount","giftVoucherUUID"]},"DebitV3Response":{"type":"object","properties":{"processedAt":{"type":"string","format":"date-time"},"ledgerDetails":{"$ref":"#/components/schemas/LedgerDetails"}},"required":["ledgerDetails","processedAt"]},"GiftVoucherLedgerInfo":{"type":"object","properties":{"giftVoucherUUID":{"type":"string","format":"uuid"},"amount":{"type":"integer","format":"int64","example":1000}},"required":["amount","giftVoucherUUID"]},"LedgerDetails":{"type":"object","properties":{"referenceUUID":{"type":"string","format":"uuid"},"parentUUID":{"type":"string","format":"uuid","description":"parent transaction UUID"},"orderID":{"type":"integer","description":"order ID associated with this entry"},"operation":{"type":"string","enum":["CREDIT","DEBIT","REFUND","REVERSAL","DISABLED","EXPIRED","DISPUTE","HOLD","RELEASE","RELEASE_FAILED"]},"giftVouchersLedgerInfo":{"type":"array","items":{"$ref":"#/components/schemas/GiftVoucherLedgerInfo"}}},"required":["giftVouchersLedgerInfo","operation","orderID","parentUUID"]},"DebitReversalV2Request":{"type":"object","properties":{"parentUUID":{"type":"string","format":"uuid","description":"transaction ID we would like to reverse"}},"required":["parentUUID"]},"DebitReversalV2Response":{"type":"object","properties":{"ledgerDetails":{"$ref":"#/components/schemas/LedgerDetails"}},"required":["ledgerDetails"]},"DebitRefundV2Request":{"type":"object","properties":{"parentUUID":{"type":"string","format":"uuid","description":"Generated by the original debit operation"},"amount":{"$ref":"#/components/schemas/DebitMoney"}},"required":["amount","parentUUID"]},"DebitRefundV2Response":{"type":"object","properties":{"processedAt":{"type":"string","format":"date-time"},"ledgerDetails":{"$ref":"#/components/schemas/LedgerDetails"}},"required":["ledgerDetails","processedAt"]},"AddConfigV2Request":{"type":"object","properties":{"status":{"type":"string","enum":["DRAFT","ENABLED","DISABLED"]},"balanceType":{"type":"string","enum":["PREPAID","POINT"]},"gvType":{"type":"string","enum":["SATOFULL_GV","G2C_GV","CC_GV","MERCHANT_GV"]},"validityPeriod":{"$ref":"#/components/schemas/FutureExpiryValidityPeriod"},"defaultInitialBalance":{"$ref":"#/components/schemas/InitialBalanceMoney"},"defaultDurationDays":{"type":"integer","format":"int32","example":182},"displayName":{"type":"string"},"issuer":{"$ref":"#/components/schemas/Issuer"},"billingMerchantID":{"type":"integer"},"marketingURL":{"type":"string","format":"url","example":"https://paypay.ne.jp"},"affiliate":{"$ref":"#/components/schemas/Affiliate"},"description":{"type":"string"},"geographicCoordinate":{"$ref":"#/components/schemas/GeographicCoordinate"},"logoURL":{"type":"string","format":"url","example":"https://paypay.ne.jp/logo.png"},"usageConditions":{"$ref":"#/components/schemas/UsageConditions"},"applicableMerchantsHyperlink":{"$ref":"#/components/schemas/Hyperlink"},"label":{"type":"string"},"refundRate":{"type":"integer","format":"int32","example":20},"maxBalanceCents":{"type":"integer"}},"required":["balanceType","billingMerchantID","displayName","gvType","issuer","status","validityPeriod"]},"Affiliate":{"type":"object","properties":{"name":{"type":"string"},"merchantID":{"type":"integer"}},"required":["merchantID","name"]},"FutureExpiryValidityPeriod":{"type":"object","properties":{"startsAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}},"required":["expiresAt","startsAt"]},"GeographicCoordinate":{"type":"object","properties":{"latitude":{"type":"number","format":"float","maximum":90,"minimum":-90},"longitude":{"type":"number","format":"float","maximum":180,"minimum":-180}}},"Hyperlink":{"type":"object","properties":{"url":{"type":"string","format":"url","example":"https://paypay.ne.jp"},"text":{"type":"string"}},"required":["text","url"]},"InitialBalanceMoney":{"type":"object","properties":{"currency":{"type":"string","enum":["JPY"]},"cents":{"type":"integer","example":10000}},"required":["cents","currency"]},"Issuer":{"type":"object","properties":{"name":{"type":"string"},"fee":{"type":"number","example":12.3456}},"required":["fee","name"]},"UsageConditions":{"type":"object","properties":{"description":{"type":"string"},"hyperlink":{"$ref":"#/components/schemas/Hyperlink"}},"required":["description"]},"AddConfigV2Response":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/Config"}},"required":["config"]},"Config":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["DRAFT","ENABLED","DISABLED"]},"balanceType":{"type":"string","enum":["PREPAID","POINT"]},"gvType":{"type":"string","enum":["SATOFULL_GV","G2C_GV","CC_GV","MERCHANT_GV"]},"validityPeriod":{"$ref":"#/components/schemas/ValidityPeriod"},"defaultInitialBalance":{"$ref":"#/components/schemas/InitialBalanceMoney"},"defaultDurationDays":{"type":"integer","format":"int32","example":182},"displayName":{"type":"string"},"issuer":{"$ref":"#/components/schemas/Issuer"},"createdAt":{"type":"string","format":"date-time"},"billingMerchantID":{"type":"integer"},"affiliate":{"$ref":"#/components/schemas/Affiliate"},"geographicCoordinate":{"$ref":"#/components/schemas/GeographicCoordinate"},"logoURL":{"type":"string","format":"url","example":"https://paypay.ne.jp/logo.png"},"description":{"type":"string"},"usageConditions":{"$ref":"#/components/schemas/UsageConditions"},"applicableMerchantsHyperlink":{"$ref":"#/components/schemas/Hyperlink"},"marketingURL":{"type":"string","format":"url","example":"https://paypay.ne.jp"},"label":{"type":"string"},"refundRate":{"type":"integer","format":"int32","example":20},"maxBalanceCents":{"type":"integer"}},"required":["balanceType","billingMerchantID","createdAt","defaultDurationDays","defaultInitialBalance","displayName","gvType","issuer","status","uuid","validityPeriod"]},"ValidityPeriod":{"type":"object","properties":{"startsAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}},"required":["expiresAt","startsAt"]},"PublishUserGiftVoucherInfoV1Request":{"type":"object","properties":{"giftVoucherUUID":{"type":"string","format":"uuid"}},"required":["giftVoucherUUID"]},"DebitConsultMoney":{"type":"object","properties":{"currency":{"type":"string","enum":["JPY"]},"cents":{"type":"integer","format":"int64","example":500}},"required":["cents","currency"]},"ReAuthRequest":{"type":"object","properties":{"parentUUID":{"type":"string","format":"uuid"},"amount":{"$ref":"#/components/schemas/DebitConsultMoney"},"serviceType":{"type":"string"},"merchantStore":{"$ref":"#/components/schemas/MerchantStore"}},"required":["amount","merchantStore","parentUUID","serviceType"]},"ReAuthResponse":{"type":"object","properties":{"processedAt":{"type":"string","format":"date-time"},"ledgerDetails":{"$ref":"#/components/schemas/LedgerDetails"}},"required":["ledgerDetails","processedAt"]},"PreAuthRequest":{"type":"object","properties":{"orderID":{"type":"integer"},"userID":{"type":"integer"},"merchantStore":{"$ref":"#/components/schemas/MerchantStore"},"serviceType":{"type":"string"},"giftVouchersHoldInfo":{"type":"array","description":"Manual GV selection (mutually exclusive with amount)","items":{"$ref":"#/components/schemas/GiftVoucherDebitInfo"}},"amount":{"$ref":"#/components/schemas/DebitMoney","description":"Auto-selection request amount (mutually exclusive with giftVouchersHoldInfo)"}},"required":["merchantStore","orderID","serviceType","userID"]},"PreAuthResponse":{"type":"object","properties":{"processedAt":{"type":"string","format":"date-time"},"ledgerDetails":{"$ref":"#/components/schemas/LedgerDetails"}},"required":["ledgerDetails","processedAt"]},"PreAuthorizeReversalRequest":{"type":"object","properties":{"parentUUID":{"type":"string","format":"uuid","description":"Parent UUID of the pre-authorization transaction to reverse"}},"required":["parentUUID"]},"GiftVoucherLedgerTransactionInfo":{"type":"object","properties":{"giftVoucherUUID":{"type":"string","format":"uuid","description":"Gift voucher unique identifier"},"amount":{"type":"integer","format":"int64","description":"Amount in ledger cents"},"operation":{"type":"string","description":"Operation performed on the gift voucher","enum":["CREDIT","DEBIT","REFUND","REVERSAL","DISABLED","EXPIRED","DISPUTE","HOLD","RELEASE","RELEASE_FAILED"]},"failureReason":{"type":"string","description":"Reason for failure (if any)"}},"required":["amount","giftVoucherUUID","operation"]},"LedgerTransactionDetails":{"type":"object","properties":{"parentUUID":{"type":"string","format":"uuid","description":"Parent UUID of the original pre-authorization transaction"},"orderID":{"type":"integer","description":"Order ID associated with this entry"},"giftVouchersLedgerInfo":{"type":"array","description":"List of gift voucher operations performed","items":{"$ref":"#/components/schemas/GiftVoucherLedgerTransactionInfo"},"minItems":1}},"required":["giftVouchersLedgerInfo","orderID","parentUUID"]},"PreAuthorizeReversalResponse":{"type":"object","properties":{"processedAt":{"type":"string","format":"date-time","description":"Timestamp when the reversal was processed"},"ledgerDetails":{"$ref":"#/components/schemas/LedgerTransactionDetails","description":"Details of the reversal operation"}},"required":["ledgerDetails","processedAt"]},"CaptureRequest":{"type":"object","properties":{"parentUUID":{"type":"string","format":"uuid","description":"Parent UUID from the pre-authorization request"},"amount":{"$ref":"#/components/schemas/DebitMoney","description":"Capture amount"},"sourceOrderCreatedAt":{"type":"string","format":"date-time","description":"Source order creation timestamp"}},"required":["amount","parentUUID","sourceOrderCreatedAt"]},"CaptureResponse":{"type":"object","properties":{"processedAt":{"type":"string","format":"date-time"},"ledgerDetails":{"$ref":"#/components/schemas/LedgerDetails"}},"required":["ledgerDetails","processedAt"]},"LedgerGiftVoucherBreakdownV1Request":{"type":"object","properties":{"referenceUUID":{"type":"string","format":"uuid","description":"Generated by the original debit/refund operation"}},"required":["referenceUUID"]},"AddGiftVoucherV1Request":{"type":"object","properties":{"configUUID":{"type":"string","format":"uuid"},"userID":{"type":"integer"},"balance":{"type":"integer","description":"If not provided, it will be set to the default value of the config","example":10000},"durationDays":{"type":"integer","format":"int32","description":"Number of days before the gift voucher expires. If it is not provided, it will be set to the default value of the config","example":182},"issuerFee":{"type":"number","description":"Issuer commission fee (%). If it is not provided, it will be set to the default value of the config","example":12.3456},"expiryDate":{"type":"string","format":"date-time","description":"Expiry date of the gift voucher in UTC time zone. If it is not provided, it will be set to the default value of durationDays if or if not provided","example":"2023-10-17T14:17:05.679645+05:30"}},"required":["configUUID","userID"]},"AddGiftVoucherV1Response":{"type":"object","properties":{"giftVoucher":{"$ref":"#/components/schemas/GiftVoucher"}},"required":["giftVoucher"]},"BalanceMoney":{"type":"object","properties":{"currency":{"type":"string","enum":["JPY"]},"initialCents":{"type":"integer","example":10000},"currentCents":{"type":"integer","example":1000}},"required":["currency","currentCents","initialCents"]},"GiftVoucher":{"type":"object","properties":{"giftVoucherUUID":{"type":"string","format":"uuid"},"configUUID":{"type":"string","format":"uuid"},"gvType":{"type":"string","enum":["SATOFULL_GV","G2C_GV","CC_GV","MERCHANT_GV"]},"userID":{"type":"integer"},"status":{"type":"string","enum":["ENABLED","DISABLED","EXPIRED"]},"validityPeriod":{"$ref":"#/components/schemas/ValidityPeriod"},"balance":{"$ref":"#/components/schemas/BalanceMoney"},"displayName":{"type":"string"},"issuerFee":{"type":"number","example":12.3456},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"geographicCoordinate":{"$ref":"#/components/schemas/GeographicCoordinate"},"logoURL":{"type":"string","format":"url","example":"https://paypay.ne.jp/logo.png"},"label":{"type":"string"}},"required":["balance","configUUID","createdAt","displayName","giftVoucherUUID","gvType","issuerFee","status","updatedAt","userID","validityPeriod"]},"UpdateGiftVoucherV1Request":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"expiryDate":{"type":"string","format":"date-time","example":"2023-10-17T14:17:05.679645+05:30"}},"required":["expiryDate","uuid"]},"UpdateGiftVoucherV1Response":{"type":"object","properties":{"giftVoucher":{"$ref":"#/components/schemas/UpdatedGiftVoucher"}},"required":["giftVoucher"]},"UpdatedGiftVoucher":{"type":"object","properties":{"giftVoucherUUID":{"type":"string","format":"uuid"},"configUUID":{"type":"string","format":"uuid"},"userID":{"type":"integer"},"status":{"type":"string","enum":["ENABLED","DISABLED","EXPIRED"]},"validityPeriod":{"$ref":"#/components/schemas/ValidityPeriod"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["configUUID","createdAt","giftVoucherUUID","status","updatedAt","userID","validityPeriod"]},"AddGiftVoucherDisputeV1Request":{"type":"object","properties":{"userID":{"type":"integer"},"giftVoucherUUID":{"type":"string","format":"uuid"},"amount":{"$ref":"#/components/schemas/DisputeMoney"},"description":{"type":"string"},"operationType":{"type":"string","enum":["DISPUTE_FLEXIBLE_AMOUNT","DISPUTE_EXACT_AMOUNT"]}},"required":["amount","description","giftVoucherUUID","operationType","userID"]},"DisputeMoney":{"type":"object","properties":{"currency":{"type":"string","enum":["JPY"]},"cents":{"type":"integer","format":"int64","example":500}},"required":["cents","currency"]},"AddGiftVoucherDisputeV1Response":{"type":"object","properties":{"referenceUUID":{"type":"string","format":"uuid"},"parentUUID":{"type":"string","format":"uuid"},"operation":{"type":"string","enum":["CREDIT","DEBIT","REFUND","REVERSAL","DISABLED","EXPIRED","DISPUTE","HOLD","RELEASE","RELEASE_FAILED"]},"disputeAmount":{"$ref":"#/components/schemas/DisputeMoney"},"giftVoucherInfo":{"$ref":"#/components/schemas/GiftVoucherInfo"},"description":{"type":"string"}}},"CurrentBalanceMoney":{"type":"object","properties":{"currency":{"type":"string","enum":["JPY"]},"cents":{"type":"integer","example":1000}},"required":["cents","currency"]},"GiftVoucherInfo":{"type":"object","properties":{"giftVoucherUUID":{"type":"string","format":"uuid"},"userID":{"type":"integer"},"giftVoucherBalance":{"$ref":"#/components/schemas/CurrentBalanceMoney"}}},"UpdateConfigV1Request":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["DRAFT","ENABLED","DISABLED"]},"validityPeriod":{"$ref":"#/components/schemas/FutureExpiryValidityPeriod"},"displayName":{"type":"string"},"issuerFee":{"type":"number","example":12.3456},"affiliate":{"$ref":"#/components/schemas/Affiliate"},"description":{"type":"string"},"geographicCoordinate":{"$ref":"#/components/schemas/GeographicCoordinate"},"logoURL":{"type":"string","format":"url","example":"https://paypay.ne.jp/logo.png"},"marketingURL":{"type":"string","format":"url","example":"https://paypay.ne.jp"},"usageConditions":{"$ref":"#/components/schemas/UsageConditions"},"applicableMerchantsHyperlink":{"$ref":"#/components/schemas/Hyperlink"},"label":{"type":"string"},"refundRate":{"type":"integer","format":"int32","example":20},"maxBalanceCents":{"type":"integer"},"defaultDurationDays":{"type":"integer","format":"int32","example":182}},"required":["displayName","issuerFee","status","uuid","validityPeriod"]},"DebitRefundConsultV2Response":{"type":"object","properties":{"refundableAmount":{"$ref":"#/components/schemas/DebitConsultMoney"}},"required":["refundableAmount"]},"ApplicableGiftVoucher":{"type":"object","properties":{"giftVoucherUUID":{"type":"string","format":"uuid"},"configUUID":{"type":"string","format":"uuid"},"gvType":{"type":"string","enum":["SATOFULL_GV","G2C_GV","CC_GV","MERCHANT_GV"]},"userID":{"type":"integer"},"status":{"type":"string","enum":["ENABLED","DISABLED","EXPIRED"]},"validityPeriod":{"$ref":"#/components/schemas/ValidityPeriod"},"balance":{"$ref":"#/components/schemas/BalanceMoney"},"displayName":{"type":"string"},"issuerFee":{"type":"number","example":12.3456},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"geographicCoordinate":{"$ref":"#/components/schemas/GeographicCoordinate"},"logoURL":{"type":"string","format":"url","example":"https://paypay.ne.jp/logo.png"},"label":{"type":"string"},"usableAmountForDebit":{"$ref":"#/components/schemas/DebitConsultMoney"},"orderData":{"$ref":"#/components/schemas/OrderData"}},"required":["balance","configUUID","createdAt","displayName","giftVoucherUUID","gvType","issuerFee","status","updatedAt","usableAmountForDebit","userID","validityPeriod"]},"DebitConsultV2Response":{"type":"object","properties":{"amountCovered":{"$ref":"#/components/schemas/DebitConsultMoney"},"applicableGiftVouchers":{"type":"array","items":{"$ref":"#/components/schemas/ApplicableGiftVoucher"}}},"required":["amountCovered","applicableGiftVouchers"]},"OrderData":{"type":"object","properties":{"orderID":{"type":"integer"},"onHoldCents":{"type":"integer","example":1000}},"required":["onHoldCents","orderID"]},"GetUsableGiftVouchersV2Response":{"type":"object","properties":{"paginatedResult":{"$ref":"#/components/schemas/PaginatedGiftVouchersV2"}},"required":["paginatedResult"]},"PaginatedGiftVouchersV2":{"type":"object","properties":{"hasNext":{"type":"boolean"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/GiftVoucher"},"maxItems":2147483646,"minItems":0}},"required":["entities"]},"AggregatedBalancesPaymentTypeDetail":{"type":"object","properties":{"paymentType":{"type":"string","enum":["CC_GV","OTHER_GV"]},"totalUsableBalance":{"$ref":"#/components/schemas/TotalUsableBalance"},"toBeExpiredBalance":{"$ref":"#/components/schemas/TotalExpiringBalance"}},"required":["paymentType","toBeExpiredBalance","totalUsableBalance"]},"ExpiringBalanceMoney":{"type":"object","properties":{"currency":{"type":"string","enum":["JPY"]},"cents":{"type":"integer","example":1000}},"required":["currency"]},"GetUsableGiftVouchersBalancesV2Response":{"type":"object","properties":{"balances":{"type":"array","items":{"$ref":"#/components/schemas/AggregatedBalancesPaymentTypeDetail"}}},"required":["balances"]},"TotalExpiringBalance":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/ExpiringBalanceMoney"},"giftVoucherIDs":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["amount"]},"TotalUsableBalance":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/CurrentBalanceMoney"},"giftVoucherIDs":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["amount"]},"AggregatedBalancePaymentTypeDetail":{"type":"object","properties":{"paymentType":{"type":"string","enum":["CC_GV","OTHER_GV"]},"amount":{"$ref":"#/components/schemas/CurrentBalanceMoney"},"giftVoucherIDs":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["amount","paymentType"]},"GetUsableGiftVouchersBalanceV2Response":{"type":"object","properties":{"balances":{"type":"array","items":{"$ref":"#/components/schemas/AggregatedBalancePaymentTypeDetail"}}},"required":["balances"]},"GetStoresV1Response":{"type":"object","properties":{"paginatedResult":{"$ref":"#/components/schemas/PaginatedStores"}},"required":["paginatedResult"]},"PaginatedStores":{"type":"object","properties":{"hasNext":{"type":"boolean"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/Store"},"maxItems":1000,"minItems":0}},"required":["entities"]},"Store":{"type":"object","properties":{"merchantID":{"type":"integer"},"storeID":{"type":"integer"}},"required":["merchantID","storeID"]},"GetMerchantsV1Response":{"type":"object","properties":{"paginatedResult":{"$ref":"#/components/schemas/PaginatedMerchants"}},"required":["paginatedResult"]},"Merchant":{"type":"object","properties":{"merchantID":{"type":"integer"}},"required":["merchantID"]},"PaginatedMerchants":{"type":"object","properties":{"hasNext":{"type":"boolean"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/Merchant"},"maxItems":1000,"minItems":0}},"required":["entities"]},"GetLedgerEntriesV1Response":{"type":"object","properties":{"ledgerEntry":{"type":"array","items":{"$ref":"#/components/schemas/LedgerEntry"}}},"required":["ledgerEntry"]},"LedgerEntry":{"type":"object","properties":{"parentUUID":{"type":"string","format":"uuid","description":"parent transaction UUID"},"giftVoucherUUID":{"type":"string","format":"uuid"},"orderID":{"type":"integer","description":"order ID associated with this entry"},"operation":{"type":"string","enum":["CREDIT","DEBIT","REFUND","REVERSAL","DISABLED","EXPIRED","DISPUTE","HOLD","RELEASE","RELEASE_FAILED"]},"amount":{"type":"integer","format":"int64"}},"required":["amount","giftVoucherUUID","operation","parentUUID"]},"DebitAggregatedV1Response":{"type":"object","properties":{"monthlyData":{"type":"array","items":{"$ref":"#/components/schemas/MonthlyAggregatedDebitData"}}},"required":["monthlyData"]},"MonthlyAggregatedDebitData":{"type":"object","properties":{"yearMonth":{"type":"string"},"amount":{"$ref":"#/components/schemas/DebitMoney"}}},"ConfigAndOptionalGiftVoucher":{"type":"object","properties":{"giftVoucher":{"$ref":"#/components/schemas/LedgerGiftVoucher"},"config":{"$ref":"#/components/schemas/LedgerConfig"}},"required":["config"]},"CreditConsultV1Response":{"type":"object","properties":{"balanceAmount":{"$ref":"#/components/schemas/CurrentBalanceMoney"},"maxAmount":{"$ref":"#/components/schemas/MaximumMoney"},"giftVoucherConfig":{"$ref":"#/components/schemas/ConfigAndOptionalGiftVoucher"}},"required":["giftVoucherConfig","maxAmount"]},"LedgerConfig":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["DRAFT","ENABLED","DISABLED"]},"balanceType":{"type":"string","enum":["PREPAID","POINT"]},"gvType":{"type":"string","enum":["CC_GV"]},"displayName":{"type":"string"},"issuer":{"$ref":"#/components/schemas/Issuer"},"maxBalanceCents":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"}},"required":["balanceType","createdAt","displayName","gvType","issuer","maxBalanceCents","status","uuid"]},"LedgerGiftVoucher":{"type":"object","properties":{"giftVoucherUUID":{"type":"string","format":"uuid"},"configUUID":{"type":"string","format":"uuid"},"userID":{"type":"integer"},"status":{"type":"string","enum":["ENABLED","DISABLED","EXPIRED"]},"validityPeriod":{"$ref":"#/components/schemas/ValidityPeriod"},"balance":{"$ref":"#/components/schemas/BalanceMoney"},"issuerFee":{"type":"number","example":12.3456},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["balance","configUUID","createdAt","giftVoucherUUID","issuerFee","status","updatedAt","userID","validityPeriod"]},"MaximumMoney":{"type":"object","properties":{"currency":{"type":"string","enum":["JPY"]},"cents":{"type":"integer"}},"required":["cents","currency"]},"GetIssuerMerchantsV1Response":{"type":"object","properties":{"paginatedResult":{"$ref":"#/components/schemas/PaginatedIssuerMerchantIDs"}},"required":["paginatedResult"]},"PaginatedIssuerMerchantIDs":{"type":"object","properties":{"hasNext":{"type":"boolean"},"entities":{"type":"array","items":{"type":"integer"},"maxItems":20,"minItems":0}},"required":["entities"]},"GetGiftVouchersV1Response":{"type":"object","properties":{"paginatedResult":{"$ref":"#/components/schemas/PaginatedInternalGiftVouchers"}},"required":["paginatedResult"]},"PaginatedInternalGiftVouchers":{"type":"object","properties":{"hasNext":{"type":"boolean"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/GiftVoucher"},"maxItems":5000,"minItems":0}},"required":["entities"]},"GetUsableGiftVouchersV1Response":{"type":"object","properties":{"paginatedResult":{"$ref":"#/components/schemas/PaginatedGiftVouchers"}},"required":["paginatedResult"]},"PaginatedGiftVouchers":{"type":"object","properties":{"hasNext":{"type":"boolean"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/GiftVoucher"},"maxItems":20,"minItems":0}},"required":["entities"]},"GetUsableGiftVouchersBalancesV1Response":{"type":"object","properties":{"totalUsableBalance":{"$ref":"#/components/schemas/UsableMoney"},"toBeExpiredBalance":{"$ref":"#/components/schemas/UsableMoney"}},"required":["toBeExpiredBalance","totalUsableBalance"]},"UsableMoney":{"type":"object","properties":{"byCurrency":{"type":"object","additionalProperties":{"type":"integer","example":1000},"example":{"JPY":1000}}},"required":["byCurrency"]},"GetUsableGiftVouchersBalanceV1Response":{"type":"object","properties":{"byCurrency":{"type":"object","additionalProperties":{"type":"integer","example":1000},"example":{"JPY":1000}}},"required":["byCurrency"]},"GiftVouchersQueryV1Response":{"type":"object","properties":{"paginatedResult":{"$ref":"#/components/schemas/PaginatedGiftVouchers"}},"required":["paginatedResult"]},"GetEnabledGiftVouchersV1Response":{"type":"object","properties":{"paginatedResult":{"$ref":"#/components/schemas/PaginatedGiftVouchers"}},"required":["paginatedResult"]},"DetailedGiftVoucher":{"type":"object","properties":{"giftVoucherUUID":{"type":"string","format":"uuid"},"configUUID":{"type":"string","format":"uuid"},"gvType":{"type":"string","enum":["SATOFULL_GV","G2C_GV","CC_GV","MERCHANT_GV"]},"userID":{"type":"integer"},"status":{"type":"string","enum":["ENABLED","DISABLED","EXPIRED"]},"validityPeriod":{"$ref":"#/components/schemas/ValidityPeriod"},"balance":{"$ref":"#/components/schemas/BalanceMoney"},"displayName":{"type":"string"},"issuerFee":{"type":"number","example":12.3456},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"geographicCoordinate":{"$ref":"#/components/schemas/GeographicCoordinate"},"logoURL":{"type":"string","format":"url","example":"https://paypay.ne.jp/logo.png"},"label":{"type":"string"},"description":{"type":"string"},"usageConditions":{"$ref":"#/components/schemas/UsageConditions"},"applicableMerchantsHyperlink":{"$ref":"#/components/schemas/Hyperlink"},"marketingURL":{"type":"string","format":"url","example":"https://paypay.ne.jp"}},"required":["balance","configUUID","createdAt","displayName","giftVoucherUUID","gvType","issuerFee","status","updatedAt","userID","validityPeriod"]},"GetGiftVoucherV1Response":{"type":"object","properties":{"giftVoucher":{"$ref":"#/components/schemas/DetailedGiftVoucher"}},"required":["giftVoucher"]},"GetGiftVoucherDisputesV1Response":{"type":"object","properties":{"paginatedResult":{"$ref":"#/components/schemas/PaginatedDisputes"}},"required":["paginatedResult"]},"GiftVoucherDispute":{"type":"object","properties":{"referenceUUID":{"type":"string","format":"uuid"},"parentUUID":{"type":"string","format":"uuid"},"operation":{"type":"string","enum":["CREDIT","DEBIT","REFUND","REVERSAL","DISABLED","EXPIRED","DISPUTE","HOLD","RELEASE","RELEASE_FAILED"]},"disputeAmount":{"$ref":"#/components/schemas/DisputeMoney"},"giftVoucherInfo":{"$ref":"#/components/schemas/GiftVoucherInfo"},"description":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"PaginatedDisputes":{"type":"object","properties":{"hasNext":{"type":"boolean"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/GiftVoucherDispute"},"maxItems":20,"minItems":0}},"required":["entities"]},"GetGiftVoucherBreakdownV1Response":{"type":"object","properties":{"breakdownDetails":{"type":"array","items":{"$ref":"#/components/schemas/GiftVoucherBreakdown"}}},"required":["breakdownDetails"]},"GiftVoucherBreakdown":{"type":"object","properties":{"giftVoucherUUID":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"amount":{"$ref":"#/components/schemas/DebitMoney"},"expiresAt":{"type":"string","format":"date-time"},"gvType":{"type":"string","enum":["SATOFULL_GV","G2C_GV","CC_GV","MERCHANT_GV"]}},"required":["amount","displayName","giftVoucherUUID","gvType"]},"GetConfigsV1Response":{"type":"object","properties":{"paginatedResult":{"$ref":"#/components/schemas/PaginatedConfigs"}},"required":["paginatedResult"]},"PaginatedConfigs":{"type":"object","properties":{"hasNext":{"type":"boolean"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/Config"},"maxItems":200,"minItems":0}},"required":["entities"]},"GetConfigV1Response":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/Config"}},"required":["config"]},"DeleteMerchantStoresV1Request":{"type":"object","properties":{"configUUID":{"type":"string","format":"uuid"},"merchantStores":{"type":"array","items":{"$ref":"#/components/schemas/MerchantStore"},"maxItems":1000,"minItems":0,"uniqueItems":true},"recordType":{"type":"string","enum":["LIVE","SCHEDULED","ALL"]}},"required":["configUUID","merchantStores"]},"DeleteIssuerMerchantsV1Request":{"type":"object","properties":{"configUUID":{"type":"string","format":"uuid"},"merchantIDs":{"type":"array","items":{"type":"integer"},"maxItems":20,"minItems":0,"uniqueItems":true}},"required":["configUUID","merchantIDs"]}},"securitySchemes":{"Bearer Authentication":{"type":"http","name":"Bearer Authentication","scheme":"bearer","bearerFormat":"JWT"}}}}