How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bancomat Documents API

CRUD operations on documents

Bancomat Documents API is one of 30 APIs that Bancomat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 16 operations across 10 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0-alpha.4.

Requests are made against 4 base URLs: https://api.flowpay.it/v2, https://mock.flowpay.it/v2, https://sandbox.{customerID}.flowpay.it/v2, http://localhost:5002.

16 operations 10 paths 14 schemas 2 DELETE9 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0-alpha.4
Base URL
https://app.flowpay.it/api
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Bancomat Documents API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oAuth2) using the authorizationCode and clientCredentials flows, exposing 15 scopes.

  • oAuth2 — OAuth2 flow

Paths & Operations 16

Across 10 paths, the API surfaces 16 operations — 2 DELETE, 9 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 16

CRUD operations on documents

POST
/creditNotes
Create credit note
createCreditNote body → 201400401403404500
GET
/creditNotes
List credit notes
getCreditNotes 4 params → 200400401403500
GET
/creditNotes/{fingerprint}
Get credit note details
getCreditNote 1 param → 200400401403404500
DELETE
/creditNotes/{fingerprint}
Delete credit note
deleteCreditNote 1 param → 204400401403404500
POST
/invoices
Create invoice
createInvoice body → 201400401403500
GET
/invoices
List invoices
getInvoices 5 params → 200400401403500
GET
/invoices/{fingerprint}
Get invoice details
getInvoice 1 param → 200400401403404500
POST
/pagopa
pagoPA payment
pagopaPayment body → 200400401403500
GET
/pagopa
pagoPA list
getPagopaList 5 params → 200400401403500
GET
/pagopa/{fingerprint}
Get pagoPA details
getPagopaDetails 1 param → 200400401403404500
GET
/pagopa/{fingerprint}/receipt
Get pagoPA receipt
getPagopaReceipt 1 param → 200400401403404500
POST
/proforma
Create proforma invoice
createProformaInvoice body → 201400401403409500
GET
/proforma
List proforma invoices
getProformaInvoices 2 params → 200400401403500
GET
/proforma/{fingerprint}
Get proforma details
getProformaInvoice 1 param → 200400401403404500
DELETE
/proforma/{fingerprint}
Delete proforma invoice
deleteProformaInvoice 1 param → 204400401403404500
POST
/transfers
Create transfer
createTransfer body → 201400401403500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Invoice (14 properties), Transfer (7 properties), pagoPA (6 properties), DocumentItem (6 properties). Each schema is shown below with its type and property counts.

DocumentAttachment
object
Attachment of the document.
3 properties 2 required
pagoPA
object
PagoPA payment information
6 properties 6 required
PaginatedResult
object
4 properties
Contact
object
3 properties
Transfer
object
Kind of document that allow clients to manage payment requests with low constraints. Clients can use transfers to fast prototyping payment initiation use cases…
7 properties
CompanyVATNumber
string
VAT number of the company, full european format
StatusCode
integer
HTTP status code
Invoice
object
Document representing an invoice at any stage.
14 properties 9 required
RequestID
string
Unique identifier of the request. It is helpful to identify the request in case of errors, providing it to the support team. Please submit it in the support ti…
DocumentItem
object
Billing item. This is used only for UX and utility purposes and will not be used for the payment process.
6 properties 3 required
DocumentTerm
object
A payment term of the document, it will be used to generate the payment schedule.
5 properties 3 required
pagoPAStatus
string
{'$ref': 'docs/pagopastatus.md'}
ConsumerNationalID
string
National ID of the consumer, currently only italian format is supported
Fingerprint
string
Fingerprint of the document

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bancomat-documents-api-openapi.yml Raw ↑

Other APIs Bancomat publishes across the network.

BANCOMAT Pay
Bancomat Accounts API
Bancomat AIS Service API
Bancomat Authentication API
Bancomat Banche API
Bancomat Banks API
Bancomat Bulk API
Bancomat Chain API
Bancomat Checkout API
Bancomat Consent API
Bancomat Construction API
Bancomat Constructions API
Where this information came from

This is an independent, third-party profile of Bancomat Documents 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.