> ## Documentation Index > Fetch the complete documentation index at: https://docs.nmbr.co/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a payment ## OpenAPI ````yaml /spec/openapi.json get /payments/{payment} openapi: 3.0.0 info: title: Nmbr API description: API to interact with Nmbr Payroll version: 1.0.0 servers: - url: https://sandbox.nmbr.co/services/payroll security: - CompanyToken: [] tags: - name: Accounting Codes - name: Accounting Code Rules - name: Adjustments - name: Allowances - name: Allowance Line Items - name: Allowance Types - name: Async Tasks - name: Bank Accounts - name: Business Entities - name: Business Entity Verifications - name: Business Entity ROE Authorizations - name: Business Presets - name: Calculations - name: Companies - name: Contractors - name: Deductions - name: Deduction Line Items - name: Deduction Types - name: Earnings - name: Earning Line Items - name: Earning Types - name: Effective Tax Properties - name: Employees - name: Employee Benefits - name: Employee Benefit Line Items - name: Employee Benefit Types - name: Employer Benefits - name: Employer Benefit Line Items - name: Employer Benefit Types - name: Employer Statutory Withholding Line Items - name: Employer Statutory Withholding Types - name: Forms - name: Form Batches - name: Form Types - name: Holidays - name: Integrations - name: Journal Entries - name: Overtime Rates - name: Partners - name: Pay Rates - name: Pay Schedules - name: Pay Splits - name: Pay Stubs - name: Payments - name: Payrolls - name: Reimbursements - name: Reimbursement Line Items - name: Reimbursement Types - name: Remittance Accounts - name: Remittance Account Enrollments - name: Reports - name: Statutory Withholding Line Items - name: Statutory Withholding Types - name: Tags - name: Tag Groups - name: Tax Properties - name: Tax Property Templates - name: Tokens - name: Usage Records - name: Usage Summaries - name: Vacation Pay - name: Vacation Pay Settings - name: Webhooks - name: Work Assignments paths: /payments/{payment}: get: tags: - Payments summary: Retrieve a payment operationId: payments-show parameters: - name: payment in: path schema: type: string required: true - name: expand in: query schema: type: array items: type: string enum: - payroll - remittance_account required: false responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"payment"`). readOnly: true data: type: object allOf: - $ref: '#/components/schemas/Payment' anyOf: - type: object title: Default - type: object title: With payroll expanded properties: payroll: type: object properties: data: $ref: '#/components/schemas/Payroll' - type: object title: With remittance_account expanded properties: remittance_account: type: object properties: data: $ref: '#/components/schemas/RemittanceAccount' example: id: object: payment data: payroll: id: object: payroll links: self: /payrolls/ remittance_account: null destination: payroll_float method: pad amount: 0 status: pending process_at: '2026-01-27' expected_at: '2026-01-27' is_impacted_by_weekend_or_holiday: false is_held: false held_at: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /payments/ components: schemas: Payment: type: object title: Payment properties: payroll: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"payroll"`). readOnly: true remittance_account: {} destination: type: string description: >- Where the payment is destined. `payroll_float` is the funding debit from the employer's bank account. `employee` is a credit to an employee or contractor. `cra` and `rq` are remittances to the Canada Revenue Agency (CRA) and Revenu Québec (RQ), respectively. Where the payment is destined. For example, `employee` for payments to employees, `cra` for remittances to CRA, `payroll_float` for business funding. enum: - bill_pay - cra - employee - internal - no_op - payroll_float - rq method: type: string description: >- How the payment will be processed. `pad` (Pre-Authorized Debit) is used for employer funding. `direct_deposit` is used for employee credits. `manual` indicates the payment is handled outside of Nmbr. How the payment will be processed. For example, `direct_deposit` or `pad`. enum: - direct_deposit - manual - pad - wire amount: type: number description: The dollar amount of the payment. format: decimal status: type: string description: >- The current processing status of the payment. Payments begin as `pending`, move to `processing` when submitted to the banking network, and settle as `paid` or `failed`. Held payments that pass their processing date become `overdue`. enum: - canceled - failed - overdue - paid - pending - processing process_at: type: string description: >- The date on which Nmbr will submit the payment to the banking network for processing. nullable: true format: date expected_at: type: string description: >- The date on which the payment is expected to arrive at its destination. format: date is_impacted_by_weekend_or_holiday: type: boolean description: >- Whether the payment dates have been adjusted due to a weekend or bank holiday. Whether the payment dates have been adjusted due to a weekend or bank holiday. is_held: type: boolean description: >- Whether the payment is currently held. A held payment will not be submitted for processing until it is released. held_at: type: string description: >- The timestamp when the payment was placed on hold. `null` if the payment is not held. The timestamp when the payment was placed on hold. `null` if the payment is not held. readOnly: true nullable: true format: dateTime created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime Payroll: type: object title: Payroll properties: business_entity: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"business_entity"`). readOnly: true pay_schedule: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"pay_schedule"`). readOnly: true type: type: string description: >- The type of payroll. `regular` payrolls are generated automatically on the Pay Schedule. `off_cycle` Payrolls are created manually against a source regular payroll. `historical` and `correction` payrolls are used to record or correct prior periods. enum: - correction - historical - off_cycle - regular period_number: type: integer description: >- The sequential number of this pay period within the calendar year of its `pay_date`, counting only regular payrolls. `null` for off-cycle, historical, and correction payrolls. nullable: true period_label: type: string description: A human-readable label for this pay period. nullable: true period_start: type: string description: The start date of the pay period. format: date period_end: type: string description: The end date of the pay period. format: date pay_date: type: string description: The date on which Employees and Contractors are paid. format: date original_pay_date: type: string description: >- For payrolls on a custom-frequency Pay Schedule, the originally scheduled pay date before any movement for weekends or bank holidays. Used for year-to-date calculations and tax year assignment. nullable: true format: date debit_date: type: string description: >- The expected date the company's account will be debited the `cash_requirement` amount. nullable: true approval_due_at: type: string description: >- The date and time, in UTC, by which the payroll must be approved to be processed on time. readOnly: true nullable: true format: dateTime regular_periods_count: type: integer description: >- The total number of regular pay periods in this Pay Schedule whose `pay_date` falls in the same calendar year as this payroll's `pay_date`. Used for year-to-date calculations. nullable: true is_impacted_by_weekend_or_holiday: type: boolean description: >- Whether `pay_date` or `approval_due_at` has been moved to avoid falling on a weekend or bank holiday. is_blocked_by_draft: type: boolean description: >- Whether this payroll is blocked from being approved because an earlier payroll on the same Pay Schedule is still in draft status. note: type: string description: An optional note on the payroll, visible to the partner. nullable: true employee_summary: type: object description: A summary of pay across all Employees in this payroll. nullable: true properties: gross: description: The sum of all earnings and allowances. subtractions: description: The total of all deductions, taxes, and benefit contributions. reimbursements: description: The total of non-taxable reimbursements. net: description: The Employee net pay; when negative, a warning is included. contractor_summary: type: object description: A summary of pay across all Contractors in this payroll. nullable: true properties: gross: description: The sum of all earnings. reimbursements: description: The total of non-taxable reimbursements. net: description: The Contractor net pay. company_summary: type: object description: A summary of the company's obligations in this payroll. nullable: true properties: taxes_and_contributions: description: The employer share of statutory remittances (CPP and EI). benefits: description: The total of employer benefit contributions. total: description: The company's total obligations. liability: type: number description: >- The total amount owed by the company for this payroll, including Employee and Contractor net pay, employer tax contributions, and employer benefit contributions. nullable: true format: decimal cash_requirement: type: number description: >- The total amount that will be debited from the company's account when this payroll is approved. nullable: true format: decimal status: type: string description: The current status of the payroll. enum: - approved - draft - failed - paid - partially_paid - processing approved_at: type: string description: The date on which the payroll was approved. nullable: true format: date is_stale: type: boolean description: >- Whether the payroll's tax calculations are out of date. When `true`, `stale_since` indicates when the payroll became stale. stale_since: type: string description: >- The timestamp at which the payroll's tax calculations became stale and need to be recalculated. `null` if the payroll is up to date. readOnly: true nullable: true format: dateTime source_payroll: {} warnings: type: object description: >- A collection of data validation warnings for this payroll. Warnings indicate incomplete or potentially incorrect data and could prevent payroll processing. nullable: true properties: object: type: string nullable: true data: type: object nullable: true external_ref: type: string description: >- A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference. nullable: true maxLength: 255 created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime RemittanceAccount: type: object title: Remittance Account properties: business_entity: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"business_entity"`). readOnly: true source_tax_property: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"tax_property"`). readOnly: true account_provider: type: string description: >- The authority to which remittances are made for this account. This is used to determine how to remit payments for this account. Employer Health Tax (EHT) and Workers' Compensation (WCB) authorities are limited to one account, per province, per business entity; creating a second for an authority that already has one is rejected. nullable: true enum: - ca_ab_workers_compensation - ca_bc_eht - ca_bc_workers_compensation - ca_cra - ca_mb_eht - ca_mb_workers_compensation - ca_nb_workers_compensation - ca_nl_eht - ca_nl_workers_compensation - ca_ns_workers_compensation - ca_nt_government - ca_nt_workers_compensation - ca_nu_government - ca_nu_workers_compensation - ca_on_eht - ca_on_workers_compensation - ca_pe_workers_compensation - ca_rq - ca_sk_workers_compensation - ca_yt_workers_compensation is_default: type: boolean description: >- When true, this account is used for auto-enrollment of new work-assignments, and work-assignments without an existing enrollment for this authority. Only one account per authority per business may be the default at a time. is_editable: type: boolean description: >- When false, the account's `account_identifier` cannot be updated. Becomes false once the account is used on a non-draft payroll and an `account_identifier` is set; returns to true when every referencing payroll is reverted to draft or deleted. is_deletable: type: boolean description: >- When false, the account cannot be deleted. Becomes false once the account is referenced by any non-draft payroll; returns to true when every referencing payroll is reverted to draft or deleted. category: type: string nullable: true enum: - ca_benefit_provider - ca_provincial_government - ca_tax_agency - ca_union - ca_workers_compensation label: type: string maxLength: 255 label_translations: type: object description: Optional translations for the `label` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true label_translated: type: string description: >- The translation of the `label` property for the request locale. Computed using the values in `label` and `label_translations` and the value of the request's `Accept-Language` header. readOnly: true account_identifier: type: string nullable: true maxLength: 255 remitter_type: type: string description: >- The CRA remitter type for this account, which determines remittance due dates and reporting frequency. When null, falls back to the business entity's remitter type. nullable: true enum: - accelerated_threshold_1 - accelerated_threshold_2 - quarterly - regular remittance_management: type: string description: >- Whether remittances for this account are filed manually by the employer (`manual`) or handled automatically by Nmbr (`automatic`). Only accounts Nmbr can remit on your behalf (CRA, RQ, and Employer Health Tax authorities) may be set to `automatic`; all others are always `manual`. enum: - automatic - manual note: type: string nullable: true address_line_1: type: string nullable: true maxLength: 255 address_line_2: type: string nullable: true maxLength: 255 city: type: string nullable: true maxLength: 255 administrative_area: type: string nullable: true maxLength: 255 province_code: type: string nullable: true country_code: type: string nullable: true maxLength: 2 postal_code: type: string nullable: true maxLength: 10 has_payments: type: boolean current_enrollments_count: type: number nullable: true format: decimal pending_enrollments_count: type: number nullable: true format: decimal metadata: $ref: '#/components/schemas/RemittanceAccountMetadata' created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime Translations: type: object nullable: true properties: en: type: string maxLength: 255 fr: type: string maxLength: 255 RemittanceAccountMetadata: type: object description: >- Additional data points for this account. The available fields depend on the account's `category`; `null` for categories that capture no metadata. anyOf: - type: object title: Workers’ compensation properties: last_payment_amount: type: string description: >- The last payment made to the board before Nmbr takes over remittance, in dollars (e.g. `"1250.00"`). nullable: true format: decimal - type: object description: >- Categories with no category-specific metadata. Omit the field or send `null`. title: Other categories nullable: true nullable: true securitySchemes: CompanyToken: type: http scheme: bearer ````