{"items":[{"type":"link","label":"Lockbox","link":"/products/deluxe-payment-network/api/payables-ddn/openapi","routeSlug":"/products/deluxe-payment-network/api/payables-ddn/openapi","content":{"contentType":"overview","meta":{"name":"Lockbox"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/products/deluxe-payment-network/api/payables-ddn/@v2.0.0/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/products/deluxe-payment-network/api/payables-ddn/@v2.0.0/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/products/deluxe-payment-network/api/payables-ddn/openapi","description":"Mock server","isMockServer":true},{"url":"https://dcip.deluxe.com/payables/ddn/v1","description":"Production"},{"url":"https://stage.dcip.deluxe.com/payables/ddn/v1","description":"Sandbox"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Lockbox","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/"}],"sectionId":"/"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/introduction"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Introduction"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The 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."},"children":[],"type":"text"}],"type":"paragraph"}]}],"sectionId":"/section/introduction"}]}]}},{"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","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fetchLockboxDirectory","name":"Fetch Lockbox Directory","isWebhook":false,"pointer":"/paths/~1lockbox/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch Lockbox Directory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"securitySchemas.oidcEnforcement","scopes":[],"type":"oauth2","description":"This API supports OpenID Connect OAuth 2.0 for authenticating all API requests.\n","flows":{"clientCredentials":{"tokenUrl":"https://services.deluxe.com/oauth2/v2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"PageNumber","in":"query","schemaId":"schema_0","description":"1-based page index used to retrieve a specific page of the directory. Increment across successive calls to walk the full catalog, or use the URLs returned in the links array of a prior response.","example":1},{"name":"PageSize","in":"query","schemaId":"schema_0","description":"Number of lockbox records to return per page. Choose a value that balances round-trip volume against per-response payload size; the sample collection uses 20.","example":15},{"name":"IncludeInactive","in":"query","schemaId":"schema_1","description":"includes lockboxes with a status of Inactive in response.","example":true},{"name":"IncludeDeleted","in":"query","schemaId":"schema_1","description":"Includes lockboxes that have been soft-deleted in response.","example":false},{"name":"CustomerName","in":"query","schemaId":"schema_2","description":"Filter response to only include lockboxes belonging to the identified Customer.","example":"DPNTestCustomer"},{"name":"Location","in":"query","schemaId":"schema_2","description":"The Location that the lockbox which is being added belongs to.","example":"Chicago"},{"name":"SysId","in":"query","schemaId":"schema_2","description":"Filter response to only include lockboxes belonging to the identified System.","example":"IL"}],"pointer":"/paths/~1lockbox/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"apiKey","in":"header","schemaId":"schema_2","description":"Identifier issued by Deluxe during onboarding that authenticates the caller to the Deluxe Lockbox Directory (DDN) service. It is separate from the businessPartner used on the payment endpoints and must be treated as a sensitive secret. Rotate through your Account Manager if exposure is suspected.","required":true,"example":"d91ed346-924d-4b30-ba27-abbedb74fcv7"}],"pointer":"/paths/~1lockbox/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/lockbox","servers":[{"url":"/_mock/products/deluxe-payment-network/api/payables-ddn/openapi","description":"Mock server","isMockServer":true},{"url":"https://dcip.deluxe.com/payables/ddn/v1","description":"Production"},{"url":"https://stage.dcip.deluxe.com/payables/ddn/v1","description":"Sandbox"}],"parameters":{"path":[],"query":[{"name":"PageNumber","in":"query","required":false,"example":1,"schemaId":"schema_0"},{"name":"PageSize","in":"query","required":false,"example":15,"schemaId":"schema_0"},{"name":"IncludeInactive","in":"query","required":false,"example":true,"schemaId":"schema_1"},{"name":"IncludeDeleted","in":"query","required":false,"example":false,"schemaId":"schema_1"},{"name":"CustomerName","in":"query","required":false,"example":"DPNTestCustomer","schemaId":"schema_2"},{"name":"Location","in":"query","required":false,"example":"Chicago","schemaId":"schema_2"},{"name":"SysId","in":"query","required":false,"example":"IL","schemaId":"schema_2"}],"querystring":[],"header":[{"name":"apiKey","in":"header","required":true,"example":"d91ed346-924d-4b30-ba27-abbedb74fcv7","schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"securitySchemas.oidcEnforcement","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://services.deluxe.com/oauth2/v2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","406","408","415","429","500","501","503","504"],"pointer":"/lockbox","href":"other/fetchlockboxdirectory","openApiOperationId":"fetchLockboxDirectory","summary":"Fetch Lockbox Directory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/deluxe-payment-network/api/payables-ddn/openapi","description":"Mock server","isMockServer":true},{"url":"https://dcip.deluxe.com/payables/ddn/v1","description":"Production"},{"url":"https://stage.dcip.deluxe.com/payables/ddn/v1","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FetchLockboxDirectoryResponse"}},"schemaId":"components/schemas/FetchLockboxDirectoryResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_1"}},"schemaId":"components/schemas/Error_1"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1lockbox/get/responses/401/content/application~1json/example"]}},"schemaId":"schema_3","exampleIds":["paths/~1lockbox/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1lockbox/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_4","exampleIds":["paths/~1lockbox/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1lockbox/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_5","exampleIds":["paths/~1lockbox/get/responses/404/content/application~1json/example"]},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1lockbox/get/responses/405/content/application~1json/example"]}},"schemaId":"schema_6","exampleIds":["paths/~1lockbox/get/responses/405/content/application~1json/example"]},{"code":"406","description":"Not Acceptable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1lockbox/get/responses/406/content/application~1json/example"]}},"schemaId":"schema_7","exampleIds":["paths/~1lockbox/get/responses/406/content/application~1json/example"]},{"code":"408","description":"Connection Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8","exampleIds":["paths/~1lockbox/get/responses/408/content/application~1json/example"]}},"schemaId":"schema_8","exampleIds":["paths/~1lockbox/get/responses/408/content/application~1json/example"]},{"code":"415","description":"Unsupported Media Type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9","exampleIds":["paths/~1lockbox/get/responses/415/content/application~1json/example"]}},"schemaId":"schema_9","exampleIds":["paths/~1lockbox/get/responses/415/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10","exampleIds":["paths/~1lockbox/get/responses/429/content/application~1json/example"]}},"schemaId":"schema_10","exampleIds":["paths/~1lockbox/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11","exampleIds":["paths/~1lockbox/get/responses/500/content/application~1json/example"]}},"schemaId":"schema_11","exampleIds":["paths/~1lockbox/get/responses/500/content/application~1json/example"]},{"code":"501","description":"Not Implemented","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1lockbox/get/responses/501/content/application~1json/example"]}},"schemaId":"schema_12","exampleIds":["paths/~1lockbox/get/responses/501/content/application~1json/example"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1lockbox/get/responses/503/content/application~1json/example"]}},"schemaId":"schema_13","exampleIds":["paths/~1lockbox/get/responses/503/content/application~1json/example"]},{"code":"504","description":"Gateway Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14","exampleIds":["paths/~1lockbox/get/responses/504/content/application~1json/example"]}},"schemaId":"schema_14","exampleIds":["paths/~1lockbox/get/responses/504/content/application~1json/example"]}],"pointer":"/paths/~1lockbox/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FetchLockboxDirectoryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FetchLockboxDirectoryResponse"}}},{"code":"400","schemaId":"components/schemas/Error_1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_1"}}},{"code":"401","schemaId":"schema_3","exampleIds":["paths/~1lockbox/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1lockbox/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_4","exampleIds":["paths/~1lockbox/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1lockbox/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_5","exampleIds":["paths/~1lockbox/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1lockbox/get/responses/404/content/application~1json/example"]}}},{"code":"405","schemaId":"schema_6","exampleIds":["paths/~1lockbox/get/responses/405/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1lockbox/get/responses/405/content/application~1json/example"]}}},{"code":"406","schemaId":"schema_7","exampleIds":["paths/~1lockbox/get/responses/406/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1lockbox/get/responses/406/content/application~1json/example"]}}},{"code":"408","schemaId":"schema_8","exampleIds":["paths/~1lockbox/get/responses/408/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8","exampleIds":["paths/~1lockbox/get/responses/408/content/application~1json/example"]}}},{"code":"415","schemaId":"schema_9","exampleIds":["paths/~1lockbox/get/responses/415/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9","exampleIds":["paths/~1lockbox/get/responses/415/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_10","exampleIds":["paths/~1lockbox/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10","exampleIds":["paths/~1lockbox/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"schema_11","exampleIds":["paths/~1lockbox/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11","exampleIds":["paths/~1lockbox/get/responses/500/content/application~1json/example"]}}},{"code":"501","schemaId":"schema_12","exampleIds":["paths/~1lockbox/get/responses/501/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1lockbox/get/responses/501/content/application~1json/example"]}}},{"code":"503","schemaId":"schema_13","exampleIds":["paths/~1lockbox/get/responses/503/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1lockbox/get/responses/503/content/application~1json/example"]}}},{"code":"504","schemaId":"schema_14","exampleIds":["paths/~1lockbox/get/responses/504/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14","exampleIds":["paths/~1lockbox/get/responses/504/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/fetchlockboxdirectory"}],"panels":[]}]},"httpPath":"/lockbox"}],"store":{"schemaStore":{"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"description":"Standard API Error Response","x-amf-examples":{"amf_example_6":{"error":{"message":"Unauthorized","details":"You have issues accessing the system"}},"example_2":{"error":{"message":"Method Not Allowed","details":"Method not allowed"}},"example_7":{"error":{"message":"Insufficient Storage (WebDAV; RFC 4918)","details":"The server is unable to store the representation needed to complete the request."}},"example_8":{"error":{"message":"Loop Detected (WebDAV; RFC 5842)","details":"The server detected an infinite loop while processing the request (sent instead of 208 Already Reported)."}},"amf_example_1":{"error":{"message":"Forbidden","details":"You are not allowed to make this request"}},"example_1":{"error":{"message":"Not Found","details":"Resource not found"}},"amf_example_5":{"error":{"message":"Not Acceptable","details":"The API cannot provide the requested accepted response"}},"example_5":{"error":{"message":"Service Unavailable","details":"Unable to access the system at this time"}},"amf_example_2":{"error":{"message":"Variant Also Negotiates (RFC 2295)","details":"The server is unable to store the representation needed to complete the request."}},"amf_example_9":{"error":{"message":"Too Many Requests","details":"You have made too many requests to the server"}},"example_9":{"error":{"message":"Network Authentication Required (RFC 6585)","details":"Authentication failed."}},"example_4":{"error":{"message":"Internal Server Error","details":"Error with data transformation.  See log for details."}},"amf_example_4":{"error":{"message":"Not Extended (RFC 2774)","details":"Further extensions to the request are required for the server to fulfil it."}},"example_0":{"error":{"message":"Bad Request","details":"There was an issue with your request message"}},"amf_example_8":{"error":{"message":"Unsupported Media Type","details":"Media type not supported"}},"amf_example_3":{"error":{"message":"HTTP Version Not Supported","details":"The server does not support the HTTP protocol version used in the request."}},"example_6":{"error":{"message":"Gateway Timeout","details":"The server was acting as a gateway or proxy and did not receive a timely response from the upstream server."}},"example_3":{"error":{"message":"Connection Timeout","details":"The request to the server has been timed-out"}},"amf_example_7":{"error":{"message":"Not Implemented","details":"The operation has not been implemented"}}},"type":"object","required":["error"],"properties":{"error":{"description":"error object containing the details of the error.","type":"object","required":["message"],"properties":{"message":{"example":"Bad Request","type":"string"},"details":{"example":"There was an issue with your request message.","type":"string"}}}}}},"components/schemas/Error_1":{"id":"components/schemas/Error_1","kind":"json-schema","title":"Error_1","data":{"description":"Standard API Error Response","x-amf-examples":{"example_2":{"value":{"errors":{"message":"Bad Request","details":"Invalid value 'null' for query parameter SearchQuery. expected type: String, found: Null"},"error":{"message":"Bad Request","details":"There was an issue with your request message"}}},"amf_example_1":{"value":{"errors":{"message":"Bad Request","details":"Invalid value 'null' for query parameter SearchString. expected type: String, found: Null"},"error":{"message":"Bad Request","details":"There was an issue with your request message"}}},"example_1":{"errors":{"message":"Bad Request","details":{"Street1":["'Street1' is not in the correct format."],"Street2":["'Street2' is not in the correct format."],"City":["'City' is not in the correct format."],"State":["State does not match known state codes."],"Zip":["'Zip' is not in the correct format."],"Agreement":["'Agreement' is not in the correct format."],"MaxBatchSize":["'Max Batch Size' must be between 1 and 99999. You entered 99999999999."],"TaxId":["'Tax Id' is not in the correct format."],"BatchType":["'Batch Type' is not in the correct format."]}},"error":{"message":"Bad Request","details":"There was an issue with your request message"}},"amf_example_2":{"errors":{"message":"Bad Request","details":{"Payee":["'Payee Name' is not in the correct format"],"ExternalPayeeId":["A payee with this providerId already exists for this lockbox"]}},"error":{"message":"Bad Request","details":"There was an issue with your request message"}},"example_4":{"errors":{"message":"Bad Request","details":"Failed to delete payee. Check request and try again."},"error":{"message":"Bad Request","details":"There was an issue with your request message"}},"amf_example_4":{"errors":{"message":"Bad Request","details":{"Street1":["'Street1' is not in the correct format."],"Street2":["'Street2' is not in the correct format."],"City":["'City' is not in the correct format."],"State":["State does not match known state codes."],"Zip":["'Zip' is not in the correct format."],"Agreement":["'Agreement' is not in the correct format."],"MaxBatchSize":["'Max Batch Size' must be between 1 and 99999. You entered 99999999999."],"TaxId":["'Tax Id' is not in the correct format."]}},"error":{"message":"Bad Request","details":"There was an issue with your request message"}},"example_0":{"errors":{"message":"Bad Request","details":{"Street1":["'Street1' is not in the correct format."],"Street2":["'Street2' is not in the correct format."],"City":["'City' is not in the correct format."],"State":["State does not match known state codes."],"Zip":["'Zip' is not in the correct format."],"Agreement":["'Agreement' is not in the correct format."],"MaxBatchSize":["'Max Batch Size' must be between 1 and 99999. You entered 99999999999."],"TaxId":["'Tax Id' is not in the correct format."],"BatchType":["'Batch Type' is not in the correct format."]}},"error":{"message":"Bad Request","details":"There was an issue with your request message"}},"amf_example_3":{"errors":{"message":"Bad Request","details":"Cannot find lockbox to delete"},"error":{"message":"Bad Request","details":"There was an issue with your request message"}},"example_3":{"errors":{"message":"Bad Request","details":{"1.Payee":["'Payee Name' is not in the correct format"],"2.Payee":["Duplicate Payee in collection"]}},"error":{"message":"Bad Request","details":"There was an issue with your request message"}}},"type":"object","required":["error"],"properties":{"error":{"description":"error object containing the details of the error.","type":"object","required":["message"],"properties":{"message":{"example":"Bad Request","type":"string"},"details":{"example":"There was an issue with your request message.","type":"string"}}}}}},"components/schemas/FetchLockboxDirectoryResponse":{"id":"components/schemas/FetchLockboxDirectoryResponse","kind":"json-schema","title":"FetchLockboxDirectoryResponse","data":{"example":{"value":[{"directoryId":"ee17e146-51e1-4e1d-b918-8b07317aaaed","system":{"customerName":"DPNTestCustomer","locationName":"DPNLocation","sysId":"VICPers"},"address":{"createdAt":"2024-04-11T19:36:48.341053Z","poBox":12200,"street1":"VIC1p2 200 DPI Box","street2":"","city":"DPXNTest","state":"MN","zip":"55402"},"providerId":12200,"isActive":true,"isDeleted":false,"createdAt":"2024-04-11T19:36:48.341053Z","mailStop":"","agreement":"Var","maxBatchSize":50}]},"type":"object","required":["value"],"properties":{"value":{"description":"Array of lockbox records for the requested page. Each element describes a single lockbox destination that can be used to route a payment.","type":"array","items":{"type":"object","required":["directoryId","system","address","providerId"],"properties":{"directoryId":{"description":"Stable unique identifier for the lockbox record.Persist this on the caller side to anchor payees to a specific lockbox in your own systems.","example":"c52dcea6-2519-4bf4-b2ed-9fb16567afd3","type":"string","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"system":{"description":"The system associated with the lockbox.","type":"object","required":["customerName","locationName","sysId"],"properties":{"customerName":{"description":"Name of customer in DDN Directory.","example":"DPNTestCustomer","type":"string"},"locationName":{"description":"Name of the location configured in the DPN Directory.","example":"DPNLocation","type":"string"},"sysId":{"description":"Name of the system configured in the DPN Directory, eg IL.","example":"VICPers","type":"string"}}},"address":{"description":"Structured postal address for the lockbox destination.","type":"object","required":["createdAt","street1","city","state","zip"],"properties":{"createdAt":{"description":"Timestamp when the lockbox record was first created in the directory. ISO 8601 format.","example":"2024-02-22T16:54:27.89585Z","type":"string"},"poBox":{"description":"PO Box number for the lockbox, when applicable. Present as a numeric value.","example":12200,"type":"integer"},"street1":{"description":"First line of the postal address. Typically the PO Box or street line used for delivery.","example":"PO Box 489","type":"string"},"street2":{"description":"Second line of the postal address, when a single line is insufficient.","example":"","type":"string"},"city":{"description":"City portion of the postal address.","example":"Carol Stream","type":"string"},"state":{"description":"Two-letter US state code portion of the postal address.","example":"IL","type":"string"},"zip":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ZIP or ZIP+4 code for the postal address."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"60197-0489","type":"string"}}},"providerId":{"description":"Unique identifier assigned by the lockbox provider for the  lockbox.","example":12200,"type":"integer"},"isActive":{"description":"The active status of the lockbox.","example":true,"type":"boolean"},"isDeleted":{"description":"The deleted status of the lockbox.","example":false,"type":"boolean"},"createdAt":{"description":"The date the lockbox was created.","example":"2024-04-11T19:36:48.341053Z","type":"string"},"mailStop":{"description":"Optional mail-stop qualifier associated with the lockbox address. Populated only when the destination requires an internal routing marker in addition to the postal address.","example":"","type":"string"},"agreement":{"description":"Defines how strictly DPN should match payments to the lockbox address.","example":"Var","type":"string"},"maxBatchSize":{"description":"Maximum number of items the lockbox can process in a single batch","example":50,"type":"integer"}}}}}}},"schema_0":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Error"}],"properties":{"error":{"properties":{"message":{"example":"Unauthorized"},"details":{"example":"You have issues accessing the system"}}}}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Error"}],"properties":{"error":{"properties":{"message":{"example":"Forbidden"},"details":{"example":"You are not allowed to make this request"}}}}},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Error"}],"properties":{"error":{"properties":{"message":{"example":"Not Found"},"details":{"example":"Resource not found"}}}}},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Error"}],"properties":{"error":{"properties":{"message":{"example":"Method Not Allowed"},"details":{"example":"Method not allowed"}}}}},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Error"}],"properties":{"error":{"properties":{"message":{"example":"Not Acceptable"},"details":{"example":"The API cannot provide the requested accepted response"}}}}},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Error"}],"properties":{"error":{"properties":{"message":{"example":"Connection Timeout"},"details":{"example":"The request to the server has been timed-out"}}}}},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Error"}],"properties":{"error":{"properties":{"message":{"example":"Unsupported Media Type"},"details":{"example":"Media type not supported"}}}}},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Error"}],"properties":{"error":{"properties":{"message":{"example":"Too Many Requests"},"details":{"example":"You have made too many requests to the server"}}}}},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Error"}],"properties":{"error":{"properties":{"message":{"example":"Internal Server Error"},"details":{"example":"Error with data transformation.  See log for details."}}}}},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Error"}],"properties":{"error":{"properties":{"message":{"example":"Not Implemented"},"details":{"example":"The operation has not been implemented"}}}}},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Error"}],"properties":{"error":{"properties":{"message":{"example":"Service Unavailable"},"details":{"example":"Unable to access the system at this time"}}}}},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Error"}],"properties":{"error":{"properties":{"message":{"example":"Gateway Timeout"},"details":{"example":"The server was acting as a gateway or proxy and did not receive a timely response from the upstream server."}}}}},"id":"schema_14"}},"exampleStore":{"paths/~1lockbox/get/responses/401/content/application~1json/example":{"value":{"error":{"message":"Unauthorized","details":"You have issues accessing the system"}},"id":"paths/~1lockbox/get/responses/401/content/application~1json/example"},"paths/~1lockbox/get/responses/403/content/application~1json/example":{"value":{"error":{"message":"Forbidden","details":"You are not allowed to make this request"}},"id":"paths/~1lockbox/get/responses/403/content/application~1json/example"},"paths/~1lockbox/get/responses/404/content/application~1json/example":{"value":{"error":{"message":"Not Found","details":"Resource not found"}},"id":"paths/~1lockbox/get/responses/404/content/application~1json/example"},"paths/~1lockbox/get/responses/405/content/application~1json/example":{"value":{"error":{"message":"Method Not Allowed","details":"Method not allowed"}},"id":"paths/~1lockbox/get/responses/405/content/application~1json/example"},"paths/~1lockbox/get/responses/406/content/application~1json/example":{"value":{"error":{"message":"Not Acceptable","details":"The API cannot provide the requested accepted response"}},"id":"paths/~1lockbox/get/responses/406/content/application~1json/example"},"paths/~1lockbox/get/responses/408/content/application~1json/example":{"value":{"error":{"message":"Connection Timeout","details":"The request to the server has been timed-out"}},"id":"paths/~1lockbox/get/responses/408/content/application~1json/example"},"paths/~1lockbox/get/responses/415/content/application~1json/example":{"value":{"error":{"message":"Unsupported Media Type","details":"Media type not supported"}},"id":"paths/~1lockbox/get/responses/415/content/application~1json/example"},"paths/~1lockbox/get/responses/429/content/application~1json/example":{"value":{"error":{"message":"Too Many Requests","details":"You have made too many requests to the server"}},"id":"paths/~1lockbox/get/responses/429/content/application~1json/example"},"paths/~1lockbox/get/responses/500/content/application~1json/example":{"value":{"error":{"message":"Internal Server Error","details":"Error with data transformation.  See log for details."}},"id":"paths/~1lockbox/get/responses/500/content/application~1json/example"},"paths/~1lockbox/get/responses/501/content/application~1json/example":{"value":{"error":{"message":"Not Implemented","details":"The operation has not been implemented"}},"id":"paths/~1lockbox/get/responses/501/content/application~1json/example"},"paths/~1lockbox/get/responses/503/content/application~1json/example":{"value":{"error":{"message":"Service Unavailable","details":"Unable to access the system at this time"}},"id":"paths/~1lockbox/get/responses/503/content/application~1json/example"},"paths/~1lockbox/get/responses/504/content/application~1json/example":{"value":{"error":{"message":"Gateway Timeout","details":"The server was acting as a gateway or proxy and did not receive a timely response from the upstream server."}},"id":"paths/~1lockbox/get/responses/504/content/application~1json/example"}},"securitySchemeStore":{"securitySchemas.oidcEnforcement":{"id":"securitySchemas.oidcEnforcement","type":"oauth2","description":"This API supports OpenID Connect OAuth 2.0 for authenticating all API requests.\n","flows":{"clientCredentials":{"tokenUrl":"https://services.deluxe.com/oauth2/v2/token","scopes":{}}}}},"specVersion":"3.0.0","servers":[{"url":"/_mock/products/deluxe-payment-network/api/payables-ddn/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://dcip.deluxe.com/payables/ddn/v1","description":"Production"},{"url":"https://stage.dcip.deluxe.com/payables/ddn/v1","description":"Sandbox"}],"specType":"openapi"},"options":{"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"}]},"mockServer":{"url":"/_mock/products/deluxe-payment-network/api/payables-ddn/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/deluxe-payment-network/api/payables-ddn/@v2.0.0/openapi.json?download"},{"url":"/_bundle/products/deluxe-payment-network/api/payables-ddn/@v2.0.0/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Lockbox","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"}},"baseSlug":"/products/deluxe-payment-network/api/payables-ddn/openapi","routesMapping":{}}