{
  "openapi": "3.0.0",
  "info": {
    "title": "Payables DPN API",
    "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",
    "version": ""
  },
  "paths": {
    "/payment-files": {
      "x-amf-displayName": "Payments",
      "x-amf-description": "Entry point for all batch payment workflows. Submit a batch of payments as a single CSV file to receive a fileGuid, then use it to monitor aggregate file-level status until the file reaches a terminal state, or retrieve per-record payment status as the source of truth for reconciliation, remediation, and downstream reporting.",
      "post": {
        "operationId": "paymentFileUpload",
        "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.",
        "parameters": [
          {
            "name": "businessPartner",
            "description": "Identifier of the disburser submitting the payment file, issued by Deluxe during onboarding. Scopes the request to the correct disburser and routing configuration; this same value must be used on all subsequent status and reconciliation calls for the file.",
            "required": true,
            "in": "header",
            "example": "DPNTestPartner",
            "schema": {
              "type": "string",
              "maxLength": 100,
              "pattern": "^[A-Za-z0-9 ]+$"
            }
          }
        ],
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "attachment": {
                    "description": "CSV payment file conforming to the Deluxe payment file specification supplied during onboarding. Submitted as a single file part in the multipart body. Each row represents one payment record; validation is performed after ingestion and results are surfaced through the status endpoints.",
                    "type": "string",
                    "format": "binary",
                    "x-amf-fileTypes": [
                      "text/csv"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentFileUploadResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Bad Request"
                        },
                        "details": {
                          "example": "There was an issue with your request message"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Bad Request",
                    "details": "There was an issue with your request message"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Unauthorized"
                        },
                        "details": {
                          "example": "You have issues accessing the system"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Unauthorized",
                    "details": "You have issues accessing the system"
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Forbidden"
                        },
                        "details": {
                          "example": "You are not allowed to make this request"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Forbidden",
                    "details": "You are not allowed to make this request"
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Not Found"
                        },
                        "details": {
                          "example": "Resource not found"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Not Found",
                    "details": "Resource not found"
                  }
                }
              }
            }
          },
          "405": {
            "description": "Method Not Allowed",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Method Not Allowed"
                        },
                        "details": {
                          "example": "Method not allowed"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Method Not Allowed",
                    "details": "Method not allowed"
                  }
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Not Acceptable"
                        },
                        "details": {
                          "example": "The API cannot provide the requested accepted response"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Not Acceptable",
                    "details": "The API cannot provide the requested accepted response"
                  }
                }
              }
            }
          },
          "408": {
            "description": "Connection Timeout",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Connection Timeout"
                        },
                        "details": {
                          "example": "The request to the server has been timed-out"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Connection Timeout",
                    "details": "The request to the server has been timed-out"
                  }
                }
              }
            }
          },
          "415": {
            "description": "Unsupported Media Type",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Unsupported Media Type"
                        },
                        "details": {
                          "example": "Media type not supported"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Unsupported Media Type",
                    "details": "Media type not supported"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Too Many Requests"
                        },
                        "details": {
                          "example": "You have made too many requests to the server"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Too Many Requests",
                    "details": "You have made too many requests to the server"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Internal Server Error"
                        },
                        "details": {
                          "example": "Error with data transformation.  See log for details."
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Internal Server Error",
                    "details": "Error with data transformation.  See log for details."
                  }
                }
              }
            }
          },
          "501": {
            "description": "Not Implemented",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Not Implemented"
                        },
                        "details": {
                          "example": "The operation has not been implemented"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Not Implemented",
                    "details": "The operation has not been implemented"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Service Unavailable",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Service Unavailable"
                        },
                        "details": {
                          "example": "Unable to access the system at this time"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Service Unavailable",
                    "details": "Unable to access the system at this time"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "securitySchemes.oidcEnforcement": []
          }
        ],
        "summary": "Payment File Upload",
        "tags": [
          "Payments"
        ]
      }
    },
    "/payment-files/{file_guid}": {
      "x-amf-displayName": "Fetch Payment File Status",
      "x-amf-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.",
      "get": {
        "operationId": "fetchPaymentFileStatus",
        "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.",
        "parameters": [
          {
            "name": "file_guid",
            "description": "Unique tracking number assigned to the payment file at upload. This value is returned in the GUID.trackingNumbers array on the Payment Upload response and is the sole handle used to reference the file on all downstream status and reconciliation calls.",
            "required": true,
            "in": "path",
            "example": "274b86c07837a10367440f3f686ab426",
            "schema": {
              "type": "string",
              "pattern": "^[0-9a-fA-F]{32}$"
            }
          },
          {
            "name": "businessPartner",
            "description": "Identifier of the disburser submitting the payment file, issued by Deluxe during onboarding. Scopes the request to the correct disburser and routing configuration; this same value must be used on all subsequent status and reconciliation calls for the file.",
            "required": true,
            "in": "header",
            "example": "DPNTestPartner",
            "schema": {
              "type": "string",
              "maxLength": 100,
              "pattern": "^[A-Za-z0-9 ]+$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FetchPaymentFileStatusResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Bad Request"
                        },
                        "details": {
                          "example": "There was an issue with your request message"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Bad Request",
                    "details": "There was an issue with your request message"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Unauthorized"
                        },
                        "details": {
                          "example": "You have issues accessing the system"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Unauthorized",
                    "details": "You have issues accessing the system"
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Forbidden"
                        },
                        "details": {
                          "example": "You are not allowed to make this request"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Forbidden",
                    "details": "You are not allowed to make this request"
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Not Found"
                        },
                        "details": {
                          "example": "Resource not found"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Not Found",
                    "details": "Resource not found"
                  }
                }
              }
            }
          },
          "405": {
            "description": "Method Not Allowed",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Method Not Allowed"
                        },
                        "details": {
                          "example": "Method not allowed"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Method Not Allowed",
                    "details": "Method not allowed"
                  }
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Not Acceptable"
                        },
                        "details": {
                          "example": "The API cannot provide the requested accepted response"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Not Acceptable",
                    "details": "The API cannot provide the requested accepted response"
                  }
                }
              }
            }
          },
          "408": {
            "description": "Connection Timeout",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Connection Timeout"
                        },
                        "details": {
                          "example": "The request to the server has been timed-out"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Connection Timeout",
                    "details": "The request to the server has been timed-out"
                  }
                }
              }
            }
          },
          "415": {
            "description": "Unsupported Media Type",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Unsupported Media Type"
                        },
                        "details": {
                          "example": "Media type not supported"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Unsupported Media Type",
                    "details": "Media type not supported"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Too Many Requests"
                        },
                        "details": {
                          "example": "You have made too many requests to the server"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Too Many Requests",
                    "details": "You have made too many requests to the server"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Internal Server Error"
                        },
                        "details": {
                          "example": "Error with data transformation.  See log for details."
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Internal Server Error",
                    "details": "Error with data transformation.  See log for details."
                  }
                }
              }
            }
          },
          "501": {
            "description": "Not Implemented",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Not Implemented"
                        },
                        "details": {
                          "example": "The operation has not been implemented"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Not Implemented",
                    "details": "The operation has not been implemented"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Service Unavailable",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Service Unavailable"
                        },
                        "details": {
                          "example": "Unable to access the system at this time"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Service Unavailable",
                    "details": "Unable to access the system at this time"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "securitySchemes.oidcEnforcement": []
          }
        ],
        "summary": "Fetch Payment File Status",
        "tags": [
          "Payments"
        ]
      }
    },
    "/payment-files/{file_guid}/payments": {
      "x-amf-displayName": "Fetch Payments",
      "x-amf-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.",
      "get": {
        "operationId": "fetchPaymentStatus",
        "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.",
        "parameters": [
          {
            "name": "pageAfter",
            "description": "The start date for filtering payments.",
            "required": false,
            "in": "query",
            "example": "eyJDcmVhdGVkQXQiOiIyMDI2LTA2LTI1VDE2OjA5OjAxLjYzMjY1NTAiLCJJZCI6NTU3NjgwfQ==",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pageBefore",
            "description": "The end date for filtering payments.",
            "required": false,
            "in": "query",
            "example": "eyJDcmVhdGVkQXQiOiIyMDI2LTA2LTI1VDE2OjA5OjAxLjYzMjY1NTAiLCJJZCI6NTU3NjgwfQ==",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pageSize",
            "description": "The page number for paginated results.",
            "required": false,
            "in": "query",
            "example": 1,
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "status",
            "description": "Filters payments by their status.",
            "required": false,
            "in": "query",
            "example": "Success",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "file_guid",
            "description": "Unique tracking number assigned to the payment file at upload. This value is returned in the GUID.trackingNumbers array on the Payment Upload response and is the sole handle used to reference the file on all downstream status and reconciliation calls.",
            "required": true,
            "in": "path",
            "example": "274b86c07837a10367440f3f686ab426",
            "schema": {
              "type": "string",
              "pattern": "^[0-9a-fA-F]{32}$"
            }
          },
          {
            "name": "businessPartner",
            "description": "Identifier of the disburser submitting the payment file, issued by Deluxe during onboarding. Scopes the request to the correct disburser and routing configuration; this same value must be used on all subsequent status and reconciliation calls for the file.",
            "required": true,
            "in": "header",
            "example": "DPNTestPartner",
            "schema": {
              "type": "string",
              "maxLength": 100,
              "pattern": "^[A-Za-z0-9 ]+$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FetchPaymentStatusResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Bad Request"
                        },
                        "details": {
                          "example": "There was an issue with your request message"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Bad Request",
                    "details": "There was an issue with your request message"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Unauthorized"
                        },
                        "details": {
                          "example": "You have issues accessing the system"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Unauthorized",
                    "details": "You have issues accessing the system"
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Forbidden"
                        },
                        "details": {
                          "example": "You are not allowed to make this request"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Forbidden",
                    "details": "You are not allowed to make this request"
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Not Found"
                        },
                        "details": {
                          "example": "Resource not found"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Not Found",
                    "details": "Resource not found"
                  }
                }
              }
            }
          },
          "405": {
            "description": "Method Not Allowed",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Method Not Allowed"
                        },
                        "details": {
                          "example": "Method not allowed"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Method Not Allowed",
                    "details": "Method not allowed"
                  }
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Not Acceptable"
                        },
                        "details": {
                          "example": "The API cannot provide the requested accepted response"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Not Acceptable",
                    "details": "The API cannot provide the requested accepted response"
                  }
                }
              }
            }
          },
          "408": {
            "description": "Connection Timeout",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Connection Timeout"
                        },
                        "details": {
                          "example": "The request to the server has been timed-out"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Connection Timeout",
                    "details": "The request to the server has been timed-out"
                  }
                }
              }
            }
          },
          "415": {
            "description": "Unsupported Media Type",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Unsupported Media Type"
                        },
                        "details": {
                          "example": "Media type not supported"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Unsupported Media Type",
                    "details": "Media type not supported"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Too Many Requests"
                        },
                        "details": {
                          "example": "You have made too many requests to the server"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Too Many Requests",
                    "details": "You have made too many requests to the server"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Internal Server Error"
                        },
                        "details": {
                          "example": "Error with data transformation.  See log for details."
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Internal Server Error",
                    "details": "Error with data transformation.  See log for details."
                  }
                }
              }
            }
          },
          "501": {
            "description": "Not Implemented",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Not Implemented"
                        },
                        "details": {
                          "example": "The operation has not been implemented"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Not Implemented",
                    "details": "The operation has not been implemented"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Service Unavailable",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Service Unavailable"
                        },
                        "details": {
                          "example": "Unable to access the system at this time"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Service Unavailable",
                    "details": "Unable to access the system at this time"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "securitySchemes.oidcEnforcement": []
          }
        ],
        "summary": "Fetch Payment Status",
        "tags": [
          "Payments"
        ]
      }
    },
    "/payment-files/{file_guid}/payments/{paymentGuid}": {
      "x-amf-displayName": "Fetch Single Payment Status By paymentGuid",
      "x-amf-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.",
      "get": {
        "operationId": "fetchSinglePaymentStatusByPaymentGuid",
        "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.",
        "parameters": [
          {
            "name": "file_guid",
            "description": "Unique tracking number assigned to the payment file at upload. This value is returned in the GUID.trackingNumbers array on the Payment Upload response and is the sole handle used to reference the file on all downstream status and reconciliation calls.",
            "required": true,
            "in": "path",
            "example": "274b86c07837a10367440f3f686ab426",
            "schema": {
              "type": "string",
              "pattern": "^[0-9a-fA-F]{32}$"
            }
          },
          {
            "name": "paymentGuid",
            "description": "Unique tracking number assigned to the payment file at upload. This value is returned in the GUID.trackingNumbers array on the Payment Upload response and is the sole handle used to reference the file on all downstream status and reconciliation calls.",
            "required": true,
            "in": "path",
            "example": "274b86c07837a10367440f3f686ab426--0d031ed5-a7dc-43e4-9d3b-658d4912f2a8",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "businessPartner",
            "description": "Identifier of the disburser submitting the payment file, issued by Deluxe during onboarding. Scopes the request to the correct disburser and routing configuration; this same value must be used on all subsequent status and reconciliation calls for the file.",
            "required": true,
            "in": "header",
            "example": "DPNTestPartner",
            "schema": {
              "type": "string",
              "maxLength": 100,
              "pattern": "^[A-Za-z0-9 ]+$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FetchSinglePaymentStatusByPaymentGuidResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Bad Request"
                        },
                        "details": {
                          "example": "There was an issue with your request message"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Bad Request",
                    "details": "There was an issue with your request message"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Unauthorized"
                        },
                        "details": {
                          "example": "You have issues accessing the system"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Unauthorized",
                    "details": "You have issues accessing the system"
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Forbidden"
                        },
                        "details": {
                          "example": "You are not allowed to make this request"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Forbidden",
                    "details": "You are not allowed to make this request"
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Not Found"
                        },
                        "details": {
                          "example": "Resource not found"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Not Found",
                    "details": "Resource not found"
                  }
                }
              }
            }
          },
          "405": {
            "description": "Method Not Allowed",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Method Not Allowed"
                        },
                        "details": {
                          "example": "Method not allowed"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Method Not Allowed",
                    "details": "Method not allowed"
                  }
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Not Acceptable"
                        },
                        "details": {
                          "example": "The API cannot provide the requested accepted response"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Not Acceptable",
                    "details": "The API cannot provide the requested accepted response"
                  }
                }
              }
            }
          },
          "408": {
            "description": "Connection Timeout",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Connection Timeout"
                        },
                        "details": {
                          "example": "The request to the server has been timed-out"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Connection Timeout",
                    "details": "The request to the server has been timed-out"
                  }
                }
              }
            }
          },
          "415": {
            "description": "Unsupported Media Type",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Unsupported Media Type"
                        },
                        "details": {
                          "example": "Media type not supported"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Unsupported Media Type",
                    "details": "Media type not supported"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Too Many Requests"
                        },
                        "details": {
                          "example": "You have made too many requests to the server"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Too Many Requests",
                    "details": "You have made too many requests to the server"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Internal Server Error"
                        },
                        "details": {
                          "example": "Error with data transformation.  See log for details."
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Internal Server Error",
                    "details": "Error with data transformation.  See log for details."
                  }
                }
              }
            }
          },
          "501": {
            "description": "Not Implemented",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Not Implemented"
                        },
                        "details": {
                          "example": "The operation has not been implemented"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Not Implemented",
                    "details": "The operation has not been implemented"
                  }
                }
              }
            }
          },
          "503": {
            "description": "Service Unavailable",
            "x-amf-mediaType": "application/json",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Error"
                    }
                  ],
                  "properties": {
                    "error": {
                      "properties": {
                        "message": {
                          "example": "Service Unavailable"
                        },
                        "details": {
                          "example": "Unable to access the system at this time"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": {
                    "message": "Service Unavailable",
                    "details": "Unable to access the system at this time"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "securitySchemes.oidcEnforcement": []
          }
        ],
        "summary": "Fetch Single Payment Status By paymentGuid",
        "tags": [
          "Payments"
        ]
      }
    }
  },
  "x-documentation-overrides": {
    "host": "dcip.deluxe.com",
    "basePath": "/payables/dpxn/v1"
  },
  "servers": [
    {
      "url": "https://dcip.deluxe.com/payables/dpxn/v1",
      "description": "Production"
    },
    {
      "url": "https://stage.dcip.deluxe.com/payables/dpxn/v1",
      "description": "Sandbox"
    }
  ],
  "components": {
    "securitySchemes": {
      "securitySchemes.oidcEnforcement": {
        "type": "oauth2",
        "description": "This API supports OpenID Connect OAuth 2.0 for authenticating all API requests.\n",
        "x-amf-describedBy": {
          "headers": {
            "Authorization": {
              "description": "Used to send a valid OAuth 2 access token.\n",
              "required": true,
              "type": "string"
            }
          },
          "responses": {
            "401": {
              "description": "Unauthorized: invalid token, expired token, or connection error when connecting to the authorization server.\n"
            },
            "403": {
              "description": "Forbidden: invalid client application credentials.\n"
            }
          }
        },
        "x-amf-settings": {
          "authorizationGrants": [
            "authorization_code",
            "client_credentials",
            "implicit",
            "password"
          ]
        },
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://services.deluxe.com/oauth2/v2/token",
            "scopes": {}
          }
        }
      }
    },
    "schemas": {
      "Error": {
        "description": "Standard API Error Response",
        "x-amf-examples": {
          "amf_example_6": {
            "error": {
              "message": "Too Many Requests",
              "details": "You have made too many requests to the server"
            }
          },
          "example_2": {
            "error": {
              "message": "Method Not Allowed",
              "details": "Method not allowed"
            }
          },
          "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": "Unsupported Media Type",
              "details": "Media type not supported"
            }
          },
          "example_5": {
            "error": {
              "message": "Service Unavailable",
              "details": "Unable to access the system at this time"
            }
          },
          "amf_example_2": {
            "error": {
              "message": "Not Acceptable",
              "details": "The API cannot provide the requested accepted response"
            }
          },
          "example_4": {
            "error": {
              "message": "Internal Server Error",
              "details": "Error with data transformation.  See log for details."
            }
          },
          "amf_example_4": {
            "error": {
              "message": "Not Implemented",
              "details": "The operation has not been implemented"
            }
          },
          "example_0": {
            "error": {
              "message": "Bad Request",
              "details": "There was an issue with your request message"
            }
          },
          "amf_example_3": {
            "error": {
              "message": "Unauthorized",
              "details": "You have issues accessing the system"
            }
          },
          "example_3": {
            "error": {
              "message": "Connection Timeout",
              "details": "The request to the server has been timed-out"
            }
          }
        },
        "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"
              }
            }
          }
        }
      },
      "PaymentFileUploadResponse": {
        "example": {
          "businessPartner": "DPNTestPartner",
          "fileName": "testDPXN.csv",
          "status": "success",
          "GUID": {
            "trackingNumbers": [
              "dcd84961c29a1223740af2669daa7e52"
            ]
          },
          "uploadDTM": "2026-03-01 23:03:47"
        },
        "type": "object",
        "required": [
          "businessPartner",
          "fileName",
          "status",
          "GUID",
          "uploadDTM"
        ],
        "properties": {
          "businessPartner": {
            "description": "Business partner identifier echoed back from the request, confirming which disburser context the file was ingested under.",
            "example": "DPNTestPartner",
            "type": "string"
          },
          "fileName": {
            "description": "Original filename of the uploaded CSV as supplied on the request. Useful for correlating DPN's view of the file back to the caller's internal filesystem or job scheduler.",
            "example": "DPN_Payment_Test_File_20260311.csv",
            "type": "string"
          },
          "status": {
            "description": "Upload-level acknowledgement. success indicates the file was accepted for processing; downstream processing status is retrieved via the file status and payment status endpoints.",
            "example": "success",
            "type": "string"
          },
          "GUID": {
            "description": "Object holding the tracking number(s) assigned to the uploaded file.",
            "type": "object",
            "required": [
              "trackingNumbers"
            ],
            "properties": {
              "trackingNumbers": {
                "description": "Array containing the unique fileguid for the uploaded file. This value is the sole handle used to reference the file on all downstream status and reconciliation calls and must be persisted durably by the caller.",
                "example": [
                  "3090910c825a48908d616fb55326c4c6"
                ],
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          },
          "uploadDTM": {
            "description": "Timestamp at which DPN accepted and registered the file for processing.",
            "example": "2026-05-08 16:21:43",
            "type": "string"
          }
        }
      },
      "FetchPaymentFileStatusResponse": {
        "example": {
          "data": {
            "trackingNumber": "f92f3c36faebe4d04d60eaa42a06fc78",
            "createdAt": "2026-02-20T20:08:57.799818",
            "recordCount": 850,
            "fileName": "DPN_IN__printmail__20260220_1508_FC",
            "uploadType": "SFTP",
            "completedCount": 850,
            "failedCount": 0,
            "status": "Completed"
          },
          "links": {
            "self": "/v1/payment-files/f92f3c36faebe4d04d60eaa42a06fc78",
            "payments": "/v1/payment-files/f92f3c36faebe4d04d60eaa42a06fc78/payments"
          }
        },
        "type": "object",
        "required": [
          "data",
          "links"
        ],
        "properties": {
          "data": {
            "description": "Object holding the file-level status snapshot.",
            "type": "object",
            "required": [
              "trackingNumber",
              "createdAt",
              "recordCount",
              "fileName",
              "uploadType",
              "completedCount",
              "failedCount",
              "status"
            ],
            "properties": {
              "trackingNumber": {
                "description": "The fileguid echoed back from the request path, confirming which file the response describes.",
                "example": "3090910c825a48908d616fb55326c4c6",
                "type": "string",
                "pattern": "^[0-9a-fA-F]{32}$"
              },
              "createdAt": {
                "description": "Timestamp indicating when DPN first received and registered the payment file. Expressed in ISO 8601 format.",
                "example": "2026-05-08T16:21:43.127224",
                "type": "string"
              },
              "recordCount": {
                "description": "Total number of payment records contained in the uploaded file, as counted by DPN after successful ingestion. This is the denominator against which completedCount and failedCount should be reconciled.",
                "example": 7,
                "type": "integer"
              },
              "fileName": {
                "description": "Original filename of the uploaded CSV, as supplied by the caller on the Payment Upload request.",
                "example": "DPN_Payment_Test_File_20260311.csv",
                "type": "string"
              },
              "uploadType": {
                "description": "Indicates how the file was submitted to DPN. HTTP denotes an API upload via the Payment Upload endpoint; other values may appear when the file arrives through alternate channels such as SFTP.",
                "example": "HTTP",
                "type": "string"
              },
              "completedCount": {
                "description": "Number of payment records in the file that have reached a terminal successful state at the time of the query. Compare against recordCount and failedCount to determine remaining in-flight work.",
                "example": 0,
                "type": "integer"
              },
              "failedCount": {
                "description": "Number of payment records in the file that have reached a terminal failed state at the time of the query. A non-zero value signals that the caller should drill into the Payment Status endpoint to retrieve the specific error detail per failed record.",
                "example": 5,
                "type": "integer"
              },
              "status": {
                "description": "Aggregate file-level status. Incomplete indicates the file is still being processed; terminal values such as Complete and Failed indicate that DPN has finished processing the file. Confirm the complete set of terminal states with Deluxe as part of onboarding.",
                "example": "Incomplete",
                "type": "string"
              }
            }
          },
          "links": {
            "description": "Object providing convenience URLs for related resources.",
            "type": "object",
            "required": [
              "self",
              "payments"
            ],
            "properties": {
              "self": {
                "description": "Relative URL of the current resource, provided for HATEOAS-style navigation.",
                "example": "/v1/payment-files/3090910c825a48908d616fb55326c4c6",
                "type": "string"
              },
              "payments": {
                "description": "Relative URL of the per-record payments resource for this file. Follow this link to retrieve individual payment statuses via the Payment Status endpoint.",
                "example": "/v1/payment-files/dcd84961c29a1223740af2669daa7e52/payments",
                "type": "string"
              }
            }
          }
        }
      },
      "FetchPaymentStatusResponse": {
        "example": {
          "data": [
            {
              "guid": "3090910c825a48908d616fb55326c4c6--0f786378-ee23-47d2-88a2-8510d680c89e",
              "status": "Failed",
              "deliveryType": "Rejected",
              "fileDisposition": 4,
              "recordIdentifier": "50004",
              "trackingNumber": "16f3cc610357b08ff7eeda6d81d91725",
              "shipmentMethod": "",
              "createdAt": "2026-05-08T16:21:46.5794060",
              "finishedAt": "2026-05-08T16:22:59.0170180",
              "errors": [
                {
                  "key": "Destinations",
                  "value": "CommercialRouter",
                  "error": "No suitable route could be identified"
                }
              ],
              "meta": {
                "page": {
                  "cursor": "eyJDcmVhdGVkQXQiOiIyMDI2LTAyLTA1VDE1OjQ0OjU3Ljc1Njg3MjAiLCJJZCI6MjA0MzJ9"
                }
              }
            }
          ],
          "links": {
            "prev": "/v1/payment-files/{fileguid}/payments?pageSize=50&pageBefore=<cursor>",
            "next": "/v1/payment-files/{fileguid}/payments?pageSize=50&pageAfter=<cursor>"
          }
        },
        "type": "object",
        "required": [
          "data",
          "links"
        ],
        "properties": {
          "data": {
            "description": "Array of payment records, one per payment in the original file for the current page.",
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "guid",
                "status",
                "deliveryType",
                "fileDisposition",
                "recordIdentifier",
                "trackingNumber",
                "createdAt",
                "errors",
                "meta"
              ],
              "properties": {
                "guid": {
                  "description": "Composite identifier of the form {fileguid}--{paymentId} uniquely identifying a single payment record within the file. Persist this against your internal payment record to enable direct lookup on future calls.",
                  "example": "3090910c825a48908d616fb55326c4c6--0f786378-ee23-47d2-88a2-8510d680c89e",
                  "type": "string"
                },
                "status": {
                  "description": "Current status of the individual payment. Common values include Received, Accepted, Processing, InProduction, Completed, and Failed. See the Payment Status Values sections of the integration guide for the full lifecycle catalog per solution.",
                  "example": "Failed",
                  "type": "string"
                },
                "deliveryType": {
                  "description": "Delivery channel determination for the record once routing has completed. Values include Rejected, Unknown, and workflow-specific values populated as the record progresses.",
                  "example": "Rejected",
                  "type": "string"
                },
                "fileDisposition": {
                  "description": "Numeric disposition code assigned by DPN indicating the record's high-level disposition inside the file. Used for internal correlation and support diagnostics.",
                  "example": 4,
                  "type": "integer"
                },
                "recordIdentifier": {
                  "description": "Caller-supplied identifier carried through from the corresponding row in the uploaded CSV. Use this to correlate the DPN record back to the internal payment record that produced it.",
                  "example": "50004",
                  "type": "string"
                },
                "trackingNumber": {
                  "description": "Unique tracking number assigned to this payment file.",
                  "example": "16f3cc610357b08ff7eeda6d81d91725",
                  "type": "string"
                },
                "shipmentMethod": {
                  "description": "Resolved shipment method once routing is determined. Populated when the record progresses far enough for a shipment method to be assigned; null beforehand.",
                  "example": "",
                  "type": "string"
                },
                "createdAt": {
                  "description": "Timestamp indicating when DPN first registered the individual payment record. ISO 8601 format.",
                  "example": "2026-05-08T16:21:46.5794060",
                  "type": "string"
                },
                "finishedAt": {
                  "description": "Timestamp indicating when the record reached a terminal state. null while the record is still in progress; populated on terminal success or failure.",
                  "example": "2026-05-08T16:22:59.0170180",
                  "type": "string"
                },
                "errors": {
                  "description": "Array of error objects populated when status is Failed. Each entry describes one distinct failure reason and includes enough context for remediation. Empty for records that have not failed.",
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "key",
                      "error"
                    ],
                    "properties": {
                      "key": {
                        "description": "Short identifier for the source of the failure (for example, Destinations) used to categorize the error for reporting.",
                        "example": "Destinations",
                        "type": "string"
                      },
                      "value": {
                        "description": "Value associated with the error key, providing additional context. May be empty when no specific value applies.",
                        "example": "CommercialRouter",
                        "type": "string"
                      },
                      "error": {
                        "description": "Human-readable description of the failure. See the Error Messages section of the integration guide for the full catalog of known error messages and their meanings.",
                        "example": "No suitable route could be identified",
                        "type": "string"
                      }
                    }
                  }
                },
                "meta": {
                  "description": "Object holding metadata for the record.",
                  "type": "object",
                  "required": [
                    "page"
                  ],
                  "properties": {
                    "page": {
                      "description": "Object holding pagination metadata for the record.",
                      "type": "object",
                      "required": [
                        "cursor"
                      ],
                      "properties": {
                        "cursor": {
                          "description": "Opaque cursor value used by DPN in the prev and next pagination URLs. Callers should treat this as opaque and pass it back unchanged when paging.",
                          "example": "eyJDcmVhdGVkQXQiOiIyMDI2LTAyLTA1VDE1OjQ0OjU3Ljc1Njg3MjAiLCJJZCI6MjA0MzJ9",
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "links": {
            "description": "Object providing cursor-based pagination URLs for walking large result sets.",
            "type": "object",
            "properties": {
              "prev": {
                "description": "Relative URL for the previous page of results. Absent or null on the first page.",
                "example": "/v1/payment-files/{fileguid}/payments?pageSize=50&pageBefore=<cursor>",
                "type": "string"
              },
              "next": {
                "description": "Relative URL for the next page of results. Absent or null on the last page.",
                "example": "/v1/payment-files/{fileguid}/payments?pageSize=50&pageAfter=<cursor>",
                "type": "string"
              }
            }
          }
        }
      },
      "FetchSinglePaymentStatusByPaymentGuidResponse": {
        "example": {
          "guid": "274b86c07837a10367440f3f686ab426--0d031ed5-a7dc-43e4-9d3b-658d4912f2a8",
          "status": "Failed",
          "statusInfo": [
            {
              "description": "System is Validating",
              "updatedAt": "2026-06-29T11:25:37.0596130"
            }
          ],
          "deliveryType": "Rejected",
          "fileDisposition": 4,
          "recordIdentifier": "50004",
          "paymentTrackingNumber": "16f3cc610357b08ff7eeda6d81d91725",
          "shipmentMethod": "EXPRESS",
          "createdAt": "2026-05-08T16:21:46.5794060",
          "finishedAt": "2026-05-08T16:22:59.0170180",
          "errors": [
            {
              "key": "attachmentURL",
              "value": "redacted",
              "error": "isEmpty: attachment url is not allowed"
            }
          ]
        },
        "type": "object",
        "required": [
          "guid",
          "status",
          "deliveryType",
          "fileDisposition",
          "recordIdentifier",
          "paymentTrackingNumber",
          "createdAt",
          "errors"
        ],
        "properties": {
          "guid": {
            "description": "Composite identifier of the form {fileguid}--{paymentId} uniquely identifying a single payment record within the file. Persist this against your internal payment record to enable direct lookup on future calls.",
            "example": "274b86c07837a10367440f3f686ab426--0d031ed5-a7dc-43e4-9d3b-658d4912f2a8",
            "type": "string"
          },
          "status": {
            "description": "Current status of the individual payment. Common values include Received, Accepted, Processing, InProduction, Completed, and Failed. See the Payment Status Values sections of the integration guide for the full lifecycle catalog per solution.",
            "example": "Failed",
            "type": "string"
          },
          "statusInfo": {
            "description": "Chronological status updates for the payment record.",
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "description",
                "updatedAt"
              ],
              "properties": {
                "description": {
                  "description": "Status description for the processing stage.",
                  "example": "System is Validating",
                  "type": "string"
                },
                "updatedAt": {
                  "description": "Timestamp indicating when the status was updated.",
                  "example": "2026-06-29T11:25:37.0596130",
                  "type": "string"
                }
              }
            }
          },
          "deliveryType": {
            "description": "Delivery channel determination for the record once routing has completed. Values include Rejected, Unknown, and workflow-specific values populated as the record progresses.",
            "example": "Rejected",
            "type": "string"
          },
          "fileDisposition": {
            "description": "Numeric disposition code assigned by DPN indicating the record's high-level disposition inside the file. Used for internal correlation and support diagnostics.",
            "example": 4,
            "type": "integer"
          },
          "recordIdentifier": {
            "description": "Caller-supplied identifier carried through from the corresponding row in the uploaded CSV. Use this to correlate the DPN record back to the internal payment record that produced it.",
            "example": "50004",
            "type": "string"
          },
          "paymentTrackingNumber": {
            "description": "Unique tracking number assigned to this payment file.",
            "example": "16f3cc610357b08ff7eeda6d81d91725",
            "type": "string"
          },
          "shipmentMethod": {
            "description": "Resolved shipment method once routing is determined. Populated when the record progresses far enough for a shipment method to be assigned; null beforehand.",
            "example": "EXPRESS",
            "type": "string"
          },
          "createdAt": {
            "description": "Timestamp indicating when DPN first registered the individual payment record. ISO 8601 format.",
            "example": "2026-05-08T16:21:46.5794060",
            "type": "string"
          },
          "finishedAt": {
            "description": "Timestamp indicating when the record reached a terminal state. null while the record is still in progress; populated on terminal success or failure.",
            "example": "2026-05-08T16:22:59.0170180",
            "type": "string"
          },
          "errors": {
            "description": "Array of error objects populated when status is Failed. Each entry describes one distinct failure reason and includes enough context for remediation. Empty for records that have not failed.",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "description": "Short identifier for the source of the failure (for example, Destinations) used to categorize the error for reporting.",
                  "example": "attachmentURL",
                  "type": "string"
                },
                "value": {
                  "description": "Value associated with the error key, providing additional context. May be empty when no specific value applies.",
                  "example": "redacted",
                  "type": "string"
                },
                "error": {
                  "description": "Human-readable description of the failure. See the Error Messages section of the integration guide for the full catalog of known error messages and their meanings.",
                  "example": "isEmpty: attachment url is not allowed",
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Payments",
      "description": "Entry point for all batch payment workflows. Submit a batch of payments as a single CSV file to receive a fileGuid, then use it to monitor aggregate file-level status until the file reaches a terminal state, or retrieve per-record payment status as the source of truth for reconciliation, remediation, and downstream reporting."
    }
  ]
}