{"items":[{"type":"link","fsPath":"products/deluxe-payment-network/api/get-started.md","metadata":{"type":"markdown"},"label":"Get Started","link":"/products/deluxe-payment-network/api/get-started","routeSlug":"/products/deluxe-payment-network/api/get-started"},{"type":"link","label":"Payables DPN API","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"},{"type":"link","label":"Introduction","link":"/products/deluxe-payment-network/api/dpn-api/openapi/section/introduction","routeSlug":"/products/deluxe-payment-network/api/dpn-api/openapi/section/introduction","version":"v2.0.0","isDefault":true,"versionFolderId":"1a2aa23d"},{"type":"group","label":"Payments","link":"/products/deluxe-payment-network/api/dpn-api/openapi/payments","routeSlug":"/products/deluxe-payment-network/api/dpn-api/openapi/payments","items":[{"label":"Payment File Upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/deluxe-payment-network/api/dpn-api/openapi/payments/paymentfileupload","routeSlug":"/products/deluxe-payment-network/api/dpn-api/openapi/payments/paymentfileupload","metadata":{"seo":{"title":"Payment File Upload","description":"Submits a batch of payments as a single CSV file for processing by DPN. This endpoint serves as the entry point for all payment workflows, including daily disbursement runs, ad-hoc payouts, scheduled vendor payment cycles, and other batch payment activities. The response returns a unique tracking number (fileguid), which serves as the sole identifier for all downstream status and reconciliation requests. Persist the fileguid securely on the caller side immediately upon receiving the response."}},"httpPath":"/payment-files","version":"v2.0.0","isDefault":true,"versionFolderId":"1a2aa23d"},{"label":"Fetch Payment File Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/deluxe-payment-network/api/dpn-api/openapi/payments/fetchpaymentfilestatus","routeSlug":"/products/deluxe-payment-network/api/dpn-api/openapi/payments/fetchpaymentfilestatus","metadata":{"seo":{"title":"Fetch Payment File Status","description":"Retrieves the aggregate processing status of a previously uploaded payment file, including total record count, counts of completed and failed records, and the current file-level status. Use this endpoint to monitor a submitted batch through its lifecycle without pulling per-record detail; it is typically invoked on a polling cadence until the file reaches a terminal state."}},"httpPath":"/payment-files/{file_guid}","version":"v2.0.0","isDefault":true,"versionFolderId":"1a2aa23d"},{"label":"Fetch Payment Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/deluxe-payment-network/api/dpn-api/openapi/payments/fetchpaymentstatus","routeSlug":"/products/deluxe-payment-network/api/dpn-api/openapi/payments/fetchpaymentstatus","metadata":{"seo":{"title":"Fetch Payment Status","description":"Retrieves the per-record processing status of every payment contained in a previously uploaded file. This is the primary reconciliation surface and the source of truth for which individual payments succeeded, which failed, and why. Use it to match DPN results back to internal records, surface errors for remediation, drive payee notifications, and feed downstream systems such as general ledger or audit logs."}},"httpPath":"/payment-files/{file_guid}/payments","version":"v2.0.0","isDefault":true,"versionFolderId":"1a2aa23d"},{"label":"Fetch Single Payment Status By paymentGuid","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/deluxe-payment-network/api/dpn-api/openapi/payments/fetchsinglepaymentstatusbypaymentguid","routeSlug":"/products/deluxe-payment-network/api/dpn-api/openapi/payments/fetchsinglepaymentstatusbypaymentguid","metadata":{"seo":{"title":"Fetch Single Payment Status By paymentGuid","description":"Retrieves the aggregate processing status of a previously uploaded payment file, including total record count, counts of completed and failed records, and the current file-level status. Use this endpoint to monitor a submitted batch through its lifecycle without pulling per-record detail; it is typically invoked on a polling cadence until the file reaches a terminal state."}},"httpPath":"/payment-files/{file_guid}/payments/{paymentGuid}","version":"v2.0.0","isDefault":true,"versionFolderId":"1a2aa23d"}],"version":"v2.0.0","isDefault":true,"versionFolderId":"1a2aa23d"},{"type":"group","fsPath":"products/deluxe-payment-network/api/payables-ddn/@v2.0.0/openapi.json","link":"/products/deluxe-payment-network/api/payables-ddn/openapi","routeSlug":"/products/deluxe-payment-network/api/payables-ddn/openapi","label":"Lockbox","items":[{"type":"link","label":"Introduction","link":"/products/deluxe-payment-network/api/payables-ddn/openapi/section/introduction","routeSlug":"/products/deluxe-payment-network/api/payables-ddn/openapi/section/introduction","version":"v2.0.0","isDefault":true,"versionFolderId":"bddec8ed"},{"label":"Fetch Lockbox Directory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/deluxe-payment-network/api/payables-ddn/openapi/other/fetchlockboxdirectory","routeSlug":"/products/deluxe-payment-network/api/payables-ddn/openapi/other/fetchlockboxdirectory","metadata":{"seo":{"title":"Fetch Lockbox Directory","description":"Retrieves the catalog of valid lockbox destinations known to DPN, paginated. Use this endpoint to pre-validate or pre-match payee destinations before submitting a payment file, at payee onboarding time to anchor a payee to a known lockbox, and on a periodic schedule (weekly or on demand) to keep a cached copy fresh. Unlike the other DPN endpoints, this endpoint authenticates through an issued apiKey and operates on a separate rate-limit budget."}},"httpPath":"/lockbox","version":"v2.0.0","isDefault":true,"versionFolderId":"bddec8ed"}],"metadata":{"redocly_category":"API Reference","page_type":"API Reference","api":"Lockbox","type":"openapi","title":"Lockbox","version":"","description":"## Introduction \nThe Lockbox API provides paginated access to the Deluxe Lockbox Directory, a centralized repository of valid lockbox destinations used by the Deluxe Payment Network (DPN). Use the API to retrieve, search, and validate lockbox information for payee onboarding, payment routing, and destination verification workflows. Regular synchronization with the directory helps ensure that payment files reference current lockbox information and reduces failures caused by stale destination data.\n"},"version":"v2.0.0","isDefault":true,"versionFolderId":"bddec8ed"}]}