> ## Documentation Index > Fetch the complete documentation index at: https://docs.payhub.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a deposit > Retrieve a single deposit by ID ## OpenAPI ````yaml GET /v1/crm/deposits/{depositId} openapi: 3.1.0 info: title: PayHub API description: >- The PayHub API is a REST interface for the SignaPay PayHub Platform — a CRM and back-office system for payment processing agents, ISOs, partners, and merchants. ## Authentication All protected endpoints require a session token or API key passed in the `Authorization` header. Use the **Authentication** endpoints to create and manage sessions, including MFA challenge/response and session impersonation. Password resets, OTP delivery (email and SMS), and email address verification are handled by their own endpoint groups. SAML and OAuth2 flows are also supported. ## Core Resources The API is organized around five primary entity types: - **Leads** — Merchant applications in progress. Full lifecycle management including status transitions, risk profiling, document collection, principal and business address capture, deposit information, pricing configuration, equipment ordering, and e-signature sessions. - **Clients** — Approved merchant accounts. Mirrors the Lead resource structure with additional settings for portal configuration, security policies, API key provisioning, and user access. - **Partners** — ISO/partner organizations. Manage business details, principals, documents, notes, and pricing templates and packages. - **Merchants** — Active processing accounts linked to clients. Supports the same document, note, pricing, and equipment order sub-resources as Leads and Partners. - **Agents** — Sales agents associated with leads and merchants. Includes document and note management. ## Pricing & Reference Data Pricing is modeled at multiple levels (items, packages, rules, templates) and can be scoped to leads, partners, or merchants. Reference data endpoints provide read-only lists of Pricing Models, Merchant Category Codes (MCC), MCC relations and card processing profiles, Bank BINs, Industry Types, Merchant Types, and Merchant Risk Categories. ## Compliance & Validation Dedicated validation endpoints support MATCH Pro and Clear screening, address validation, and both lead-level and client-level business rule checks. ## Financial Reporting Read-only endpoints expose Deposits, Deposit Details, Chargebacks, Residuals (with merchant-level summaries, overrides, and detail), Transactions, Transaction Batches, and Statements. ## Support & Workflow A ticketing system (Tickets, Categories, Activities, Watchers, Clients, Documents) handles internal support requests. The FastApply group provides a streamlined MPA form submission flow. SAM Action Logs and Export endpoints round out back-office tooling. ## User & Access Management Manage platform users, their phone and email addresses, role-based permissions, feature flags, and user groups. version: 1.0.0 servers: [] security: [] tags: - name: FastApply description: Endpoints for the fast-apply MPA form flow. - name: Authentication description: Endpoints for session management. - name: Password Reset description: Endpoints for password reset and OTP verification. - name: Email Verification description: Endpoints for email address verification. - name: OTP description: Endpoints for one-time password generation and verification. - name: Lead description: Endpoints for lead management. - name: Lead Sources description: Endpoints for lead source management. - name: Lead Document description: Endpoints for lead document management. - name: Document Types description: Endpoints for document type management. - name: Pricing Models description: Endpoints for listing available pricing models. - name: Merchant Category Codes description: Endpoints for listing merchant category codes (MCC). - name: MCC Relations description: Endpoints for listing MCC relations. - name: MCC Card Processing Profiles description: Endpoints for listing MCC card processing profiles. - name: Bank BINs description: Endpoints for listing bank BINs. - name: Industry Types description: Endpoints for listing industry types. - name: Merchant Types description: Endpoints for listing merchant types. - name: Merchant Risk Categories description: Endpoints for listing merchant risk categories. - name: Lead Business Address description: Endpoints for lead business address management. - name: Lead Principal description: Endpoints for lead principal management. - name: Lead Deposit Info description: Endpoints for lead deposit info management. - name: Lead Note description: Endpoints for lead note management. - name: Signing description: Endpoints for e-signature signing sessions. - name: Lead Validations description: Endpoints for lead validation services. - name: Lead Pricing Items description: Endpoints for lead pricing items management. - name: Lead Pricing Packages description: Endpoints for lead pricing packages management. - name: Lead Pricing Rules description: Endpoints for lead pricing rules management. - name: Client Validations description: Endpoints for client validation services. - name: MATCH Pro description: >- Endpoints for Mastercard MATCH Pro services including inquiry history, retroactive monitoring, and terminated merchant reporting. - name: Clear description: Endpoints for Clear identity verification services. - name: Search description: Endpoints for Algolia-backed search. - name: Address Validation description: Endpoints for US address autocomplete and verification (Smarty proxy). - name: Client description: Endpoints for client management. - name: Client Business Address description: Endpoints for client business address management. - name: Client Principal description: Endpoints for client principal management. - name: Client Deposit Info description: Endpoints for client deposit info management. - name: Client Document description: Endpoints for client document management. - name: Client Note description: Endpoints for client note management. - name: Client Portal Settings description: Endpoints for client portal settings management. - name: Client Security Settings description: Endpoints for client security settings management. - name: Client API Key description: Endpoints for client API key management. - name: Partner description: Endpoints for partner management. - name: Partner Business Address description: Endpoints for partner business address management. - name: Partner Principal description: Endpoints for partner principal management. - name: Partner Document description: Endpoints for partner document management. - name: Partner Note description: Endpoints for partner note management. - name: Partner Pricing Items description: Endpoints for partner pricing items management. - name: Partner Pricing Templates description: Endpoints for partner pricing templates management. - name: Partner Pricing Packages description: Endpoints for partner pricing packages management. - name: Partner Pricing Rules description: Endpoints for partner pricing rules management. - name: Partner Processor Settings description: Endpoints for partner processor settings management. - name: Merchant description: Endpoints for merchant management. - name: Merchant Business Address description: Endpoints for merchant business address management. - name: Merchant Principal description: Endpoints for merchant principal management. - name: Merchant Document description: Endpoints for merchant document management. - name: Merchant Note description: Endpoints for merchant note management. - name: Merchant Pricing Items description: Endpoints for merchant pricing items management. - name: Merchant Pricing Templates description: Endpoints for merchant pricing templates management. - name: Merchant Pricing Packages description: Endpoints for merchant pricing packages management. - name: Merchant Pricing Rules description: Endpoints for merchant pricing rules management. - name: Merchant ISO Package description: Endpoints for merchant ISO package associations. - name: Agent description: Endpoints for agent management. - name: Agent Document description: Endpoints for agent document management. - name: Agent Note description: Endpoints for agent note management. - name: Ticket Categories description: Endpoints for ticket category management. - name: Tickets description: Endpoints for ticket management. - name: Ticket Activities description: Endpoints for ticket activity management. - name: Ticket Watchers description: Endpoints for ticket watcher management. - name: Ticket Clients description: Endpoints for ticket client management. - name: Ticket Documents description: Endpoints for ticket document management. - name: Client User description: Endpoints for client user management. - name: Users description: Endpoints for user management. - name: User Phones description: Endpoints for user phone number management. - name: User Emails description: Endpoints for user email address management. - name: Roles description: Endpoints for role management. - name: Role Features description: Endpoints for role feature management. - name: Features description: Endpoints for browsing the features catalog (the role permissions list). - name: Groups description: Endpoints for group management. - name: Group Users description: Endpoints for group user management. - name: SAM Action Logs description: Endpoints for SAM action log management. - name: Notification description: Endpoints for notification management. - name: Deposit description: Endpoints for deposit management. - name: Deposit Details description: Endpoints for deposit details management. - name: Chargeback description: Endpoints for chargeback management. - name: Residual description: Endpoints for residual report management. - name: Residual Merchant Summary description: Endpoints for merchant-level residual summaries. - name: Residual Override description: Endpoints for residual override management. - name: Residual Merchant Detail description: Endpoints for residual merchant fee category details. - name: Transaction description: Endpoints for transaction management. - name: Transaction Note description: Endpoints for transaction note management. - name: Transaction Batch description: Endpoints for transaction batch management. - name: Transaction Batch Note description: Endpoints for transaction batch note management. - name: Statement Note description: Endpoints for statement note management. - name: Lead Equipment Models description: Endpoints for lead equipment model management. - name: Lead Equipment Order description: Endpoints for lead equipment order management. - name: Lead Equipment Order Items description: Endpoints for lead equipment order item management. - name: Lead Equipment Order Gateway description: Endpoints for lead equipment order gateway management. - name: Lead Equipment Order File Build Type description: Endpoints for lead equipment order file build type management. - name: Merchant Equipment Models description: Endpoints for merchant equipment model management. - name: Merchant Equipment Order description: Endpoints for merchant equipment order management. - name: Merchant Equipment Order Items description: Endpoints for merchant equipment order item management. - name: Merchant Equipment Order Gateway description: Endpoints for merchant equipment order gateway management. - name: Merchant Equipment Order File Build Type description: Endpoints for merchant equipment order file build type management. - name: Export description: Endpoints for data export. - name: SAML description: Endpoints for SAML SSO identity provider integration. - name: OAuth2 description: OAuth2 authorization server endpoints with Okta compatibility layer. paths: /v1/crm/deposits/{depositId}: get: tags: - Deposit summary: Get a Deposit description: Returns a deposit by its primary identifier operationId: getDeposit parameters: - schema: type: string in: path name: depositId required: true responses: '200': description: The deposit record corresponding to the primary identifier. content: application/json: schema: $ref: '#/components/schemas/Deposit' '403': description: The user does not have permission to access this resource. content: application/json: schema: type: object properties: status: type: number code: type: string detail: type: string required: - status - code - detail '404': description: The requested resource was not found. content: application/json: schema: type: object properties: status: type: number code: type: string detail: type: string required: - status - code - detail security: - bearerAuth: [] - apiKey: [] components: schemas: Deposit: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ host: type: string enum: - tsys - fiserv type: type: string enum: - deposit - chargeback - adjustment - released_fund - released_susp_fund - reserved_fund_xfer - reject - reserved_fund - suspended_fund - fee - non_settled - federal_bw - state_bw - transmittal_error - convenience_fee - split_fund totalAmount: type: number processingDate: type: string last4DDA: type: string maxLength: 4 referenceNumber: type: string batchId: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' chargebackId: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' clientId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ clientPath: type: string createdAt: type: string createdBy: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ updatedAt: type: string updatedBy: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ required: - id - host - type - totalAmount - processingDate - last4DDA - referenceNumber - batchId - chargebackId - clientId - clientPath - createdAt - createdBy - updatedAt - updatedBy securitySchemes: bearerAuth: type: http scheme: bearer description: 'Enter token in following format: Bearer ' apiKey: type: apiKey name: Authorization in: header description: 'Enter api-key in following format: Api-Key ' ````