{"removeAttribution":true,"removeConsoleAttribution":true,"l10n":{"translations":{"default_locale":{"translation":{"search.error.title":"Oops! Something went wrong.","search.error.button":"Try again","search.ai.error.header":"Oops! Something went wrong.","search.ai.error.description":"We encountered an issue while processing your search. Please try again later or refine your query. If the problem persists, please contact the Deluxe Support Team.","search.ai.error.header.forbidden":"Feature Unavailable","search.ai.error.description.forbidden":"AI Search is currently unavailable.","search.ai.error.header.unauthorized":"Authentication Required","search.ai.error.description.unauthorized":"You are not authorized to use AI Search.","navbar.products":"Platforms","mobileMenu.products":"Platforms"}}},"defaultLocale":"default_locale","locales":[{"code":"default_locale","name":"default_locale"}]},"logo":{"image":"/assets/deluxe-logo.167041e9341bf8cfbdd6bd895fce71fe67b609be694df327977c562e367c108d.9c1bb791.svg","altText":"Developer Portal","link":"/","favicon":"/assets/favicon-16x16.9fba870d92b997a29492011189fd372c5445fc5dbf405726a3066f524359de47.9c1bb791.png"},"products":{"merchant-services":{"name":"Merchant Services","folder":"products/merchant-services","slug":"/products/merchant-services/","link":"/products/merchant-services","configOverride":{"navbar":{"items":[{"type":"group","label":"Payments","items":[{"type":"link","fsPath":"products/merchant-services/payments/overview.md","metadata":{"redocly_category":"Payments","page_type":"Overview","type":"markdown"},"label":"Overview","link":"/products/merchant-services/payments/overview","routeSlug":"/products/merchant-services/payments/overview"},{"type":"link","fsPath":"products/merchant-services/payments/accept-payments/overview.md","metadata":{"page_type":"Overview","type":"markdown"},"label":"Accept Payments","link":"/products/merchant-services/payments/accept-payments/overview","routeSlug":"/products/merchant-services/payments/accept-payments/overview"},{"type":"link","fsPath":"products/merchant-services/payments/process-payments/overview.md","metadata":{"redocly_category":"Payments","page_type":"Overview","type":"markdown"},"label":"Process Payments","link":"/products/merchant-services/payments/process-payments/overview","routeSlug":"/products/merchant-services/payments/process-payments/overview"},{"type":"link","fsPath":"products/merchant-services/payments/manage-payments/reporting-reconciliation.md","metadata":{"redocly_category":"Payments","page_type":"Guide","api":"Merchant Services","content_domain":"Reporting & Reconciliation","type":"markdown"},"label":"Manage Payments","link":"/products/merchant-services/payments/manage-payments/reporting-reconciliation","routeSlug":"/products/merchant-services/payments/manage-payments/reporting-reconciliation"}]},{"type":"group","label":"Deluxe for Platforms","items":[{"type":"link","fsPath":"products/merchant-services/platforms/get-started.md","metadata":{"redocly_category":"Platforms","page_type":"Getting Started","content_domain":"Getting Started & First Integration","type":"markdown"},"label":"Get Started","link":"/products/merchant-services/platforms/get-started","routeSlug":"/products/merchant-services/platforms/get-started"},{"type":"link","fsPath":"products/merchant-services/platforms/platform-services/merchant-onboarding.md","metadata":{"redocly_category":"Platforms","page_type":"Getting Started","api":"Merchant onboarding","content_domain":"Merchant Onboarding & Boarding","type":"markdown"},"label":"Platform Services","link":"/products/merchant-services/platforms/platform-services/merchant-onboarding","routeSlug":"/products/merchant-services/platforms/platform-services/merchant-onboarding"},{"type":"link","fsPath":"products/merchant-services/platforms/testing-certification/validation-requirements.md","metadata":{"redocly_category":"Platforms","page_type":"Guide","content_domain":"Testing & Certification","type":"markdown"},"label":"Testing & Validation","link":"/products/merchant-services/platforms/testing-certification/validation-requirements","routeSlug":"/products/merchant-services/platforms/testing-certification/validation-requirements"},{"type":"link","fsPath":"products/merchant-services/platforms/go-live/go-live-checklist.md","metadata":{"redocly_category":"Platforms","page_type":"Guide","content_domain":"Go-Live & Production Cutover","type":"markdown"},"label":"Go Live","link":"/products/merchant-services/platforms/go-live/go-live-checklist","routeSlug":"/products/merchant-services/platforms/go-live/go-live-checklist"},{"type":"link","fsPath":"products/merchant-services/platforms/partner-resources/support.md","metadata":{"redocly_category":"Platforms","page_type":"Support","content_domain":"Support & Contact","type":"markdown"},"label":"Partner Resources","link":"/products/merchant-services/platforms/partner-resources/support","routeSlug":"/products/merchant-services/platforms/partner-resources/support"}]},{"type":"group","label":"Developer Resources","items":[{"type":"link","fsPath":"products/merchant-services/developer-resources/dlx-docs-mcp.md","metadata":{"redocly_category":"Developer Resources","page_type":"Guide","content_domain":"Developer Tools","type":"markdown"},"label":"MCP Server","link":"/products/merchant-services/developer-resources/dlx-docs-mcp","routeSlug":"/products/merchant-services/developer-resources/dlx-docs-mcp"},{"type":"link","fsPath":"products/merchant-services/developer-resources/developer-guide/overview.md","metadata":{"redocly_category":"Developer Resources","page_type":"Overview","content_domain":"Getting Started & First Integration","type":"markdown"},"label":"Developer Guide","link":"/products/merchant-services/developer-resources/developer-guide/overview","routeSlug":"/products/merchant-services/developer-resources/developer-guide/overview"},{"type":"link","fsPath":"products/merchant-services/developer-resources/coast-demo.page.tsx","metadata":{"redocly_category":"Developer Resources"},"label":"Demos","link":"/products/merchant-services/developer-resources/coast-demo","routeSlug":"/products/merchant-services/developer-resources/coast-demo"},{"type":"link","fsPath":"products/merchant-services/developer-resources/developer-guide/integration-guides.md","metadata":{"redocly_category":"Developer Resources","content_domain":"Developer Tools","type":"markdown"},"label":"Integration Guides","link":"/products/merchant-services/developer-resources/developer-guide/integration-guides","routeSlug":"/products/merchant-services/developer-resources/developer-guide/integration-guides"},{"type":"link","fsPath":"products/merchant-services/developer-resources/testing/testing.md","metadata":{"redocly_category":"Developer Resources","page_type":"Guide","content_domain":"Sandbox & Test Data","type":"markdown"},"label":"Testing","link":"/products/merchant-services/developer-resources/testing/testing","routeSlug":"/products/merchant-services/developer-resources/testing/testing"},{"type":"link","fsPath":"products/merchant-services/developer-resources/error-handling/overview.md","metadata":{"redocly_category":"Developer Resources","page_type":"Reference","content_domain":"Error Codes & Troubleshooting","type":"markdown"},"label":"Error Handling","link":"/products/merchant-services/developer-resources/error-handling/overview","routeSlug":"/products/merchant-services/developer-resources/error-handling/overview"},{"type":"link","fsPath":"products/merchant-services/developer-resources/webhooks-events/overview.md","metadata":{"redocly_category":"Developer Resources","page_type":"Guide","api":"Merchant Services","content_domain":"Webhooks & Event Notifications","type":"markdown"},"label":"Webhooks & Events","link":"/products/merchant-services/developer-resources/webhooks-events/overview","routeSlug":"/products/merchant-services/developer-resources/webhooks-events/overview"},{"type":"link","fsPath":"products/merchant-services/developer-resources/developer-tools/postman.md","metadata":{"redocly_category":"Developer Resources","page_type":"Guide","content_domain":"Developer Tools","type":"markdown"},"label":"Developer Tools","link":"/products/merchant-services/developer-resources/developer-tools/postman","routeSlug":"/products/merchant-services/developer-resources/developer-tools/postman"},{"type":"link","fsPath":"products/merchant-services/changelog/index.md","metadata":{"redocly_category":"Release Notes","page_type":"Overview","content_domain":"Release Notes & API Changes","type":"markdown"},"label":"Changelog","link":"/products/merchant-services/changelog","routeSlug":"/products/merchant-services/changelog"}]},{"type":"link","fsPath":"products/merchant-services/api/get-started.md","metadata":{"redocly_category":"API Reference","page_type":"API Reference","api":"Platform","content_domain":"Getting Started & First Integration","type":"markdown"},"label":"API Reference","link":"/products/merchant-services/api/get-started","routeSlug":"/products/merchant-services/api/get-started"}]},"search":{"suggestedPages":[{"type":"link","fsPath":"products/merchant-services/developer-resources/developer-guide/overview.md","metadata":{"redocly_category":"Developer Resources","page_type":"Overview","content_domain":"Getting Started & First Integration","type":"markdown"},"label":"Developer Guide","link":"/products/merchant-services/developer-resources/developer-guide/overview","routeSlug":"/products/merchant-services/developer-resources/developer-guide/overview"},{"type":"link","fsPath":"products/merchant-services/developer-resources/developer-guide/authenticate.md","metadata":{"redocly_category":"Developer Resources","page_type":"Getting Started","api":"Platform","content_domain":"Authentication & API Credentials","type":"markdown"},"label":"Authenticate","link":"/products/merchant-services/developer-resources/developer-guide/authenticate","routeSlug":"/products/merchant-services/developer-resources/developer-guide/authenticate"},{"type":"link","fsPath":"products/merchant-services/developer-resources/developer-guide/integration-guides.md","metadata":{"redocly_category":"Developer Resources","content_domain":"Developer Tools","type":"markdown"},"label":"Integration Guides","link":"/products/merchant-services/developer-resources/developer-guide/integration-guides","routeSlug":"/products/merchant-services/developer-resources/developer-guide/integration-guides"},{"type":"link","fsPath":"products/merchant-services/platforms/get-started.md","metadata":{"redocly_category":"Platforms","page_type":"Getting Started","content_domain":"Getting Started & First Integration","type":"markdown"},"label":"Platform Get Started","link":"/products/merchant-services/platforms/get-started","routeSlug":"/products/merchant-services/platforms/get-started"},{"type":"link","fsPath":"products/merchant-services/developer-resources/coast-demo.page.tsx","metadata":{"redocly_category":"Developer Resources"},"label":"Demos","link":"/products/merchant-services/developer-resources/coast-demo","routeSlug":"/products/merchant-services/developer-resources/coast-demo"}]}}},"deluxe-payment-network":{"name":"Payment Network","folder":"products/deluxe-payment-network/","slug":"/products/deluxe-payment-network/","link":"/products/deluxe-payment-network","configOverride":{"navbar":{"items":[{"type":"group","label":"Payments","items":[{"type":"link","fsPath":"products/deluxe-payment-network/payments/index.md","metadata":{"redocly_category":"Payments","page_type":"Overview","type":"markdown"},"label":"Overview","link":"/products/deluxe-payment-network/payments","routeSlug":"/products/deluxe-payment-network/payments"},{"type":"link","fsPath":"products/deluxe-payment-network/payments/find-your-use-case.md","metadata":{"redocly_category":"Payments","page_type":"Getting Started","content_domain":"Getting Started & Integration Planning","type":"markdown"},"label":"Find Your Use Case","link":"/products/deluxe-payment-network/payments/find-your-use-case","routeSlug":"/products/deluxe-payment-network/payments/find-your-use-case"},{"type":"link","fsPath":"products/deluxe-payment-network/payments/about-apis.md","metadata":{"redocly_category":"Payments","page_type":"Reference","api":["DPN","Lockbox"],"content_domain":"API Selection & Capabilities","type":"markdown"},"label":"About APIs","link":"/products/deluxe-payment-network/payments/about-apis","routeSlug":"/products/deluxe-payment-network/payments/about-apis"},{"type":"link","fsPath":"products/deluxe-payment-network/payments/glossary.md","metadata":{"redocly_category":"Payments","page_type":"Reference","content_domain":"Payment Network Concepts","type":"markdown"},"label":"Glossary","link":"/products/deluxe-payment-network/payments/glossary","routeSlug":"/products/deluxe-payment-network/payments/glossary"}]},{"type":"group","label":"Build with Deluxe","items":[{"type":"link","fsPath":"products/deluxe-payment-network/build-with-deluxe/get-started.md","metadata":{"redocly_category":"Developer Resources","page_type":"Getting Started","content_domain":"Getting Started & Integration Planning","type":"markdown"},"label":"Get Started","link":"/products/deluxe-payment-network/build-with-deluxe/get-started","routeSlug":"/products/deluxe-payment-network/build-with-deluxe/get-started"},{"type":"link","fsPath":"products/deluxe-payment-network/build-with-deluxe/implementation-guide.md","metadata":{"redocly_category":"Developer Resources","page_type":"Guide","api":"DPN","content_domain":"Integration Planning & Go-Live","type":"markdown"},"label":"Plan Your Integration","link":"/products/deluxe-payment-network/build-with-deluxe/implementation-guide","routeSlug":"/products/deluxe-payment-network/build-with-deluxe/implementation-guide"},{"type":"link","fsPath":"products/deluxe-payment-network/build-with-deluxe/authenticate-guide.md","metadata":{"redocly_category":"Developer Resources","page_type":"Getting Started","content_domain":"Authentication & API Credentials","type":"markdown"},"label":"Setup Your Environment","link":"/products/deluxe-payment-network/build-with-deluxe/authenticate-guide","routeSlug":"/products/deluxe-payment-network/build-with-deluxe/authenticate-guide"},{"type":"link","fsPath":"products/deluxe-payment-network/build-with-deluxe/api-credentials.md","metadata":{"redocly_category":"Developer Resources","page_type":"Getting Started","content_domain":"Authentication & API Credentials","type":"markdown"},"label":"API Credentials","link":"/products/deluxe-payment-network/build-with-deluxe/api-credentials","routeSlug":"/products/deluxe-payment-network/build-with-deluxe/api-credentials"},{"type":"link","fsPath":"products/deluxe-payment-network/build-with-deluxe/testing.md","metadata":{"redocly_category":"Developer Resources","content_domain":"Sandbox & Test Data","type":"markdown"},"label":"Test Your Environment","link":"/products/deluxe-payment-network/build-with-deluxe/testing","routeSlug":"/products/deluxe-payment-network/build-with-deluxe/testing"},{"type":"link","fsPath":"products/deluxe-payment-network/build-with-deluxe/go-live-checklist.md","metadata":{"redocly_category":"Developer Resources","content_domain":"Go-Live & Production Cutover","type":"markdown"},"label":"Go-Live Checklist","link":"/products/deluxe-payment-network/build-with-deluxe/go-live-checklist","routeSlug":"/products/deluxe-payment-network/build-with-deluxe/go-live-checklist"}]},{"type":"group","label":"Developer Resources","items":[{"type":"link","fsPath":"products/deluxe-payment-network/developer-resources/sandbox-testing.md","metadata":{"redocly_category":"Developer Resources","content_domain":"Sandbox & Test Data","type":"markdown"},"label":"Sandbox & Testing","link":"/products/deluxe-payment-network/developer-resources/sandbox-testing","routeSlug":"/products/deluxe-payment-network/developer-resources/sandbox-testing"},{"type":"link","fsPath":"products/deluxe-payment-network/developer-resources/file-definitions.md","metadata":{"redocly_category":"Developer Resources","page_type":"Reference","type":"markdown"},"label":"File Definitions","link":"/products/deluxe-payment-network/developer-resources/file-definitions","routeSlug":"/products/deluxe-payment-network/developer-resources/file-definitions"},{"type":"link","fsPath":"products/deluxe-payment-network/developer-resources/payment-file-schema.md","metadata":{"redocly_category":"Developer Resources","page_type":"Reference","type":"markdown"},"label":"Payment File Schema","link":"/products/deluxe-payment-network/developer-resources/payment-file-schema","routeSlug":"/products/deluxe-payment-network/developer-resources/payment-file-schema"},{"type":"link","fsPath":"products/deluxe-payment-network/developer-resources/payment-statuses.md","metadata":{"redocly_category":"Developer Resources","page_type":"Reference","type":"markdown"},"label":"Payment Status","link":"/products/deluxe-payment-network/developer-resources/payment-statuses","routeSlug":"/products/deluxe-payment-network/developer-resources/payment-statuses"},{"type":"link","fsPath":"products/deluxe-payment-network/developer-resources/error-codes-messaging.md","metadata":{"redocly_category":"Developer Resources","page_type":"Reference","content_domain":"Errors & Troubleshooting","type":"markdown"},"label":"Error Codes & Messaging","link":"/products/deluxe-payment-network/developer-resources/error-codes-messaging","routeSlug":"/products/deluxe-payment-network/developer-resources/error-codes-messaging"},{"type":"link","fsPath":"products/deluxe-payment-network/developer-resources/postman.md","metadata":{"redocly_category":"Developer Resources","page_type":"Guide","api":"DPN","content_domain":"Payment File Processing","type":"markdown"},"label":"Postman","link":"/products/deluxe-payment-network/developer-resources/postman","routeSlug":"/products/deluxe-payment-network/developer-resources/postman"},{"type":"link","fsPath":"products/deluxe-payment-network/changelog/index.md","metadata":{"redocly_category":"Release Notes","page_type":"Overview","api":["DPN","Lockbox"],"content_domain":"Release Notes & API Changes","type":"markdown"},"label":"Changelog","link":"/products/deluxe-payment-network/changelog","routeSlug":"/products/deluxe-payment-network/changelog"},{"type":"link","fsPath":"products/deluxe-payment-network/developer-resources/support.md","metadata":{"redocly_category":"Developer Resources","page_type":"Support","content_domain":"Support & Contact","type":"markdown"},"label":"Get support","link":"/products/deluxe-payment-network/developer-resources/support","routeSlug":"/products/deluxe-payment-network/developer-resources/support"}]},{"type":"link","fsPath":"products/deluxe-payment-network/api/get-started.md","metadata":{"type":"markdown"},"label":"API Reference","link":"/products/deluxe-payment-network/api/get-started","routeSlug":"/products/deluxe-payment-network/api/get-started"}]},"search":{"suggestedPages":[{"type":"link","fsPath":"products/deluxe-payment-network/payments/find-your-use-case.md","metadata":{"redocly_category":"Payments","page_type":"Getting Started","content_domain":"Getting Started & Integration Planning","type":"markdown"},"label":"Find Your Use Case","link":"/products/deluxe-payment-network/payments/find-your-use-case","routeSlug":"/products/deluxe-payment-network/payments/find-your-use-case"},{"type":"link","fsPath":"products/deluxe-payment-network/build-with-deluxe/get-started.md","metadata":{"redocly_category":"Developer Resources","page_type":"Getting Started","content_domain":"Getting Started & Integration Planning","type":"markdown"},"label":"Get Started","link":"/products/deluxe-payment-network/build-with-deluxe/get-started","routeSlug":"/products/deluxe-payment-network/build-with-deluxe/get-started"},{"type":"link","fsPath":"products/deluxe-payment-network/build-with-deluxe/implementation-guide.md","metadata":{"redocly_category":"Developer Resources","page_type":"Guide","api":"DPN","content_domain":"Integration Planning & Go-Live","type":"markdown"},"label":"Implementation Guide","link":"/products/deluxe-payment-network/build-with-deluxe/implementation-guide","routeSlug":"/products/deluxe-payment-network/build-with-deluxe/implementation-guide"},{"type":"link","fsPath":"products/deluxe-payment-network/developer-resources/file-definitions.md","metadata":{"redocly_category":"Developer Resources","page_type":"Reference","type":"markdown"},"label":"File Definitions","link":"/products/deluxe-payment-network/developer-resources/file-definitions","routeSlug":"/products/deluxe-payment-network/developer-resources/file-definitions"},{"type":"link","fsPath":"products/deluxe-payment-network/api/dpn-api/@v2.0.0/openapi.json","metadata":{"redocly_category":"API Reference","page_type":"API Reference","api":"DPN","type":"openapi","title":"Payables DPN API","version":"","description":"## Introduction\nWelcome to Payables DPN Experience API. \nThe Deluxe Payment Network (DPN) API is organized around file-based payment processing. Submit a payment file containing one or more payment instructions, then use the returned file_guid to monitor file-level processing status and retrieve payment-level status for reconciliation, remediation, and downstream reporting.\n\nDPN provides a consistent API experience for payment intake, validation, fulfillment, status tracking, and payment lifecycle management across supported payment solutions.\n"},"label":"API Reference","link":"/products/deluxe-payment-network/api/dpn-api/openapi","routeSlug":"/products/deluxe-payment-network/api/dpn-api/openapi","version":"v2.0.0","isDefault":true,"versionFolderId":"1a2aa23d"}]}}}},"footer":{"copyrightText":"© 2026 Deluxe Corporation"},"links":[{"href":"https://fonts.googleapis.com","rel":"preconnect"},{"href":"https://fonts.gstatic.com","rel":"preconnect","crossorigin":"anonymous"},{"href":"https://fonts.googleapis.com/css2?family=Fira+Code:wght@300..700&display=swap","rel":"stylesheet"}],"search":{"engine":"typesense","shortcuts":["cmd+k","ctrl+k"],"filters":{"facets":[{"name":"Business Domain","field":"content_domain","type":"multi-select"},{"name":"Page Type","field":"page_type","type":"multi-select"},{"name":"API","field":"api","type":"multi-select"},{"name":"HTTP Method","field":"httpMethod","type":"tags"},{"name":"HTTP Path","field":"httpPath","type":"multi-select"},{"name":"API Title","field":"apiTitle","type":"multi-select"},{"name":"API Version","field":"apiVersion","type":"select"}]}},"aiAssistant":{"hide":false,"prompt":"You are the Deluxe developer integration assistant. Answer from the project documentation; if it does not provide an answer, say so. Identify the relevant product and API. For how-to questions, list prerequisites first, then give ordered steps and name the specific API, endpoint, or component used at each step. Cite the most relevant guide or API reference for that product. For Merchant Services payment-lifecycle questions, clarify that refunds, voids, status queries, and charging a saved card require the DPP Gateway REST API; a Hosted Payment Form or Embedded SDK cannot perform those actions alone. State any documented eligibility or timing constraints. For DPP Gateway REST requests, include the documented OAuth2 Bearer token and PartnerToken header. For DPN and other APIs, follow their own authentication documentation; do not apply Gateway requirements across products. An explicit product or API named in the latest user question takes precedence over the current page, prior conversation, search query, or selected search facets. Do not let inherited search filters constrain retrieval or citations when the latest question names a different product or API. For DPN payment-file submission, status, and error questions, use the Payables DPN API, not the Payables DDN/Lockbox API; use the latter only for lockbox-directory questions. Cite only sources that match the requested product/API and support the answer. If matching documentation is unavailable, say so rather than citing an adjacent API. Do not invent endpoints, fields, or response shapes.\n","suggestions":["Is Merchant Services right for my business (no code)?","How do I accept payments on my website?","Which integration method should I use (HPF vs Embedded vs API)?","How do I make my first API call?","How do I save a card and charge it later?","How do I set up recurring payments?","How do I refund or void a payment?","How do I get notified of payment status with webhooks?","How do I accept in-person / Tap to Pay payments?","What changed and how do I track deprecations?","How do I submit a DPN payment file, check its status, and retrieve errors?"],"trigger":{"hide":false,"inputType":"button","inputIcon":"sparkles"}},"colorMode":{"hide":true,"ignoreDetection":true,"modes":["light"]},"markdown":{"partialsFolders":["**/_partials/**"]},"openapi":{"hideDownloadButtons":false,"jsonSamplesExpandLevel":3,"codeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Java"},{"lang":"C#"},{"lang":"PHP"},{"lang":"Go"},{"lang":"Ruby"},{"lang":"Payload"}]}},"userMenu":{"hideLoginButton":true,"hide":false},"mcp":{"hide":false,"docs":{"hide":false,"name":"Deluxe Developer MCP Server","ignore":[]},"name":"Deluxe Developer MCP Server","ignore":[]},"breadcrumbs":{"prefixItems":[]},"auth":{"idpsInfo":[{"idpId":"oidc","type":"OIDC","title":"Reunite"}],"devLogin":false},"entitiesCatalog":{},"apiProducts":{},"mcpData":{"docs":{"enabled":true,"name":"Deluxe Developer MCP Server","publicEndpoint":false}},"searchFeatures":{"advanced":{"enabled":true},"ai":{"enabled":true}},"analytics":{"ga":{"trackingId":"","exclude":[],"trackers":{}}}}