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

Deluxe Payments Platform — Invoice Experience API

The DPP Invoice Experience API publishes eleven operations for merchant invoicing — create a draft, modify invoice details, modify invoice status, retrieve, search, share, clone and download an invoice, plus create, read and modify the merchant's invoice configuration. Invoices carry the same customerId and paymentId identifier space as the Gateway Experience API.

Deluxe Payments Platform — Invoice Experience API is one of 4 APIs that Deluxe Corporation publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments, Invoicing, and Accounts Receivable. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 11 operations across 8 paths. It is described by OpenAPI 3.1.0, at version 1.

Requests are made against 3 base URLs: https://api.deluxe.com/dpp/v1, https://api.deluxe.com/dpp/v1/gateway, https://sandbox.api.deluxe.com/dpp/v1.

11 operations 8 paths 0 schemas 3 GET1 PATCH5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1
Base URL
https://api.deluxe.com/dpp/v1
Authentication
HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 2

Deluxe Payments Platform — Invoice Experience API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • bearerAuth — This API supports OpenID Connect OAuth 2.0 for authenticating all API requests. Bearer tokens are obtained from the Deluxe security service token endpoint usin…
  • basicAuth — This API supports Anypoint's Client ID Enforcement authentication policy.

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 3 GET, 1 PATCH, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

invoices 11
POST
/invoices
Create Draft Invoice
createDraftInvoice 2 params body → 200401403
PUT
/invoices/{invoiceId}
Modify Invoice Details
modifyInvoiceDetails 3 params body → 200401403
PATCH
/invoices/{invoiceId}
Modify Invoice Status
modifyInvoiceStatus 3 params body → 200401403
GET
/invoices/{invoiceId}
Get Specific Invoice
getSpecificInvoice 3 params → 200401403
POST
/invoices/search
Search Invoice
searchInvoice 2 params body → 200401403
POST
/invoices/share
Share Invoice
shareInvoice 2 params body → 200401403
POST
/invoices/clone
Clone Invoice
cloneInvoice 2 params body → 200401403
GET
/invoices/download/{invoiceId}
Download Invoice
downloadInvoice 3 params → 200401403
POST
/invoices/configuration
Create Invoice Configuration
createInvoiceConfiguration 2 params body → 200401403
GET
/invoices/configuration
Get Invoice Configuration
getInvoiceConfiguration 2 params → 200401403
PUT
/invoices/configuration/{configurationId}
Modify Invoice Configuration
modifyInvoiceConfiguration 3 params body → 200401403

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deluxe-dpp-invoices-openapi.yml Raw ↑

Other APIs Deluxe Corporation publishes across the network.

Deluxe Payments Platform — Gateway Experience API
Deluxe Payments Platform — Reports Experience API
Deluxe Payments Platform — Sandbox API (Deluxe-published OpenAPI)
Where this information came from

This is an independent, third-party profile of Deluxe Payments Platform — Invoice Experience 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.