Solvimon walletTypes API
The walletTypes API from Solvimon — 6 operation(s) for wallettypes.
The walletTypes API from Solvimon — 6 operation(s) for wallettypes.
openapi: 3.1.0
info:
title: Configuration alertRules walletTypes API
version: 1.0.0
servers:
- url: https://test.api.solvimon.com
description: The TEST environment for our API
- url: https://api.solvimon.com
description: The live environment for our API
tags:
- name: walletTypes
paths:
/v{version}/wallet-types:
get:
operationId: getWalletTypes
summary: Get a list of all wallet types
description: Requires the WALLET_TYPE.VIEW permission.
tags:
- walletTypes
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: statuses[]
in: query
description: Filter by wallet type status.
required: false
schema:
type: array
items:
type: string
- name: limit
in: query
description: The amount of records shown in the list.
required: false
schema:
type: integer
- name: page
in: query
description: The page which is going to be shown.
required: false
schema:
type: integer
- name: order_by
in: query
description: The parameter by which the response is ordered.
required: false
schema:
type: string
- name: order_direction
in: query
description: The order direction by which the response is ordered.
required: false
schema:
type: string
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WalletTypeResponseWrapper'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
post:
operationId: postWalletTypes
summary: Create a wallet type
description: Requires the WALLET_TYPE.CREATE permission.
tags:
- walletTypes
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/WalletType'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WalletTypeCreateRequest'
/v{version}/wallet-types/{resourceIdOrReference}:
get:
operationId: getWalletTypesByResourceIdOrReference
summary: Get a wallet type
description: Requires the WALLET_TYPE.VIEW permission.
tags:
- walletTypes
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceIdOrReference
in: path
description: The ID or reference of the resource.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WalletType'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
patch:
operationId: patchWalletTypesByResourceIdOrReference
summary: Update a wallet type
description: Requires the WALLET_TYPE.UPDATE permission.
tags:
- walletTypes
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceIdOrReference
in: path
description: The ID or reference of the resource.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WalletType'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WalletTypeUpdateRequest'
/v{version}/wallet-types/{resourceIdOrReference}/activate:
post:
operationId: postWalletTypesByResourceIdOrReferenceActivate
summary: Activate a wallet type
description: Requires the WALLET_TYPE.UPDATE permission.
tags:
- walletTypes
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceIdOrReference
in: path
description: The ID or reference of the resource.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WalletType'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/v{version}/wallet-types/{resourceIdOrReference}/deactivate:
post:
operationId: postWalletTypesByResourceIdOrReferenceDeactivate
summary: Deactivate a wallet type
description: Requires the WALLET_TYPE.UPDATE permission.
tags:
- walletTypes
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceIdOrReference
in: path
description: The ID or reference of the resource.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WalletType'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/v{version}/wallet-types/{resourceIdOrReference}/deprecate:
post:
operationId: postWalletTypesByResourceIdOrReferenceDeprecate
summary: Deprecate a wallet type
description: Requires the WALLET_TYPE.UPDATE permission.
tags:
- walletTypes
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceIdOrReference
in: path
description: The ID or reference of the resource.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WalletType'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/v{version}/wallet-types/{resourceIdOrReference}/archive:
post:
operationId: postWalletTypesByResourceIdOrReferenceArchive
summary: Archive a wallet type
description: Requires the WALLET_TYPE.UPDATE permission.
tags:
- walletTypes
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceIdOrReference
in: path
description: The ID or reference of the resource.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WalletType'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
components:
schemas:
WalletTypeType:
type: string
enum:
- CREDIT
- BALANCE
title: WalletTypeType
WalletTypeBalance:
type: object
properties:
default_currency:
type: string
description: The default currency for the wallet.
title: WalletTypeBalance
WalletTypeCreditUpdateRequestGrantType:
type: string
enum:
- CREDITS
- AMOUNT
title: WalletTypeCreditUpdateRequestGrantType
WalletTypeCreditCreditsGrant:
type: object
properties:
credit_type_id:
type: string
description: The credit type for wallets of wallet type.
title: WalletTypeCreditCreditsGrant
WalletTypeCreditCreateRequest:
type: object
properties:
grant_type:
$ref: '#/components/schemas/WalletTypeCreditCreateRequestGrantType'
amount_grant:
$ref: '#/components/schemas/WalletTypeCreditAmountGrant'
credits_grant:
$ref: '#/components/schemas/WalletTypeCreditCreditsGrant'
title: WalletTypeCreditCreateRequest
WalletTypeBalanceUpdateRequest:
type: object
properties:
default_currency:
type: string
description: The default currency for the wallet.
title: WalletTypeBalanceUpdateRequest
WalletTypeCreateRequestType:
type: string
enum:
- CREDIT
- BALANCE
title: WalletTypeCreateRequestType
WalletType:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
name:
type: string
reference:
type: string
status:
oneOf:
- $ref: '#/components/schemas/WalletTypeStatus'
- type: 'null'
type:
oneOf:
- $ref: '#/components/schemas/WalletTypeType'
- type: 'null'
credit:
$ref: '#/components/schemas/WalletTypeCredit'
balance:
$ref: '#/components/schemas/WalletTypeBalance'
created_at:
type:
- string
- 'null'
updated_at:
type:
- string
- 'null'
title: WalletType
WalletTypeCreditAmountGrantTaxCategory:
type: string
enum:
- STANDARD
- NO_TAX
- EXEMPT
description: The tax category to for what the wallet can be applied to.
title: WalletTypeCreditAmountGrantTaxCategory
WalletTypeUpdateRequestType:
type: string
enum:
- CREDIT
- BALANCE
title: WalletTypeUpdateRequestType
WalletTypeCreditAmountGrant:
type: object
properties:
default_currency:
$ref: '#/components/schemas/WalletTypeCreditAmountGrantDefaultCurrency'
description: The default currency for the wallet.
tax_category:
$ref: '#/components/schemas/WalletTypeCreditAmountGrantTaxCategory'
description: The tax category to for what the wallet can be applied to.
title: WalletTypeCreditAmountGrant
WalletTypeCredit:
type: object
properties:
grant_type:
$ref: '#/components/schemas/WalletTypeCreditGrantType'
amount_grant:
$ref: '#/components/schemas/WalletTypeCreditAmountGrant'
credits_grant:
$ref: '#/components/schemas/WalletTypeCreditCreditsGrant'
title: WalletTypeCredit
WalletTypeCreateRequest:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
name:
type: string
reference:
type: string
status:
oneOf:
- $ref: '#/components/schemas/WalletTypeCreateRequestStatus'
- type: 'null'
type:
oneOf:
- $ref: '#/components/schemas/WalletTypeCreateRequestType'
- type: 'null'
credit:
$ref: '#/components/schemas/WalletTypeCreditCreateRequest'
balance:
$ref: '#/components/schemas/WalletTypeBalanceCreateRequest'
created_at:
type:
- string
- 'null'
updated_at:
type:
- string
- 'null'
required:
- name
- reference
- type
title: WalletTypeCreateRequest
WalletTypeUpdateRequest:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
name:
type: string
reference:
type: string
status:
oneOf:
- $ref: '#/components/schemas/WalletTypeUpdateRequestStatus'
- type: 'null'
type:
oneOf:
- $ref: '#/components/schemas/WalletTypeUpdateRequestType'
- type: 'null'
credit:
$ref: '#/components/schemas/WalletTypeCreditUpdateRequest'
balance:
$ref: '#/components/schemas/WalletTypeBalanceUpdateRequest'
created_at:
type:
- string
- 'null'
updated_at:
type:
- string
- 'null'
title: WalletTypeUpdateRequest
WalletTypeStatus:
type: string
enum:
- DRAFT
- ACTIVE
- INACTIVE
- DEPRECATED
- ARCHIVED
title: WalletTypeStatus
WalletTypeUpdateRequestStatus:
type: string
enum:
- DRAFT
- ACTIVE
- INACTIVE
- DEPRECATED
- ARCHIVED
title: WalletTypeUpdateRequestStatus
WalletTypeCreditGrantType:
type: string
enum:
- CREDITS
- AMOUNT
title: WalletTypeCreditGrantType
ApiErrorType:
type: string
enum:
- API_ERROR
- INVALID_REQUEST
title: ApiErrorType
WalletTypeCreditCreateRequestGrantType:
type: string
enum:
- CREDITS
- AMOUNT
title: WalletTypeCreditCreateRequestGrantType
ApiError:
type: object
properties:
type:
$ref: '#/components/schemas/ApiErrorType'
code:
$ref: '#/components/schemas/ApiErrorCode'
field:
type:
- string
- 'null'
message:
type: string
resource_id:
type:
- string
- 'null'
resource_type:
oneOf:
- $ref: '#/components/schemas/ApiErrorResourceType'
- type: 'null'
required:
- type
- code
- message
title: ApiError
WalletTypeCreditUpdateRequest:
type: object
properties:
grant_type:
$ref: '#/components/schemas/WalletTypeCreditUpdateRequestGrantType'
amount_grant:
$ref: '#/components/schemas/WalletTypeCreditAmountGrant'
credits_grant:
$ref: '#/components/schemas/WalletTypeCreditCreditsGrant'
title: WalletTypeCreditUpdateRequest
ApiErrorResourceType:
type: string
enum:
- CUSTOMER
- CUSTOM_FIELD
- PLATFORM
- PLATFORM_UPTODATE
- METER
- METER_VALUE
- METER_PROPERTY
- METER_VALUE_CALCULATION
- INGEST_DATA
- METER_DATA
- CHARGE_DATA
- PERSIST_DATA
- ADJUSTMENT_DATA
- PRODUCT_CATEGORY
- PRODUCT
- PRODUCT_ITEM
- PRICING
- PRICING_GROUP
- PRICING_ITEM
- PRICING_ITEM_CONFIG
- PRICING_PLAN_SUBSCRIPTION
- PRICING_PLAN_SUBSCRIPTION_GROUP
- PRICING_PLAN_SCHEDULE
- PRICING_PLAN
- PRICING_PLAN_VERSION
- QUOTE
- QUOTE_VERSION
- QUOTE_TEMPLATE
- API_KEY
- USER
- ROLE
- PROXY_USER
- EXTERNAL_CREDENTIALS
- TOKEN
- INVOICE
- E_INVOICE
- PDF
- BILLING_ENTITY
- FEATURE
- MEMBERSHIP
- PAYMENT
- PAYMENT_ACCEPTOR
- PAYMENT_METHOD
- PAYMENT_METHOD_OPTIONS
- PAYMENT_SCHEDULE
- PAYMENT_REQUEST
- INTEGRATION
- WEBHOOK
- FILE
- FILE_PROCESSING_SETTINGS
- TEAM
- DOWNLOAD_URL
- CSV_REPORT
- REPORT
- REPORT_GENERATE_REQUEST
- REPORT_CONFIGURATION
- REPORT_SUBSCRIPTION
- REPORT_DEFINITION
- ACCOUNT_GROUP
- ENTITY
- EVENT_TRACE
- EVENT_TRACE_LINK
- PRICING_CATEGORY
- CONTACT
- ALERT_RULE
- ALERT
- AUDIT_RECORD
- PORTAL_URL
- AUTHENTICATION_PROVIDER
- REPROCESS
- APPROVAL_POLICY
- APPROVAL_REQUEST
- BULK_ACTION
- COUPON
- PROMOTION_CODE
- WALLET
- WALLET_TYPE
- WALLET_GRANT
- WORKFLOW
- WORKFLOW_TRIGGER
- WORKFLOW_ACTION
- CREDIT_TYPE
- SIGNATURE_REQUEST
- ATTACHMENT
- DOCUMENT
title: ApiErrorResourceType
WalletTypeCreditAmountGrantDefaultCurrency:
type: string
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHF
- CLF
- CLP
- CNY
- COP
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MRU
- MUR
- MVR
- MWK
- MXN
- MXV
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLE
- SOS
- SRD
- SSP
- STN
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- USN
- UYI
- UYU
- UZS
- VEF
- VES
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XOF
- XPD
- XPF
- XPT
- XSU
- XTS
- XUA
- XXX
- YER
- ZAR
- ZMW
- ZWL
description: The default currency for the wallet.
title: WalletTypeCreditAmountGrantDefaultCurrency
WalletTypeResponseWrapper:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/WalletType'
limit:
type:
- integer
- 'null'
page:
type:
- integer
- 'null'
total_number_of_pages:
type:
- integer
- 'null'
links:
$ref: '#/components/schemas/PaginationLinks'
required:
- data
- links
title: WalletTypeResponseWrapper
ApiErrorCode:
type: string
enum:
- RESOURCE_NOT_FOUND
- RESOURCES_NOT_FOUND
- UNABLE_TO_PROCESS_INSTRUCTIONS
- BAD_REQUEST
- UNSUPPORTED_MEDIA_TYPE
- RESOURCE_ALREADY_EXISTS
- CUSTOM_FIELD_VALUE_ALREADY_EXISTS
- COULD_NOT_CREATE_RESOURCE
- COULD_NOT_UPDATE_RESOURCE
- COULD_NOT_DELETE_RESOURCE
- MISSING_VERSION
- UNSUPPORTED_VERSION
- UNAUTHORISED
- CUSTOMER_NOT_FOUND
- PLATFORM_NOT_FOUND
- PRICING_PLAN_NOT_FOUND
- PRODUCT_NOT_FOUND
- PRODUCT_ITEM_NOT_FOUND
- PRICING_NOT_FOUND
- PRICING_ITEM_NOT_FOUND
- USER_NOT_FOUND
- METER_NOT_FOUND
- METER_VALUE_NOT_FOUND
- METER_PROPERTY_NOT_FOUND
- PRICING_ITEM_SUMMARIES_NOT_FOUND
- MISSING_ID
- INVALID_ID
- MISSING_REFERENCE
- MISSING_FIELD
- INVALID_FIELD
- INVALID_OPERATION
- INTERNAL_ERROR
- USER_NOT_ALLOWED
- IDEMPOTENCY_CHECK_FAILED
- INVALID_REQUEST
title: ApiErrorCode
WalletTypeCreateRequestStatus:
type: string
enum:
- DRAFT
- ACTIVE
- INACTIVE
- DEPRECATED
- ARCHIVED
title: WalletTypeCreateRequestStatus
PaginationLinks:
type: object
properties:
first:
type:
- string
- 'null'
previous:
type:
- string
- 'null'
current:
type:
- string
- 'null'
next:
type:
- string
- 'null'
title: PaginationLinks
WalletTypeBalanceCreateRequest:
type: object
properties:
default_currency:
type: string
description: The default currency for the wallet.
title: WalletTypeBalanceCreateRequest
securitySchemes:
API-Key:
type: apiKey
in: header
name: X-API-KEY
JWT-Authentication:
type: http
scheme: bearer