Skip to content

Instantly share code, notes, and snippets.

@Chubby-Chocobo

Chubby-Chocobo/test

Last active April 20, 2020 23:57
Show Gist options
  • Save Chubby-Chocobo/0eb086946dba346e7e2f19247f10e2df to your computer and use it in GitHub Desktop.
Save Chubby-Chocobo/0eb086946dba346e7e2f19247f10e2df to your computer and use it in GitHub Desktop.
Download ZIP
Raw
test
{
"openapi": "3.0.0",
"info": {
"title": "Wallets API",
"description": "Swagger specification for API Wallets | [swagger.json](/docs/wallets-json)",
"version": "1.0.0",
"contact": {}
},
"tags": [
{
"name": "health",
"description": ""
},
{
"name": "storecard",
"description": ""
},
{
"name": "ccgateway",
"description": ""
},
{
"name": "wallets",
"description": ""
},
{
"name": "transactions",
"description": ""
},
{
"name": "webhooks",
"description": ""
},
{
"name": "keys",
"description": ""
},
{
"name": "levels",
"description": ""
}
],
"servers": [
{
"url": "https://api.dev2.setel.my/api/wallets",
"description": "Local"
}
],
"components": {
"securitySchemes": {
"bearer": {
"type": "apiKey",
"name": "access-token",
"in": "header"
}
},
"schemas": {
"ErrorResponse": {
"type": "object",
"properties": {
"errorCode": {
"type": "number",
"description": "Error code"
},
"statusCode": {
"type": "number",
"description": "HTTP status code"
},
"message": {
"type": "string",
"description": "Human friendly description of the error"
},
"errors": {
"description": "Collection of nested error messages",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"statusCode",
"message"
]
},
"WalletBalanceOutput": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"CASH",
"BONUS"
]
},
"currency": {
"type": "string",
"enum": [
"MYR",
"USD",
"AUD",
"CAD",
"EUR",
"GBP",
"HKD",
"SGD",
"THB"
]
},
"balance": {
"type": "number"
},
"limit": {
"type": "number"
}
}
},
"WalletOutput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"userId": {
"type": "string"
},
"token": {
"type": "string"
},
"email": {
"type": "string"
},
"mobile": {
"type": "string"
},
"fullname": {
"type": "string"
},
"gender": {
"type": "string"
},
"birthdate": {
"type": "string",
"format": "date-time"
},
"balances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WalletBalanceOutput"
}
}
},
"required": [
"id",
"userId",
"token",
"email",
"mobile",
"fullname"
]
},
"CreateWalletInput": {
"type": "object",
"properties": {
"fullname": {
"type": "string",
"minLength": 3,
"maxLength": 64,
"example": "John Doe"
},
"gender": {
"type": "string",
"enum": [
"male",
"female"
],
"example": "male"
},
"birthdate": {
"type": "string",
"example": "1970-01-01"
},
"mobile": {
"type": "string",
"example": "60123456789"
},
"email": {
"type": "string",
"example": "john.doe@abc.xyz"
},
"pin": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"example": "123456"
}
},
"required": [
"fullname",
"mobile",
"email",
"pin"
]
},
"TransactionOutput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"transactionUid": {
"type": "string"
},
"walletId": {
"type": "string"
},
"userId": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"TOPUP",
"CHARGE",
"REFUND",
"PAYOUT",
"TOPUP_REFUND",
"ADJUSTMENT",
"TRANSFER",
"WITHDRAWAL",
"DISPUTE"
]
},
"subType": {
"type": "string",
"enum": [
"TOPUP_BANK_ACCOUNT",
"TOPUP_CREDIT_CARD",
"CHARGE_WALLET",
"REFUND_WALLET",
"TOPUP_REFUND_BANK_ACCOUNT",
"TOPUP_REFUND_CREDIT_CARD",
"TRANSFER_MERCHANT_BONUS_WALLET",
"TRANSFER_REFUND_MERCHANT_BONUS_WALLET",
"ADJUSTMENT_TOP_UP",
"ADJUSTMENT_CHARGE",
"ADJUSTMENT_MDR_CHARGE",
"ADJUSTMENT_PREFUND",
"ADJUSTMENT_MIGRATE_BALANCE",
"ADJUSTMENT_OTHER"
]
},
"status": {
"type": "string",
"enum": [
"CREATED",
"PROCESSING",
"AUTHORISED",
"SUCCEEDED",
"FAILED",
"CANCELLED",
"EXPIRED",
"PARTIALLY_REFUNDED",
"REFUNDED"
]
},
"amount": {
"type": "number"
},
"currency": {
"type": "string",
"enum": [
"MYR",
"USD",
"AUD",
"CAD",
"EUR",
"GBP",
"HKD",
"SGD",
"THB"
]
},
"refundedTransactionUid": {
"type": "string"
},
"referenceId": {
"type": "string"
},
"tokenId": {
"type": "string"
},
"merchantId": {
"type": "string"
},
"paymentGatewayVendor": {
"type": "string",
"enum": [
"IPAY88"
]
},
"paymentGatewayTransactionId": {
"type": "string"
},
"errorDescription": {
"type": "string"
},
"fullName": {
"type": "string"
},
"email": {
"type": "string"
},
"attributes": {
"type": "object"
},
"transactionDate": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"transactionUid",
"walletId",
"userId",
"type",
"subType",
"status",
"amount",
"currency",
"attributes",
"transactionDate"
]
},
"CreateAdjustmentTransactionInput": {
"type": "object",
"properties": {
"walletToken": {
"type": "string"
},
"amount": {
"type": "number"
},
"currency": {
"type": "string",
"enum": [
"MYR",
"USD",
"AUD",
"CAD",
"EUR",
"GBP",
"HKD",
"SGD",
"THB"
]
},
"subType": {
"type": "string"
},
"comment": {
"type": "string"
}
},
"required": [
"walletToken",
"amount",
"currency"
]
},
"CreateAdjustmentTransactionByCustomerIdInput": {
"type": "object",
"properties": {
"customerId": {
"type": "string"
},
"amount": {
"type": "number"
},
"currency": {
"type": "string",
"enum": [
"MYR",
"USD",
"AUD",
"CAD",
"EUR",
"GBP",
"HKD",
"SGD",
"THB"
]
},
"subType": {
"type": "string"
},
"comment": {
"type": "string"
}
},
"required": [
"customerId",
"amount",
"currency"
]
},
"UpdateAdjustmentTransactionInput": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"description": "Comment for this transaction"
}
}
},
"CreateTopUpTransactionInput": {
"type": "object",
"properties": {
"subType": {
"type": "string",
"enum": [
"TOPUP_BANK_ACCOUNT",
"TOPUP_CREDIT_CARD"
]
},
"walletId": {
"type": "string"
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"referenceId": {
"type": "string"
}
},
"required": [
"subType",
"walletId",
"amount",
"currency"
]
},
"UpdateTopUpTransactionInput": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"CREATED",
"PROCESSING",
"AUTHORISED",
"SUCCEEDED",
"FAILED",
"CANCELLED",
"EXPIRED",
"PARTIALLY_REFUNDED",
"REFUNDED"
]
},
"errorDescription": {
"type": "string"
},
"referenceId": {
"type": "string"
}
},
"required": [
"status"
]
},
"CreateChargeTransactionInput": {
"type": "object",
"properties": {
"walletId": {
"type": "string"
},
"merchantId": {
"type": "string"
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"referenceId": {
"type": "string"
}
},
"required": [
"walletId",
"merchantId",
"amount",
"currency"
]
},
"UpdateChargeTransactionInput": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"CREATED",
"PROCESSING",
"AUTHORISED",
"SUCCEEDED",
"FAILED",
"CANCELLED",
"EXPIRED",
"PARTIALLY_REFUNDED",
"REFUNDED"
]
},
"referenceId": {
"type": "string"
}
},
"required": [
"status"
]
},
"CreditCardPaymentResponse": {
"type": "object",
"properties": {
"MerchantCode": {
"type": "string"
},
"PaymentId": {
"type": "string"
},
"RefNo": {
"type": "string"
},
"Amount": {
"type": "string"
},
"Currency": {
"type": "string"
},
"Remark": {
"type": "string"
},
"TransId": {
"type": "string"
},
"AuthCode": {
"type": "string"
},
"Status": {
"type": "string"
},
"ErrDesc": {
"type": "string"
},
"Signature": {
"type": "string"
},
"BankMID": {
"type": "string"
},
"CCName": {
"type": "string"
},
"CCNo": {
"type": "string"
},
"S_bankname": {
"type": "string"
},
"S_country": {
"type": "string"
},
"ActionType": {
"type": "string"
},
"TokenId": {
"type": "string"
},
"BindCardErrDesc": {
"type": "string"
},
"Xfield1": {
"type": "string"
},
"Xfield2": {
"type": "string"
}
},
"required": [
"MerchantCode",
"PaymentId",
"RefNo",
"Amount",
"Currency",
"Status",
"ActionType"
]
},
"BankPaymentResponse": {
"type": "object",
"properties": {
"MerchantCode": {
"type": "string"
},
"PaymentId": {
"type": "string"
},
"RefNo": {
"type": "string"
},
"Amount": {
"type": "string"
},
"Currency": {
"type": "string"
},
"Remark": {
"type": "string"
},
"TransId": {
"type": "string"
},
"AuthCode": {
"type": "string"
},
"Status": {
"type": "string"
},
"ErrDesc": {
"type": "string"
},
"Signature": {
"type": "string"
},
"CCName": {
"type": "string"
},
"CCNo": {
"type": "string"
},
"S_bankname": {
"type": "string"
},
"S_country": {
"type": "string"
},
"Xfield1": {
"type": "string"
}
},
"required": [
"MerchantCode",
"PaymentId",
"RefNo",
"Amount",
"Currency",
"Status"
]
},
"GetMigrateKipleBalanceAdjustmentTransactionInput": {
"type": "object",
"properties": {
"walletToken": {
"type": "string"
}
},
"required": [
"walletToken"
]
},
"CreateLevelConfigInput": {
"type": "object",
"properties": {
"level": {
"type": "string",
"enum": [
"BASIC",
"KYCED"
],
"example": "BASIC"
},
"type": {
"type": "string",
"enum": [
"CASH",
"BONUS"
],
"example": "CASH"
},
"currency": {
"type": "string",
"enum": [
"MYR",
"USD",
"AUD",
"CAD",
"EUR",
"GBP",
"HKD",
"SGD",
"THB"
],
"example": "MYR"
},
"balanceLimit": {
"type": "number",
"minimum": 0
},
"accumulativeDailyTransactionLimit": {
"type": "number",
"minimum": 0
},
"singleTransactionLimit": {
"type": "number",
"minimum": 0
},
"maxAllowedPurchasePerDay": {
"type": "number",
"minimum": 1
}
},
"required": [
"level",
"type",
"currency",
"balanceLimit",
"accumulativeDailyTransactionLimit",
"singleTransactionLimit",
"maxAllowedPurchasePerDay"
]
},
"LevelConfigOutput": {
"type": "object",
"properties": {
"level": {
"type": "string",
"enum": [
"BASIC",
"KYCED"
]
},
"type": {
"type": "string",
"enum": [
"CASH",
"BONUS"
]
},
"currency": {
"type": "string",
"enum": [
"MYR",
"USD",
"AUD",
"CAD",
"EUR",
"GBP",
"HKD",
"SGD",
"THB"
]
},
"balanceLimit": {
"type": "number"
},
"accumulativeDailyTransactionLimit": {
"type": "number"
},
"singleTransactionLimit": {
"type": "number"
},
"maxAllowedPurchasePerDay": {
"type": "number"
}
},
"required": [
"level",
"type",
"currency",
"balanceLimit",
"accumulativeDailyTransactionLimit",
"singleTransactionLimit",
"maxAllowedPurchasePerDay"
]
},
"StorecardErrorStatus": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"description"
]
},
"StorecardErrorResponse": {
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/StorecardErrorStatus"
}
},
"required": [
"status"
]
},
"CheckUserExistsOutput": {
"type": "object",
"properties": {
"email": {
"type": "boolean"
},
"mobile": {
"type": "boolean"
},
"has_wallet": {
"type": "boolean"
},
"create_wallet_token": {
"type": "string",
"nullable": true
}
},
"required": [
"email",
"mobile",
"has_wallet",
"create_wallet_token"
]
},
"CheckUserOutput": {
"type": "object",
"properties": {
"exists": {
"$ref": "#/components/schemas/CheckUserExistsOutput"
}
},
"required": [
"exists"
]
},
"UserDetailsInput": {
"type": "object",
"properties": {
"fullname": {
"type": "string",
"minLength": 3,
"maxLength": 64,
"example": "John Doe"
},
"gender": {
"type": "string",
"enum": [
"male",
"female"
],
"example": "male"
},
"birthdate": {
"type": "string",
"example": "1970-01-01"
},
"mobile": {
"type": "string",
"example": "60123456789"
},
"email": {
"type": "string",
"example": "john.doe@abc.xyz"
},
"pin": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"example": "123456"
},
"longitude": {
"type": "string",
"example": "30.123456"
},
"latitude": {
"type": "string",
"example": "30.123456"
}
},
"required": [
"fullname",
"mobile",
"email",
"pin"
]
},
"CreateUserInput": {
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/UserDetailsInput"
}
},
"required": [
"user"
]
},
"UserDetailsOutput": {
"type": "object",
"properties": {
"fullname": {
"type": "string"
},
"gender": {
"type": "string"
},
"birthdate": {
"type": "string"
},
"mobile": {
"type": "string"
},
"email": {
"type": "string"
},
"mobile_confirmed": {
"type": "boolean"
},
"pin_protected": {
"type": "boolean"
},
"token": {
"type": "string"
},
"token_expiry": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"required": [
"fullname",
"mobile",
"email",
"mobile_confirmed",
"pin_protected",
"token",
"token_expiry"
]
},
"UserOutput": {
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/UserDetailsOutput"
}
},
"required": [
"user"
]
},
"RefreshTokenInput": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"mobile": {
"type": "string",
"example": "60123456789"
},
"email": {
"type": "string",
"example": "john.doe@abc.xyz"
}
},
"required": [
"token",
"mobile",
"email"
]
},
"UpdateUserDetailsInput": {
"type": "object",
"properties": {
"fullname": {
"type": "string",
"minLength": 3,
"maxLength": 64,
"example": "John Doe"
},
"gender": {
"type": "string",
"enum": [
"male",
"female"
],
"example": "male"
},
"birthdate": {
"type": "string",
"example": "1970-01-01"
},
"mobile": {
"type": "string",
"example": "60123456789"
},
"email": {
"type": "string",
"example": "john.doe@abc.xyz"
},
"longitude": {
"type": "string",
"example": "30.123456"
},
"latitude": {
"type": "string",
"example": "30.123456"
}
},
"required": [
"fullname",
"mobile",
"email"
]
},
"UpdateUserInput": {
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/UpdateUserDetailsInput"
}
},
"required": [
"user"
]
},
"StorecardOutput": {
"type": "object",
"properties": {
"balance": {
"type": "number"
},
"expiry_date": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"required": [
"balance",
"expiry_date"
]
},
"UserStorecardOutput": {
"type": "object",
"properties": {
"storecard": {
"$ref": "#/components/schemas/StorecardOutput"
},
"token_expiry": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"required": [
"storecard",
"token_expiry"
]
},
"UserPinDetailsInput": {
"type": "object",
"properties": {
"pin": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"example": "123456"
},
"new_pin": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"example": "123456"
}
},
"required": [
"pin",
"new_pin"
]
},
"ChangeUserPinInput": {
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/UserPinDetailsInput"
}
},
"required": [
"user"
]
},
"ChangeUserPinOutput": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
}
},
"required": [
"success"
]
},
"ResetUserPinOutput": {
"type": "object",
"properties": {
"pin": {
"type": "string"
}
},
"required": [
"pin"
]
},
"CreateTopUpBankAccountInput": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1
},
"pin": {
"type": "string",
"example": "123456"
},
"webhook_url": {
"type": "string"
},
"reference_id": {
"type": "string"
},
"longitude": {
"type": "string",
"example": "30.123456"
},
"latitude": {
"type": "string",
"example": "30.123456"
}
},
"required": [
"amount"
]
},
"TopUpBankAccountRedirectRequest": {
"type": "object",
"properties": {
"redirect_url": {
"type": "string"
},
"return_url": {
"type": "string"
},
"params": {
"type": "object"
}
},
"required": [
"redirect_url",
"return_url",
"params"
]
},
"CreateTopUpBankAccountOutput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"redirect_request": {
"$ref": "#/components/schemas/TopUpBankAccountRedirectRequest"
},
"auto_topup_redirect": {
"type": "string"
}
},
"required": [
"id",
"redirect_request",
"auto_topup_redirect"
]
},
"AmountOutput": {
"type": "object",
"properties": {
"total": {
"type": "number"
}
},
"required": [
"total"
]
},
"TopUpBankAccountTransactionDetailsOutput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"amount": {
"$ref": "#/components/schemas/AmountOutput"
}
},
"required": [
"id",
"created_at",
"amount"
]
},
"TopUpBankAccountTransactionOutput": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"PENDING",
"APPROVED",
"FAILED",
"CANCELLED"
]
},
"topup": {
"$ref": "#/components/schemas/TopUpBankAccountTransactionDetailsOutput"
},
"storecard": {
"$ref": "#/components/schemas/StorecardOutput"
},
"raw_error_description": {
"type": "string"
}
},
"required": [
"state",
"topup",
"storecard",
"raw_error_description"
]
},
"UserPinInput": {
"type": "object",
"properties": {
"pin": {
"type": "string",
"example": "123456"
}
},
"required": [
"pin"
]
},
"AmountInput": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 1
}
},
"required": [
"total"
]
},
"PaymentTransactionInput": {
"type": "object",
"properties": {
"merchant_id": {
"type": "string"
},
"reference_id": {
"type": "string"
},
"amount": {
"$ref": "#/components/schemas/AmountInput"
}
},
"required": [
"merchant_id",
"amount"
]
},
"MakePaymentInput": {
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/UserPinInput"
},
"transaction": {
"$ref": "#/components/schemas/PaymentTransactionInput"
},
"webhook_url": {
"type": "string"
},
"longitude": {
"type": "string",
"example": "30.123456"
},
"latitude": {
"type": "string",
"example": "30.123456"
}
},
"required": [
"transaction"
]
},
"PaymentTransactionOutput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"reference_id": {
"type": "string"
},
"amount": {
"$ref": "#/components/schemas/AmountOutput"
}
},
"required": [
"id",
"created_at",
"reference_id",
"amount"
]
},
"MakePaymentOutput": {
"type": "object",
"properties": {
"transaction": {
"$ref": "#/components/schemas/PaymentTransactionOutput"
},
"storecard": {
"$ref": "#/components/schemas/StorecardOutput"
}
},
"required": [
"transaction",
"storecard"
]
},
"AuthorisePaymentInput": {
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/UserPinInput"
},
"transaction": {
"$ref": "#/components/schemas/PaymentTransactionInput"
},
"longitude": {
"type": "string",
"example": "30.123456"
},
"latitude": {
"type": "string",
"example": "30.123456"
}
},
"required": [
"transaction"
]
},
"AuthorisePaymentOutput": {
"type": "object",
"properties": {
"transaction": {
"$ref": "#/components/schemas/PaymentTransactionOutput"
},
"storecard": {
"$ref": "#/components/schemas/StorecardOutput"
}
},
"required": [
"transaction",
"storecard"
]
},
"CapturePaymentTransactionInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"reference_id": {
"type": "string"
},
"amount": {
"$ref": "#/components/schemas/AmountInput"
}
},
"required": [
"id",
"amount"
]
},
"CapturePaymentInput": {
"type": "object",
"properties": {
"transaction": {
"$ref": "#/components/schemas/CapturePaymentTransactionInput"
},
"webhook_url": {
"type": "string"
},
"longitude": {
"type": "string",
"example": "30.123456"
},
"latitude": {
"type": "string",
"example": "30.123456"
}
},
"required": [
"transaction"
]
},
"CapturePaymentOutput": {
"type": "object",
"properties": {
"transaction": {
"$ref": "#/components/schemas/PaymentTransactionOutput"
},
"storecard": {
"$ref": "#/components/schemas/StorecardOutput"
}
},
"required": [
"transaction",
"storecard"
]
},
"CancelPaymentTransactionInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"reference_id": {
"type": "string"
},
"longitude": {
"type": "string",
"example": "30.123456"
},
"latitude": {
"type": "string",
"example": "30.123456"
}
},
"required": [
"id"
]
},
"CancelPaymentInput": {
"type": "object",
"properties": {
"transaction": {
"$ref": "#/components/schemas/CancelPaymentTransactionInput"
}
},
"required": [
"transaction"
]
},
"CancelPaymentOutput": {
"type": "object",
"properties": {
"transaction": {
"$ref": "#/components/schemas/PaymentTransactionOutput"
},
"storecard": {
"$ref": "#/components/schemas/StorecardOutput"
}
},
"required": [
"transaction",
"storecard"
]
},
"RefundPaymentTransactionInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"reference_id": {
"type": "string"
},
"amount": {
"$ref": "#/components/schemas/AmountInput"
}
},
"required": [
"id",
"amount"
]
},
"RefundPaymentInput": {
"type": "object",
"properties": {
"transaction": {
"$ref": "#/components/schemas/RefundPaymentTransactionInput"
}
},
"required": [
"transaction"
]
},
"RefundPaymentOutput": {
"type": "object",
"properties": {
"transaction": {
"$ref": "#/components/schemas/PaymentTransactionOutput"
},
"storecard": {
"$ref": "#/components/schemas/StorecardOutput"
}
},
"required": [
"transaction",
"storecard"
]
},
"AuthorisedPaymentTransactionOutput": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"Pending",
"Committed",
"Cancelled",
"Timeout"
]
},
"transaction": {
"$ref": "#/components/schemas/PaymentTransactionOutput"
}
},
"required": [
"status",
"transaction"
]
},
"AuthorisedBalanceOutput": {
"type": "object",
"properties": {
"storecard": {
"$ref": "#/components/schemas/StorecardOutput"
},
"authorised_balance": {
"type": "number"
}
},
"required": [
"storecard",
"authorised_balance"
]
},
"GetTransactionHistoryItemOutput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"reference_id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"TopupFPX",
"Payment",
"HoldPayment",
"CommitHold",
"CancelHold",
"TimeoutHold",
"TransactionVoid",
"TopupByCreditCard",
"PaymentByCreditCard",
"StoreCardExpired",
"StoreCardBonus"
]
},
"amount": {
"type": "number"
}
},
"required": [
"id",
"created_at",
"reference_id",
"type",
"amount"
]
},
"GetTransactionHistoryOutput": {
"type": "object",
"properties": {
"transaction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetTransactionHistoryItemOutput"
}
}
},
"required": [
"transaction"
]
},
"BonusStorecardTransactionInput": {
"type": "object",
"properties": {
"reference_id": {
"type": "string"
},
"amount": {
"$ref": "#/components/schemas/AmountInput"
}
},
"required": [
"amount"
]
},
"BonusStorecardInput": {
"type": "object",
"properties": {
"transaction": {
"$ref": "#/components/schemas/BonusStorecardTransactionInput"
}
},
"required": [
"transaction"
]
},
"BonusStorecardOutput": {
"type": "object",
"properties": {
"transaction": {
"$ref": "#/components/schemas/PaymentTransactionOutput"
},
"storecard": {
"$ref": "#/components/schemas/StorecardOutput"
}
},
"required": [
"transaction",
"storecard"
]
},
"RefundBonusStorecardInput": {
"type": "object",
"properties": {
"reference_id": {
"type": "string"
},
"transaction_id": {
"type": "string"
}
},
"required": [
"transaction_id"
]
},
"RefundBonusStorecardOutput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"reference_id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"amount": {
"$ref": "#/components/schemas/AmountOutput"
}
},
"required": [
"id",
"created_at",
"amount"
]
},
"GetPrefundAmountOutput": {
"type": "object",
"properties": {
"amount": {
"$ref": "#/components/schemas/AmountOutput"
}
},
"required": [
"amount"
]
},
"GetPrefundHistoryItemStorecardOutput": {
"type": "object",
"properties": {
"balance": {
"type": "number"
},
"expiry_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"bonus_granted": {
"type": "number"
}
},
"required": [
"balance",
"expiry_date",
"bonus_granted"
]
},
"GetPrefundHistoryItemBeneficiaryOutput": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"mobile": {
"type": "string"
},
"storecard": {
"$ref": "#/components/schemas/GetPrefundHistoryItemStorecardOutput"
}
},
"required": [
"email",
"mobile",
"storecard"
]
},
"GetPrefundHistoryItemOutput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"amount": {
"type": "number"
},
"description": {
"type": "string"
},
"reference_id": {
"type": "string"
},
"beneficiary": {
"$ref": "#/components/schemas/GetPrefundHistoryItemBeneficiaryOutput"
}
},
"required": [
"id",
"created_at",
"amount",
"description"
]
},
"GetPrefundHistoryOutput": {
"type": "object",
"properties": {
"transactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetPrefundHistoryItemOutput"
}
}
},
"required": [
"transactions"
]
},
"CCGatewayErrorResponse": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"success",
"code",
"data"
]
},
"DeleteTokenInput": {
"type": "object",
"properties": {
"mid_pan": {
"type": "string"
}
},
"required": [
"mid_pan"
]
},
"DeleteTokenDataOutput": {
"type": "object",
"properties": {
"deleted_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"deleted_at"
]
},
"DeleteTokenOutput": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/DeleteTokenDataOutput"
}
},
"required": [
"success",
"code",
"data"
]
},
"CardOutput": {
"type": "object",
"properties": {
"issuer_country": {
"type": "string"
},
"issuer_bank": {
"type": "string"
},
"scheme": {
"type": "string"
},
"brand": {
"type": "string"
},
"number": {
"type": "string"
},
"holder_name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"issuer_country",
"issuer_bank",
"scheme",
"brand",
"number",
"holder_name",
"type"
]
},
"CreditCardData": {
"type": "object",
"properties": {
"card": {
"$ref": "#/components/schemas/CardOutput"
}
},
"required": [
"card"
]
},
"CreditCardInformationOutput": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/CreditCardData"
}
},
"required": [
"success",
"code",
"data"
]
},
"TopUpCreditCardTransactionInput": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency": {
"type": "string",
"enum": [
"MYR",
"USD",
"AUD",
"CAD",
"EUR",
"GBP",
"HKD",
"SGD",
"THB"
]
}
},
"required": [
"amount",
"currency"
]
},
"TopUpCreditCardShopperInput": {
"type": "object",
"properties": {
"full_name": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"example": "John Doe"
},
"email": {
"type": "string",
"example": "john.doe@abc.xyz"
},
"telephone_number": {
"type": "string",
"example": "60123456789"
},
"ip_address": {
"type": "string",
"example": "1.1.1.1"
},
"latitude": {
"type": "string",
"example": "30.123456"
},
"longitude": {
"type": "string",
"example": "30.123456"
}
},
"required": [
"latitude",
"longitude"
]
},
"TopUpCreditCardWalletInput": {
"type": "object",
"properties": {
"access_token": {
"type": "string"
},
"topup": {
"type": "boolean",
"example": true
}
},
"required": [
"access_token",
"topup"
]
},
"TopUpCreditCardWebhookInput": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
},
"CreateTopUpCreditCardInput": {
"type": "object",
"properties": {
"transaction": {
"$ref": "#/components/schemas/TopUpCreditCardTransactionInput"
},
"shopper": {
"$ref": "#/components/schemas/TopUpCreditCardShopperInput"
},
"wallet": {
"$ref": "#/components/schemas/TopUpCreditCardWalletInput"
},
"webhook": {
"$ref": "#/components/schemas/TopUpCreditCardWebhookInput"
},
"submerchant_id": {
"type": "number"
}
},
"required": [
"transaction",
"wallet"
]
},
"CreateTopUpCreditCardDataOutput": {
"type": "object",
"properties": {
"created": {
"type": "string",
"format": "date-time"
},
"reference_id": {
"type": "string"
}
},
"required": [
"created",
"reference_id"
]
},
"CreateTopUpCreditCardOutput": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/CreateTopUpCreditCardDataOutput"
}
},
"required": [
"success",
"code",
"data"
]
},
"TopUpCreditCardTransactionDataOutput": {
"type": "object",
"properties": {
"created": {
"type": "string",
"format": "date-time"
},
"reference_id": {
"type": "string"
},
"error_code": {
"type": "number"
},
"topup": {
"type": "boolean"
},
"kiple_transaction_id": {
"type": "string"
}
},
"required": [
"created",
"reference_id",
"error_code",
"topup",
"kiple_transaction_id"
]
},
"TopUpCreditCardTransactionOutput": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/TopUpCreditCardTransactionDataOutput"
}
},
"required": [
"success",
"code",
"data"
]
},
"CreateKeyInput": {
"type": "object",
"properties": {
"merchantId": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"STORECARD",
"CCGATEWAY"
]
},
"key": {
"type": "string"
},
"secret": {
"type": "string"
}
},
"required": [
"merchantId",
"type",
"key"
]
},
"CreateKeyOutput": {
"type": "object",
"properties": {
"merchantId": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"STORECARD",
"CCGATEWAY"
]
},
"key": {
"type": "string"
},
"secret": {
"type": "string"
}
},
"required": [
"merchantId",
"type",
"key"
]
},
"KeyOutput": {
"type": "object",
"properties": {
"merchantId": {
"type": "string"
},
"type": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"merchantId",
"type",
"key"
]
}
}
},
"paths": {
"/wallets": {
"get": {
"operationId": "indexWallets",
"summary": "Index Wallets",
"parameters": [
{
"name": "userId",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "email",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "mobile",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "perPage",
"required": false,
"in": "query",
"description": "Items per page",
"schema": {
"type": "number"
}
},
{
"name": "page",
"required": false,
"in": "query",
"description": "Page number",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WalletOutput"
}
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"wallets"
],
"security": [
{
"bearer": []
}
]
},
"post": {
"operationId": "createWallet",
"summary": "Create Wallet",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWalletInput"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WalletOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"wallets"
],
"security": [
{
"bearer": []
}
]
}
},
"/wallets/{id}": {
"get": {
"operationId": "readWallet",
"summary": "Read Wallet",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WalletOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"wallets"
],
"security": [
{
"bearer": []
}
]
}
},
"/transactions": {
"get": {
"operationId": "indexTransactions",
"summary": "Index Transactions",
"parameters": [
{
"name": "type",
"required": false,
"in": "query",
"description": "Transaction Type",
"schema": {
"enum": [
"TOPUP",
"CHARGE",
"REFUND",
"PAYOUT",
"TOPUP_REFUND",
"ADJUSTMENT",
"TRANSFER",
"WITHDRAWAL",
"DISPUTE"
],
"type": "string"
}
},
{
"name": "status",
"required": false,
"in": "query",
"description": "Transaction Status",
"schema": {
"enum": [
"CREATED",
"PROCESSING",
"AUTHORISED",
"SUCCEEDED",
"FAILED",
"CANCELLED",
"EXPIRED",
"PARTIALLY_REFUNDED",
"REFUNDED"
],
"type": "string"
}
},
{
"name": "transactionDateFrom",
"required": false,
"in": "query",
"format": "date-time",
"description": "Transaction Created at start range",
"schema": {
"type": "string"
}
},
{
"name": "transactionDateTo",
"required": false,
"in": "query",
"format": "date-time",
"description": "Transaction Created at end range",
"schema": {
"type": "string"
}
},
{
"name": "walletId",
"required": false,
"in": "query",
"description": "Wallet ID",
"schema": {
"type": "string"
}
},
{
"name": "walletToken",
"required": false,
"in": "query",
"description": "Wallet Token",
"schema": {
"type": "string"
}
},
{
"name": "userId",
"required": false,
"in": "query",
"description": "User ID",
"schema": {
"type": "string"
}
},
{
"name": "referenceId",
"required": false,
"in": "query",
"description": "Reference ID",
"schema": {
"type": "string"
}
},
{
"name": "perPage",
"required": false,
"in": "query",
"description": "Items per page",
"schema": {
"type": "number"
}
},
{
"name": "page",
"required": false,
"in": "query",
"description": "Page number",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TransactionOutput"
}
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"transactions"
],
"security": [
{
"bearer": []
}
]
}
},
"/transactions/{txid}": {
"get": {
"operationId": "readTransaction",
"summary": "Read Transaction",
"parameters": [
{
"name": "txid",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"transactions"
],
"security": [
{
"bearer": []
}
]
}
},
"/transactions/{txid}/refund": {
"post": {
"operationId": "refundTransaction",
"summary": "Refund Transaction",
"parameters": [
{
"name": "txid",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"transactions"
],
"security": [
{
"bearer": []
}
]
}
},
"/transactions/adjustments": {
"post": {
"operationId": "createAdjustmentTransaction",
"summary": "Create Adjustment Transaction By Wallet Token",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAdjustmentTransactionInput"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"transactions"
],
"security": [
{
"bearer": []
}
]
}
},
"/transactions/adjustments-by-customer-id": {
"post": {
"operationId": "createAdjustmentTransactionByCustomerId",
"summary": "Create Adjustment Transaction By Customer Id",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAdjustmentTransactionByCustomerIdInput"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"transactions"
],
"security": [
{
"bearer": []
}
]
}
},
"/transactions/adjustments/{id}": {
"put": {
"operationId": "updateAdjustmentTransaction",
"summary": "Update Adjustment Transaction",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAdjustmentTransactionInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"transactions"
],
"security": [
{
"bearer": []
}
]
}
},
"/transactions/topups": {
"post": {
"operationId": "createTopUpTransaction",
"summary": "Create Top-up Transaction",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTopUpTransactionInput"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"transactions"
],
"security": [
{
"bearer": []
}
]
}
},
"/transactions/topups/{id}": {
"put": {
"operationId": "updateTopUpTransaction",
"summary": "Update Top-up Transaction",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTopUpTransactionInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"transactions"
],
"security": [
{
"bearer": []
}
]
}
},
"/transactions/charges": {
"post": {
"operationId": "createChargeTransaction",
"summary": "Create Charge Transaction",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateChargeTransactionInput"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"transactions"
],
"security": [
{
"bearer": []
}
]
}
},
"/transactions/charges/{id}": {
"put": {
"operationId": "updateChargeTransaction",
"summary": "Update Charge Transaction",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateChargeTransactionInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"transactions"
],
"security": [
{
"bearer": []
}
]
}
},
"/webhooks/topup/credit-card": {
"post": {
"operationId": "topUpCreditCardWebhook",
"summary": "Top Up Credit Card Webhook",
"description": "Top up credit card webhook called by iPay88 when transaction succeeded.",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditCardPaymentResponse"
}
}
}
},
"responses": {
"200": {
"description": "Return RECEIVEOK when transaction succeeded.",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"webhooks"
]
}
},
"/webhooks/topup/bank-account": {
"post": {
"operationId": "topUpBankAccountWebhook",
"summary": "Top Up Bank Account Webhook",
"description": "Top up bank account webhook called by iPay88 when transaction succeeded.",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BankPaymentResponse"
}
}
}
},
"responses": {
"200": {
"description": "Return RECEIVEOK when transaction succeeded.",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"webhooks"
]
}
},
"undefined": {
"undefined": {
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetMigrateKipleBalanceAdjustmentTransactionInput"
}
}
}
},
"responses": {
"200": {
"description": ""
}
}
}
},
"/levels/configs": {
"post": {
"operationId": "createLevelConfig",
"summary": "Create LevelConfig",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateLevelConfigInput"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LevelConfigOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"levels"
],
"security": [
{
"bearer": []
}
]
},
"put": {
"operationId": "updateLevelConfig",
"summary": "Update LevelConfig",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateLevelConfigInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LevelConfigOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"levels"
],
"security": [
{
"bearer": []
}
]
}
},
"/levels/{level}/configs": {
"get": {
"operationId": "listLevelConfigsByLevel",
"summary": "List LevelConfigs By Level",
"parameters": [
{
"name": "level",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LevelConfigOutput"
}
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"levels"
],
"security": [
{
"bearer": []
}
]
}
},
"/kiple/user": {
"get": {
"operationId": "checkUser",
"summary": "Check User",
"parameters": [
{
"name": "email",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "mobile",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckUserOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
},
"post": {
"operationId": "createUser",
"summary": "Create User",
"parameters": [
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUserInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/refreshtoken": {
"post": {
"operationId": "refreshToken",
"summary": "Refresh Token",
"parameters": [
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefreshTokenInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/update": {
"post": {
"operationId": "updateUser",
"summary": "Update User",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/storecard": {
"get": {
"operationId": "retrieveUserStorecardDetails",
"summary": "Retrieve User Storecard Details",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserStorecardOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/changepin": {
"post": {
"operationId": "changeUserPin",
"summary": "Change User PIN",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeUserPinInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeUserPinOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/resetpin": {
"post": {
"operationId": "resetUserPin",
"summary": "Reset User PIN",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResetUserPinOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/storecard/topup": {
"post": {
"operationId": "createTopUpBankAccount",
"summary": "Top Up Bank Account",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTopUpBankAccountInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTopUpBankAccountOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/storecard/topup/{id}": {
"get": {
"operationId": "retrieveTopUpBankAccountTransaction",
"summary": "Retrieve Top Up Bank Account Transaction",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TopUpBankAccountTransactionOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/payment": {
"post": {
"operationId": "makePayment",
"summary": "Make Payment",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MakePaymentInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MakePaymentOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/hold": {
"post": {
"operationId": "authorisePayment",
"summary": "Authorise Payment",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorisePaymentInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorisePaymentOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/commit": {
"post": {
"operationId": "capturePayment",
"summary": "Capture Payment",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CapturePaymentInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CapturePaymentOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/cancel": {
"post": {
"operationId": "cancelPayment",
"summary": "Cancel Payment",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelPaymentInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelPaymentOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/transaction/void": {
"post": {
"operationId": "refundPayment",
"summary": "Refund Payment",
"parameters": [
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefundPaymentInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefundPaymentOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/hold/status/{id}": {
"get": {
"operationId": "retrieveAuthorisedPaymentTransaction",
"summary": "Retrieve Authorised Payment Transaction",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorisedPaymentTransactionOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/hold/balance": {
"get": {
"operationId": "getAuthorisedBalance",
"summary": "Get Authorised Balance",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorisedBalanceOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/transactions": {
"get": {
"operationId": "getTransactionHistory",
"summary": "Get Transaction History",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "page",
"required": false,
"in": "query",
"example": 1,
"schema": {
"type": "number"
}
},
{
"name": "pagesize",
"required": false,
"in": "query",
"example": 20,
"schema": {
"type": "number"
}
},
{
"name": "fromdate",
"required": false,
"in": "query",
"format": "date-time",
"schema": {
"type": "string"
}
},
{
"name": "todate",
"required": false,
"in": "query",
"format": "date-time",
"schema": {
"type": "string"
}
},
{
"name": "transactionid",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "referenceid",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetTransactionHistoryOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/transactions/{id}": {
"get": {
"operationId": "getTransactionDetail",
"summary": "Get Transaction Detail",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetTransactionHistoryOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/storecard/bonus": {
"post": {
"operationId": "bonusStorecard",
"summary": "Bonus Storecard",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BonusStorecardInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BonusStorecardOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/void-bonus-storecard": {
"post": {
"operationId": "refundBonusStorecard",
"summary": "Refund Bonus Storecard",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefundBonusStorecardInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefundBonusStorecardOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/merchant/get-prefund": {
"get": {
"operationId": "getPrefundAmount",
"summary": "Get Prefund Amount",
"parameters": [
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetPrefundAmountOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/merchant/get-prefund-history": {
"get": {
"operationId": "getPrefundHistory",
"summary": "Get Prefund Transaction History",
"parameters": [
{
"name": "page",
"required": false,
"in": "query",
"example": 1,
"schema": {
"type": "number"
}
},
{
"name": "pagesize",
"required": false,
"in": "query",
"example": 20,
"schema": {
"type": "number"
}
},
{
"name": "fromdate",
"required": false,
"in": "query",
"format": "date-time",
"schema": {
"type": "string"
}
},
{
"name": "todate",
"required": false,
"in": "query",
"format": "date-time",
"schema": {
"type": "string"
}
},
{
"name": "mobile",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "transactionid",
"required": false,
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "referenceid",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "access-id",
"in": "header",
"description": "The unique service access ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetPrefundHistoryOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/storecard/topup/process/{request_id}": {
"get": {
"operationId": "viewProcessTopUpPage",
"summary": "View Process Top Up Page",
"description": "View process top-up page that redirects to payment gateway",
"parameters": [
{
"name": "request_id",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": ""
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiple/user/{token}/topup-completed": {
"post": {
"operationId": "processTopUpCompleted",
"summary": "Process Top Up Completed",
"description": "Process top-up response from payment gateway",
"parameters": [
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BankPaymentResponse"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TopUpBankAccountTransactionOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorecardErrorResponse"
}
}
}
}
},
"tags": [
"storecard"
]
}
},
"/kiplecc/tokenization/{token_id}": {
"delete": {
"operationId": "deleteToken",
"summary": "Delete Credit Card Token",
"parameters": [
{
"name": "token_id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "x-api-key",
"in": "header",
"description": "The unique key to access to the API service",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTokenInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTokenOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CCGatewayErrorResponse"
}
}
}
}
},
"tags": [
"ccgateway"
]
},
"get": {
"operationId": "getCreditCardInformation",
"summary": "Get Credit Card Information",
"parameters": [
{
"name": "token_id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "x-api-key",
"in": "header",
"description": "The unique key to access to the API service",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditCardInformationOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CCGatewayErrorResponse"
}
}
}
}
},
"tags": [
"ccgateway"
]
}
},
"/kiplecc/transaction/{token_id}/pay/{transaction_id}": {
"post": {
"operationId": "createTopUpCreditCard",
"summary": "Top-up Credit Card",
"parameters": [
{
"name": "token_id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "transaction_id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "x-api-key",
"in": "header",
"description": "The unique key to access to the API service",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTopUpCreditCardInput"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTopUpCreditCardOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CCGatewayErrorResponse"
}
}
}
}
},
"tags": [
"ccgateway"
]
}
},
"/kiplecc/transaction/{reference_id}": {
"get": {
"operationId": "retrieveTopUpCreditCardTransaction",
"summary": "Retrieve Top-up Credit Card Transaction",
"parameters": [
{
"name": "reference_id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "x-api-key",
"in": "header",
"description": "The unique key to access to the API service",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TopUpCreditCardTransactionOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CCGatewayErrorResponse"
}
}
}
}
},
"tags": [
"ccgateway"
]
}
},
"/keys": {
"post": {
"operationId": "createKey",
"summary": "Create Key",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateKeyInput"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateKeyOutput"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"keys"
],
"security": [
{
"bearer": []
}
]
},
"get": {
"operationId": "listKeys",
"summary": "List Keys",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KeyOutput"
}
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"keys"
],
"security": [
{
"bearer": []
}
]
}
},
"/keys/{key}": {
"delete": {
"operationId": "removeKey",
"summary": "Remove Key",
"parameters": [
{
"name": "key",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": ""
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"keys"
],
"security": [
{
"bearer": []
}
]
}
},
"/echo": {
"post": {
"operationId": "echo",
"summary": "Echo",
"parameters": [],
"responses": {
"201": {
"description": ""
}
}
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment