Visma Payment API is one of 193 APIs that Visma publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, rate-limit docs, and a support channel.
This API exposes
6 operations
across 4 paths,
and defines 37 schemas.
It is described by OpenAPI 3.2.0, at version v1.
Requests are made against a single base URL, https://api.finance.visma.net.
6 operations4 paths37 schemas2 GET3 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.finance.visma.net
Authentication
OAuth 2.0
Resource Areas
1
Authentication & Security 1
Visma Payment API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (interactiveapi) using the authorizationCode flow, exposing 5 scopes.
Paths & Operations 6
Across 4 paths, the API surfaces 6 operations — 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Payment 6
GET
/v1/payment/{paymentNumber}deprecated
Get a specific Payment Payment is deprecated, please use CustomerPayment instead
Payment_GetBypaymentNumber2 params→ 200202
PUT
/v1/payment/{paymentNumber}deprecated
Update a specific Payment Payment is deprecated, please use CustomerPayment…
Payment_PutBypaymentNumber2 paramsbody→ 204202
GET
/v1/paymentdeprecated
Get a range of Payments - ScreenId=AP302000 Payment is deprecated, please use…
Payment_GetAllPayments18 params→ 200202
POST
/v1/paymentdeprecated
Create a Payment Payment is deprecated, please use CustomerPayment instead
The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are PaymentDto (30 properties), PaymentUpdateDto (18 properties), PaymentLineDto (16 properties), OrderToApplyDto (14 properties). Each schema is shown below with its type and property counts.
paymentMethodInPaymentDto
object
The top part Payment method The customer's default payment method; this field is not available for credit notes.
2 properties
paymentMethodInPaymentUpdateDto
object
The top part Payment method The customer's default payment method.
1 property
customerInPaymentDto
object
Mandatory field: The top part Customer The customer who issued the payment.
2 properties
referenceNumberInPaymentUpdateDto
object
The top part Ref. no Reference number for the document. Can be used when manual numbering is enabled.
1 property
writeOffReasonCodeInPaymentLineDto
object
Write-off reason code A reason code that defines an account and subaccount to be used for writing off credits or balances.
2 properties
DtoValueOfCustomerDocumentTypes
object
1 property
OrderToApplyDto
object
This class represents an OrderToApply in Payments
14 properties
paymentRefInPaymentUpdateDto
object
Mandatory field: The top part Payment ref. A secondary payment reference identifier, which can be a system-generated number or an external reference number ent…
1 property
DtoValueOfString
object
1 property
ReleasePaymentActionDto
object
1 property
financialDetailsInPaymentDto
object
Financial Details
1 property
cashAccountInPaymentUpdateDto
object
Mandatory field: The top part Cash account The default cash account associated with the payment method.
1 property
DtoValueOfDecimal
object
1 property
VoidPaymentActionDto
object
2 properties
locationInPaymentUpdateDto
object
Mandatory field: The top part Location The customer location associated with the sale. Once the customer is selected, this field displays the customer's defaul…
1 property
paymentAmountInPaymentUpdateDto
object
The top part Payment amount The total of the documents to which payment is to be applied.
1 property
customerInPaymentUpdateDto
object
Mandatory field: The top part Customer The customer who issued the payment.
1 property
currencyInPaymentUpdateDto
object
The top part Currency The currency of the payment document. Once the customer is selected, the system inserts the customer's default currency.
1 property
BackgroundApiAcceptedDto
object
2 properties
invoiceTextInPaymentUpdateDto
object
The top part Invoice text A user-defined description of the payment.
1 property
PaymentLinesUpdateDto
object
8 properties
VoidPaymentActionResultDto
object
6 properties
applicationPeriodInPaymentUpdateDto
object
Mandatory field: The top part Financial period The financial period to which the payment should be applied, which the system fills in based on the date.
1 property
DtoValueOfInt32
object
1 property
PaymentUpdateDto
object
18 properties
locationInPaymentDto
object
Mandatory field: The top part Location The customer location associated with the sale.
3 properties
FinanceChargesUpdateDto
object
7 properties
MetadataDto
object
2 properties
PaymentDto
object
This class represents a Payment in PaymentController. Used by getting data.
30 properties
holdInPaymentUpdateDto
object
The top part Hold A check box that indicates (if selected) that the document is a draft with the On hold status.
1 property
PaymentOrdersLinesUpdateDto
object
4 properties
ReleasePaymentActionResultDto
object
3 properties
applicationDateInPaymentUpdateDto
object
Mandatory field: The top part Date The date when a payment is applied to a document (invoice or note). The current business date for unapplied or partially app…
1 property
DtoValueOfBoolean
object
1 property
PaymentLineDto
object
16 properties
DtoValueOfNullableOfPaymentTypes
object
1 property
typeInPaymentUpdateDto
object
The top part Type The type of a document: Payment, Credit note, Prepayment, Customer refund, Void payment, Balance write-off.
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Visma Payment API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
