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

Vic.ai Payment Confirmations API

Confirm or mark payments as failed after processing in your ERP.

Vic.ai Payment Confirmations API is one of 33 APIs that Vic.ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 8 operations across 8 paths, and defines 24 schemas. It is described by OpenAPI 3.1.0, at version v10.40.4.

Requests are made against 3 base URLs: https://api.no.stage.vic.ai, https://api.us.vic.ai, https://api.no.vic.ai.

8 operations 8 paths 24 schemas 8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v10.40.4
Base URL
https://api.us.vic.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Vic.ai Payment Confirmations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 8 POST. Each is listed below with its method, path, parameters, and response codes.

Payment Confirmations 8

Confirm or mark payments as failed after processing in your ERP.

POST
/v0/payments/{id}/confirm
Confirm a payment
confirmPayment 1 param body → 2004034044224294XX
POST
/v0/payments/confirm
Bulk confirm payments
bulkConfirmPayments body → 2004034044224294XX
POST
/v0/payments/{id}/fail
Mark payment as failed
failPayment 1 param body → 2004034044224294XX
POST
/v0/payments/fail
Bulk fail payments
bulkFailPayments body → 2004034044224294XX
POST
/v2/companies/{company_id}/payments/{id}/confirm
Confirm a payment
confirmPaymentV2 2 params body → 2004034044224XX
POST
/v2/companies/{company_id}/payments/confirm
Bulk confirm payments
bulkConfirmPaymentsV2 1 param body → 2004034044224XX
POST
/v2/companies/{company_id}/payments/{id}/fail
Mark payment as failed
failPaymentV2 2 params body → 2004034044224XX
POST
/v2/companies/{company_id}/payments/fail
Bulk fail payments
bulkFailPaymentsV2 1 param body → 2004034044224XX

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are Payment (25 properties), PaymentV2 (23 properties), InvoiceRef (3 properties), FailPaymentInputV2 (3 properties). Each schema is shown below with its type and property counts.

Payment
object
The payment made for an Invoice. The Account assigned to the payment is where the funds are being debited from.
25 properties
PaymentMethod
string
FailPaymentInputV2
object
Input schema for marking a payment as failed (V2 API with snakecase fields).
3 properties 2 required
BulkFailPaymentsInput
object
Input schema for bulk failing multiple payments.
1 property 1 required
BulkFailPaymentsInputV2
object
Input schema for bulk failing multiple payments (V2 API with snakecase fields).
1 property 1 required
BulkConfirmPaymentsInput
object
Input schema for bulk confirming multiple payments.
1 property 1 required
PaymentStatus
string
The status of the payment. - pendingapproval - The payment is awaiting approval. - approved - The payment was approved for payment. - rejected - The payment wa…
PaymentV2
object
A payment in the V2 API format with snakecase field names.
23 properties
ErrorV2
object
2 properties 1 required
BulkConfirmPaymentsInputV2
object
Input schema for bulk confirming multiple payments (V2 API with snakecase fields).
1 property 1 required
ConfirmPaymentInputV2
object
Input schema for confirming a payment (V2 API with snakecase fields).
2 properties 1 required
VendorRef
object
A reference to a Vendor.
2 properties
ExternalId
string
The external id set by the ERP system. It does not have to be a UUID and can be any non empty string desired.
InvoiceInternalId
string
The id of the Invoice in Vic.
Currency
string
The ISO-4217 currency code.
PaymentReferenceId
string
The reference id of the payment or credit is associated with. This will be the identifier is on the remittance advice sent to the Vendor. Example: P001234, A00…
VendorInternalId
string
The id of the Vendor in Vic.
ErrorString
string
Error
object
generic error message in JSON format. Note the 'code' field should match the HTTP status code of the wrapping HTTP request.
2 properties 2 required
InvoiceRef
object
A reference to an Invoice.
3 properties
MonetaryValue
string
The monetary value as a string. A float should not be used. The api will accept a float and it will be transformed into a monetary value, but for best results…
CostAccountRef
object
A reference to a Account.
2 properties
ConfirmPaymentInput
object
Input schema for confirming a payment.
2 properties 1 required
FailPaymentInput
object
Input schema for marking a payment as failed.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vicai-payment-confirmations-api-openapi.yml Raw ↑

Other APIs Vic.ai publishes across the network.

Vic.ai Accounts API
Vic.ai Allowed Senders API
Vic.ai Attachments API
Vic.ai Authentication API
Vic.ai Beta Features API
Vic.ai Bills API
Vic.ai Companies API
Vic.ai Company Settings API
Vic.ai Credit Confirmations API
Vic.ai CSV Reports API
Vic.ai Dimensions API
Vic.ai Email Endpoints API
Where this information came from

This is an independent, third-party profile of Vic.ai Payment Confirmations 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.