Solvimon paymentMethods API
The paymentMethods API from Solvimon — 4 operation(s) for paymentmethods.
The paymentMethods API from Solvimon — 4 operation(s) for paymentmethods.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/solvimon-paymentmethods-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Configuration alertRules Payment Methods 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: paymentMethods
paths:
/v{version}/payment-methods:
get:
operationId: getPaymentMethods
summary: Get a list of payment methods
description: Requires the PAYMENT_METHOD.VIEW permission.
tags:
- paymentMethods
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: customer_id
in: query
description: The customer ID.
required: false
schema:
type: string
- name: integration_id
in: query
description: The integration ID.
required: false
schema:
type: string
- name: integration_payment_method_reference
in: query
description: The integration payment method reference.
required: false
schema:
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/PaymentMethodResponseWrapper'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
post:
operationId: postPaymentMethods
summary: Create a payment method
description: Requires the PAYMENT_METHOD.CREATE permission.
tags:
- paymentMethods
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/PaymentMethod'
'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/PaymentMethodCreateRequest'
put:
operationId: putPaymentMethods
summary: Update or create a payment method (upsert)
description: Requires the PAYMENT_METHOD.CREATE or PAYMENT_METHOD.UPDATE permission.
tags:
- paymentMethods
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/PaymentMethod'
'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'
'404':
description: Not Found
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/PaymentMethodCreateRequest'
/v{version}/payment-methods/{resourceIdOrReference}:
get:
operationId: getPaymentMethodsByResourceIdOrReference
summary: Get a payment method
description: Requires the PAYMENT_METHOD.VIEW permission.
tags:
- paymentMethods
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/PaymentMethod'
'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: patchPaymentMethodsByResourceIdOrReference
summary: Update a payment method
description: Requires the PAYMENT_METHOD.UPDATE permission.
tags:
- paymentMethods
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/PaymentMethod'
'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/PaymentMethodUpdateRequest'
/v{version}/payment-methods/refresh:
post:
operationId: postPaymentMethodsRefresh
summary: Refresh the payment methods of a customer
description: Requires the PAYMENT_METHOD.UPDATE permission.
tags:
- paymentMethods
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:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethodResponseWrapper'
'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/PaymentMethodActionRefreshCreateRequest'
/v{version}/payment-methods/tokenize:
post:
operationId: postPaymentMethodsTokenize
summary: Tokenize a payment method
description: Requires the PAYMENT_METHOD.CREATE permission.
tags:
- paymentMethods
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:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethodPaymentResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethodTokenizationRequestCreateRequest'
components:
schemas:
IntegrationDetailsUpdateRequest:
type: object
properties:
id:
type:
- string
- 'null'
reference:
type:
- string
- 'null'
payment_gateway_variant:
$ref: '#/components/schemas/IntegrationDetailsUpdateRequestPaymentGatewayVariant'
adyen:
$ref: '#/components/schemas/AdyenIntegrationDetails'
stripe:
$ref: '#/components/schemas/StripeIntegrationDetails'
title: IntegrationDetailsUpdateRequest
PayInvoicePaymentContext:
type: object
properties:
invoice_id:
type:
- string
- 'null'
description: Resource ID of type INVOICE
title: PayInvoicePaymentContext
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
CustomerRolesItems:
type: string
enum:
- DEFAULT
- NON_PROCESSING
- SELF_BILLING
- SELLER
- PROCESSING_ONLY
title: CustomerRolesItems
Individual:
type: object
properties:
name:
$ref: '#/components/schemas/Name'
residential_address:
$ref: '#/components/schemas/Address'
title: Individual
PaymentMethodCardUpdateRequestBrand:
type: string
enum:
- ACCEL
- AMERICAN_EXPRESS
- BANCONTACT
- CARNET
- CARTES_BANCAIRES
- DANKORT
- DINERS
- DISCOVER
- EFTPOS
- ELO
- GIROCARD
- HIPERCARD
- JCB
- MAESTRO
- MASTERCARD
- NYCE
- PULSE
- STAR
- UNION_PAY
- VISA
- V_PAY
title: PaymentMethodCardUpdateRequestBrand
IntegrationDetailsUpdateRequestPaymentGatewayVariant:
type: string
enum:
- ADYEN
- STRIPE
title: IntegrationDetailsUpdateRequestPaymentGatewayVariant
PaymentResultDetails:
type: object
properties:
code:
type:
- string
- 'null'
reason:
type:
- string
- 'null'
external_code:
type:
- string
- 'null'
external_reason:
type:
- string
- 'null'
title: PaymentResultDetails
AdyenTokenizationRequestCreateRequest:
type: object
properties:
payment_method:
type: object
additionalProperties:
type: string
browser_info:
type: object
additionalProperties:
type: string
risk_data:
type: object
additionalProperties:
type: string
origin:
type: string
store_payment_method:
type: boolean
title: AdyenTokenizationRequestCreateRequest
NotificationPreference:
type: object
properties:
type:
$ref: '#/components/schemas/NotificationPreferenceType'
description: The notification type to configure.
channels:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/NotificationChannel'
description: The channels for this notification type.
title: NotificationPreference
PaymentMethodDetailsOnlineBanking:
type: object
properties:
variant:
type:
- string
- 'null'
owner_name:
type:
- string
- 'null'
iban:
type:
- string
- 'null'
bic:
type:
- string
- 'null'
country:
oneOf:
- $ref: '#/components/schemas/PaymentMethodDetailsOnlineBankingCountry'
- type: 'null'
title: PaymentMethodDetailsOnlineBanking
CustomerType:
type: string
enum:
- ORGANIZATION
- INDIVIDUAL
description: The type of customer entity.
title: CustomerType
PricingPlanScheduleCustomization:
type: object
properties:
pricing_plan_schedule_id:
type:
- string
- 'null'
seats_values:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConfiguredMeterValue'
enabled_pricings:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/EnabledPricing'
promotion_codes:
type:
- array
- 'null'
items:
type: string
pricing_currency:
oneOf:
- $ref: '#/components/schemas/PricingPlanScheduleCustomizationPricingCurrency'
- type: 'null'
billing_period:
$ref: '#/components/schemas/Period'
title: PricingPlanScheduleCustomization
PaymentMethodPaymentResponseStatus:
type: string
enum:
- SUCCESS
- ACTION_REQUIRED
- FAILURE
title: PaymentMethodPaymentResponseStatus
PaymentMethodUpdateRequestType:
type: string
enum:
- CARD
- ONLINE_BANKING
- BUY_NOW_PAY_LATER
- DIRECT_DEBIT
- DIGITAL_WALLET
- UNKNOWN
title: PaymentMethodUpdateRequestType
AddressUpdateRequest:
type: object
properties:
line1:
type:
- string
- 'null'
line2:
type:
- string
- 'null'
city:
type:
- string
- 'null'
postal_code:
type:
- string
- 'null'
state:
type:
- string
- 'null'
country:
oneOf:
- $ref: '#/components/schemas/AddressUpdateRequestCountry'
- type: 'null'
title: AddressUpdateRequest
CustomerSellerDetails:
type: object
properties:
default_billing_entity_id:
type:
- string
- 'null'
description: Resource ID of type BILLING_ENTITY
title: CustomerSellerDetails
Customer:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
created_at:
type:
- string
- 'null'
parent_customer_id:
type:
- string
- 'null'
description: The parent of the customer. Only returned when there is a single parent.
parent_customer_ids:
type:
- array
- 'null'
items:
type: string
description: A list of parents of the customer. Will also be returned if there is a single parent.
reference:
type: string
description: A custom reference assigned to the customer.
status:
oneOf:
- $ref: '#/components/schemas/CustomerStatus'
- type: 'null'
timezone:
type:
- string
- 'null'
type:
$ref: '#/components/schemas/CustomerType'
description: The type of customer entity.
email:
type: string
description: The email of the customer.
notification_preferences:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/NotificationPreference'
description: Notification preferences for customer-related communications.
locale:
type:
- string
- 'null'
description: The locale of the customer. Format is language-country (like en-US).
individual:
$ref: '#/components/schemas/Individual'
description: Additional description of the individual customer type.
organization:
$ref: '#/components/schemas/Organization'
description: Additional description of the organization customer type.
custom_fields:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CustomFieldValue'
processing_only:
type:
- boolean
- 'null'
pricing_plan_subscription_selector:
$ref: '#/components/schemas/PricingPlanSubscriptionSelector'
description: Settings to influence dynamically the subscription to use for the ingest data.
linked_integrations:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/LinkedIntegration'
roles:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CustomerRolesItems'
seller_details:
$ref: '#/components/schemas/CustomerSellerDetails'
title: Customer
InitPricingPlanSubscriptionPaymentContext:
type: object
properties:
template_pricing_plan_subscription_id:
type: string
description: Resource ID of type PRICING_PLAN_SUBSCRIPTION
pricing_plan_subscription_id:
type:
- string
- 'null'
billing_entity_id:
type:
- string
- 'null'
customer_details:
$ref: '#/components/schemas/Customer'
enabled_pricings:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/EnabledPricing'
pricing_plan_schedule_customizations:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PricingPlanScheduleCustomization'
title: InitPricingPlanSubscriptionPaymentContext
PaymentMethodActionRefreshCreateRequest:
type: object
properties:
customer_id:
type:
- string
- 'null'
description: Resource ID of type CUSTOMER
customer_reference:
type:
- string
- 'null'
payment_acceptor_id:
type:
- string
- 'null'
description: Resource ID of type PAYMENT_ACCEPTOR
payment_acceptor_reference:
type:
- string
- 'null'
title: PaymentMethodActionRefreshCreateRequest
Payment:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
created_at:
type:
- string
- 'null'
timestamp:
type:
- string
- 'null'
format: date-time
customer_id:
type:
- string
- 'null'
customer:
oneOf:
- $ref: '#/components/schemas/Customer'
- type: 'null'
invoice_id:
type:
- string
- 'null'
description: Resource ID of type INVOICE
payment_acceptor_id:
type:
- string
- 'null'
description: Resource ID of type PAYMENT_ACCEPTOR
payment_acceptor_reference:
type:
- string
- 'null'
payment_method_id:
type:
- string
- 'null'
description: Resource ID of type PAYMENT_METHOD
payment_method_details:
$ref: '#/components/schemas/PaymentMethodDetails'
integration_payment_method_reference:
type:
- string
- 'null'
external_reference:
type: string
reference:
type:
- string
- 'null'
amount:
$ref: '#/components/schemas/Amount'
result:
$ref: '#/components/schemas/PaymentResult'
result_details:
$ref: '#/components/schemas/PaymentResultDetails'
dunning_action_details:
$ref: '#/components/schemas/PaymentDunningActionDetails'
updated_at:
type:
- string
- 'null'
context:
$ref: '#/components/schemas/PaymentContext'
title: Payment
AddressCountry:
type: string
enum:
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AO
- AQ
- AR
- AS
- AT
- AU
- AW
- AX
- AZ
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BL
- BM
- BN
- BO
- BQ
- BR
- BS
- BT
- BV
- BW
- BY
- BZ
- CA
- CC
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CR
- CU
- CV
- CW
- CX
- CY
- CZ
- DE
- DJ
- DK
- DM
- DO
- DZ
- EC
- EE
- EG
- EH
- ER
- ES
- ET
- FI
- FJ
- FK
- FM
- FO
- FR
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GS
- GT
- GU
- GW
- GY
- HK
- HM
- HN
- HR
- HT
- HU
- ID
- IE
- IL
- IM
- IN
- IO
- IQ
- IR
- IS
- IT
- JE
- JM
- JO
- JP
- KE
- KG
- KH
- KI
- KM
- KN
- KP
- KR
- KW
- KY
- KZ
- LA
- LB
- LC
- LI
- LK
- LR
- LS
- LT
- LU
- LV
- LY
- MA
- MC
- MD
- ME
- MF
- MG
- MH
- MK
- ML
- MM
- MN
- MO
- MP
- MQ
- MR
- MS
- MT
- MU
- MV
- MW
- MX
- MY
- MZ
- NA
- NC
- NE
- NF
- NG
- NI
- NL
- 'NO'
- NP
- NR
- NU
- NZ
- OM
- PA
- PE
- PF
- PG
- PH
- PK
- PL
- PM
- PN
- PR
- PS
- PT
- PW
- PY
- QA
- RE
- RO
- RS
- RU
- RW
- SA
- SB
- SC
- SD
- SE
- SG
- SH
- SI
- SJ
- SK
- SL
- SM
- SN
- SO
- SR
- SS
- ST
- SV
- SX
- SY
- SZ
- TC
- TD
- TF
- TG
- TH
- TJ
- TK
- TL
- TM
- TN
- TO
- TR
- TT
- TV
- TW
- TZ
- UA
- UG
- US
- UY
- UZ
- VA
- VC
- VE
- VG
- VI
- VN
- VU
- WF
- WS
- YE
- YT
- ZA
- ZM
- ZW
title: AddressCountry
PricingPlanSubscriptionSelectorData:
type: object
properties:
field:
$ref: '#/components/schemas/PricingPlanSubscriptionSelectorDataField'
value:
type: string
title: PricingPlanSubscriptionSelectorData
PaymentMethodUpdateRequest:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
created_at:
type:
- string
- 'null'
updated_at:
type:
- string
- 'null'
reference:
type: string
status:
oneOf:
- $ref: '#/components/schemas/PaymentMethodUpdateRequestStatus'
- type: 'null'
type:
oneOf:
- $ref: '#/components/schemas/PaymentMethodUpdateRequestType'
- type: 'null'
card:
$ref: '#/components/schemas/PaymentMethodCardUpdateRequest'
online_banking:
$ref: '#/components/schemas/PaymentMethodOnlineBankingUpdateRequest'
buy_now_pay_later:
$ref: '#/components/schemas/PaymentMethodBuyNowPayLaterUpdateRequest'
direct_debit:
$ref: '#/components/schemas/PaymentMethodDirectDebitUpdateRequest'
digital_wallet:
$ref: '#/components/schemas/PaymentMethodDigitalWalletUpdateRequest'
customer_id:
type:
- string
- 'null'
description: Resource ID of type CUSTOMER
integration_id:
type:
- string
- 'null'
description: Resource ID of type INTEGRATION
integration_reference:
type:
- string
- 'null'
integration_details:
$ref: '#/components/schemas/IntegrationDetailsUpdateRequest'
billing_address:
$ref: '#/components/schemas/AddressUpdateRequest'
is_default:
type:
- boolean
- 'null'
title: PaymentMethodUpdateRequest
AdyenDirectPaymentContext:
type: object
properties:
capture_delay_hours:
type:
- integer
- 'null'
auto_rescue:
$ref: '#/components/schemas/DirectAutoRescue'
title: AdyenDirectPaymentContext
PaymentMethodOnlineBankingUpdateRequestCountry:
type: string
enum:
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AO
- AQ
- AR
- AS
- AT
- AU
- AW
- AX
- AZ
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BL
- BM
- BN
- BO
- BQ
- BR
- BS
- BT
- BV
- BW
- BY
- BZ
- CA
- CC
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CR
- CU
- CV
- CW
- CX
- CY
- CZ
- DE
- DJ
- DK
- DM
- DO
- DZ
- EC
- EE
- EG
- EH
- ER
- ES
- ET
- FI
- FJ
- FK
- FM
- FO
- FR
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GS
- GT
- GU
- GW
- GY
- HK
-
# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/solvimon/refs/heads/main/openapi/solvimon-paymentmethods-api-openapi.yml