Solvimon payments API
The payments API from Solvimon — 8 operation(s) for payments.
The payments API from Solvimon — 8 operation(s) for payments.
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-payments-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 Payments 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: payments
paths:
/v{version}/payments:
get:
operationId: getPayments
summary: Get a list of payments
description: Requires the PAYMENT.VIEW permission.
tags:
- payments
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: customer_id
in: query
description: Filter based of customer ID
required: false
schema:
type: string
- name: invoice_id
in: query
description: Filter based of invoice ID
required: false
schema:
type: string
- name: external_reference
in: query
description: Filter based on external reference
required: false
schema:
type: string
- name: expand[]
in: query
description: The id fields of the resources that are going to be expanded.
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/PaymentResponseWrapper'
'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'
post:
operationId: postPayments
summary: Create a payment
description: Requires the PAYMENT.CREATE permission.
tags:
- payments
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/Payment'
'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'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentCreateRequest'
/v{version}/payments/{resourceId}:
get:
operationId: getPaymentsByResourceId
summary: Get a payment by ID
description: Requires the PAYMENT.VIEW permission.
tags:
- payments
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource to be requested.
required: true
schema:
type: string
default: ''
- name: expand[]
in: query
description: The id fields of the resources that are going to be expanded.
required: false
schema:
type: array
items:
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/Payment'
'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'
/v{version}/payments/{resourceId}/refund:
post:
operationId: postPaymentsByResourceIdRefund
summary: Refund a payment
description: Requires the PAYMENT.REFUND permission.
tags:
- payments
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource for which the action is posted.
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/PaymentModificationResponse'
'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'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RefundPaymentRequestCreateRequest'
/v{version}/payments/{resourceId}/reverse:
post:
operationId: postPaymentsByResourceIdReverse
summary: Reverse a payment
description: Requires the PAYMENT.REVERSE permission.
tags:
- payments
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource for which the action is posted.
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/PaymentModificationResponse'
'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'
/v{version}/payments/authorize:
post:
operationId: postPaymentsAuthorize
summary: Authorize a payment
description: Requires the PAYMENT.AUTHORIZE permission.
tags:
- payments
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'
'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'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizePaymentRequestCreateRequest'
/v{version}/payments/verify-details:
post:
operationId: postPaymentsVerifyDetails
summary: Verify payment details
description: Requires the PAYMENT.AUTHORIZE permission.
tags:
- payments
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/PaymentVerifyDetailResponse'
'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'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentVerifyDetailCreateRequest'
/v{version}/payment-requests:
get:
operationId: getPaymentRequests
summary: Get Payment Requests
description: Requires the PAYMENT_REQUEST.VIEW permission.
tags:
- payments
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: customer_id
in: query
description: Filter based of customer ID
required: false
schema:
type: string
- name: payment_schedule_id
in: query
description: Filter based of payment schedule ID
required: false
schema:
type: string
- name: statuses[]
in: query
description: Filter payment requests based on status(es)
required: false
schema:
type: array
items:
type: string
- name: expand[]
in: query
description: The id fields of the resources that are going to be expanded.
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/PaymentRequestResponseWrapper'
'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'
/v{version}/payment-requests/{resourceId}:
get:
operationId: getPaymentRequestsByResourceId
summary: Get a Payment Request by ID
description: Requires the PAYMENT_REQUEST.VIEW permission.
tags:
- payments
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource to be requested.
required: true
schema:
type: string
default: ''
- name: expand[]
in: query
description: The id fields of the resources that are going to be expanded.
required: false
schema:
type: array
items:
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/PaymentRequest'
'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'
components:
schemas:
PaymentModificationResponse:
type: object
properties:
payment:
$ref: '#/components/schemas/Payment'
status:
$ref: '#/components/schemas/PaymentModificationResponseStatus'
title: PaymentModificationResponse
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
AdyenVerifyDetailsCreateRequest:
type: object
properties:
details:
type:
- object
- 'null'
additionalProperties:
type: string
redirect_result:
type:
- string
- 'null'
threeds_result:
type:
- string
- 'null'
payment_data:
type:
- string
- 'null'
title: AdyenVerifyDetailsCreateRequest
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
CustomerCreateRequestType:
type: string
enum:
- ORGANIZATION
- INDIVIDUAL
description: The type of customer entity.
title: CustomerCreateRequestType
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
PaymentMethodDetailsCreateRequest:
type: object
properties:
type:
$ref: '#/components/schemas/PaymentMethodDetailsCreateRequestType'
card:
$ref: '#/components/schemas/PaymentMethodDetailsCard'
online_banking:
$ref: '#/components/schemas/PaymentMethodDetailsOnlineBanking'
buy_now_pay_later:
$ref: '#/components/schemas/PaymentMethodDetailsBuyNowPayLater'
direct_debit:
$ref: '#/components/schemas/PaymentMethodDetailsDirectDebit'
digital_wallet:
$ref: '#/components/schemas/PaymentMethodDetailsDigitalWallet'
unknown:
$ref: '#/components/schemas/PaymentMethodDetailsUnknown'
title: PaymentMethodDetailsCreateRequest
PaymentMethodPaymentResponseStatus:
type: string
enum:
- SUCCESS
- ACTION_REQUIRED
- FAILURE
title: PaymentMethodPaymentResponseStatus
PaymentVerifyDetailResponse:
type: object
properties:
payment_status:
type: string
title: PaymentVerifyDetailResponse
PaymentCreateRequestResult:
type: string
enum:
- AUTHORIZED
- CANCELLED
- CHARGED_BACK
- ERROR
- PENDING
- REFUSED
- REFUNDED
title: PaymentCreateRequestResult
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
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
# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/solvimon/refs/heads/main/openapi/solvimon-payments-api-openapi.yml