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 — Gateway Experience API

The DPP Gateway Experience API is the core Deluxe Payments Platform contract: 37 operations across payments (sale, authorize, complete, cancel, search, batch), EMV card-present processing and device management, refunds, subscriptions, payment methods and tokenization, customers and the vault, settlement batches, payment links, and webhook event subscription. Secured with an OAuth 2.0 bearer token plus a required partnerToken merchant header. Business failures are returned as HTTP 200 with a non-zero responseCode rather than a 4xx.

Deluxe Payments Platform — Gateway 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, Card Processing, ACH, EMV, and Tokenization. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 37 operations across 33 paths, organized into 9 resource areas. 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.

37 operations 33 paths 0 schemas 3 DELETE6 GET3 PATCH25 POST

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
9

Authentication & Security 2

Deluxe Payments Platform — Gateway 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 37

Across 33 paths, the API surfaces 37 operations — 3 DELETE, 6 GET, 3 PATCH, 25 POST. They span 9 resource areas: payments, emv, refunds, subscriptions, paymentmethods, customers, batches, paymentlinks, events. Each is listed below with its method, path, parameters, and response codes.

payments 6
POST
/payments
Create Payment
createPayment body → 200401403
POST
/payments/cancel
Cancel Payment
cancelPayment body → 200401403
POST
/payments/authorize
Authorize Payment
authorizePayment body → 200401403
POST
/payments/complete
Complete Payment
completePayment body → 200401403
POST
/payments/search
Search Payments
searchPayments body → 200401403
POST
/payments/batch
Create Batch Payments
createBatchPayments body → 200401403
emv 5
POST
/emv/payment
EMV Payments
emvPayments body → 200401403
POST
/emv/refund
EMV Refunds
emvRefunds body → 200401403
GET
/emv/devices
EMV Devices List
emvDevicesList → 200401403
POST
/emv/devices/{deviceId}/refresh
EMV Device Refresh By Id
emvDeviceRefreshById 1 param body → 200401403
GET
/emv/devicedetails/{deviceId}
EMV Device Details By Id
emvDeviceDetailsById 1 param → 200401403
refunds 2
POST
/refunds
Create Refund
createRefund body → 200401403
POST
/refunds/batch
Create Batch Refunds
createBatchRefunds body → 200401403
subscriptions 2
POST
/subscriptions
Create Subscription
createSubscription body → 200401403
PATCH
/subscriptions/{subscriptionId}
Modify Subscription
modifySubscription 3 params body → 200401403
paymentmethods 7
POST
/paymentmethods
Create Payment Method
createPaymentMethod body → 200401403
PATCH
/paymentmethods/{paymentMethodId}
Modify Payment Method
modifyPaymentMethod 3 params body → 200401403
POST
/paymentmethods/token
Generate Token
generateToken body → 200401403
POST
/paymentmethods/avs
Verify Address
verifyAddress body → 200401403
POST
/paymentmethods/verification/ach
Verify ACH
verifyAch body → 200401403
POST
/paymentmethods/surcharge
Check Surcharge
checkSurcharge body → 200401403
GET
/paymentmethods/binlookup
BIN Lookup
binLookup 3 params → 200401403
customers 7
POST
/customers
Create Customer
createCustomer body → 200401403
GET
/customers
Get All Customers
getAllCustomers → 200401403
PATCH
/customers/{customerId}
Modify Specific Customer
modifySpecificCustomer 1 param body → 200401403
GET
/customers/{customerId}
Get Specific Customer
getSpecificCustomer 1 param → 200401403
DELETE
/customers/{customerId}
Delete Specific Customer
deleteSpecificCustomer 1 param → 200401403
GET
/customers/{customerId}/paymentmethods/{paymentMethodId}
Get Customer's Payment Method
getCustomerSPaymentMethod 4 params → 200401403
DELETE
/customers/{customerId}/paymentmethods/{paymentMethodId}
Delete Customer's Payment Method
deleteCustomerSPaymentMethod 3 params → 200401403
batches 1
POST
/batches
Close Batch
closeBatch body → 200401403
paymentlinks 2
POST
/paymentlinks
Create Payment Link
createPaymentLink body → 200401403
DELETE
/paymentlinks/{paymentLinkId}
Delete Payment Link
deletePaymentLink 1 param → 200401403
events 5
POST
/events/subscribe
Subscribe Event
subscribeEvent body → 200401403
POST
/events/unsubscribe
Unsubscribe Event
unsubscribeEvent body → 200401403
POST
/events/resend
Resend Event
resendEvent body → 200401403
POST
/events/report
Retrieve Events Reports
retrieveEventsReports 2 params body → 200401403
POST
/events/performTest
Perform Test Event
performTestEvent body → 200401403

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deluxe-dpp-gateway-openapi.yml Raw ↑

Other APIs Deluxe Corporation publishes across the network.

Deluxe Payments Platform — Reports Experience API
Deluxe Payments Platform — Invoice 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 — Gateway 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.