> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cadanapay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Disbursement

> Fetch a single disbursement by ID.



## OpenAPI

````yaml /openapi/workforce-management.yaml get /v1/platform/disbursements/{disbursementId}
openapi: 3.0.0
info:
  description: APIs for interacting with Cadana Payroll Platform
  version: 1.0.0
  title: Business Workforce Management
  termsOfService: https://cadanapay.com/terms-and-conditions
  contact:
    email: api@cadanapay.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.cadanapay.com
    description: Prod Server
  - url: https://dev-api.cadanapay.com
    description: Dev Server
security:
  - Authorization: []
tags:
  - name: Custom Auth
    description: APIs for interacting with Custom Authentication
  - name: Persons
    description: APIs for interacting with the HR module
  - name: Milestones
    description: APIs for milestone-based contractor pay
  - name: Instant Pay
    description: APIs for interacting with Instant Pay functionality
  - name: Users
    description: APIs for interacting with employee/contractor Cadana accounts
  - name: Files
    description: APIs for interacting with file uploads
  - name: Payrolls
    description: APIs for interacting with Payroll
  - name: Platform
    description: Platform APIs for interacting with businesses
  - name: Businesses
    description: APIs for interacting with Business
  - name: Contracts
    description: APIs for interacting with contracts
  - name: Sandbox
    description: APIs for relevant sandbox simulations
  - name: Invoices
    description: APIs for interacting with invoices
  - name: Reimbursements
    description: APIs for interacting with reimbursements
  - name: Entities
    description: >-
      APIs for managing legal sub-entities (subsidiaries, branches) under a
      parent business
paths:
  /v1/platform/disbursements/{disbursementId}:
    get:
      tags:
        - Platform
      summary: Get Disbursement
      description: Fetch a single disbursement by ID.
      operationId: getPlatformDisbursement
      parameters:
        - $ref: '#/components/parameters/disbursementId'
      responses:
        '200':
          $ref: '#/components/responses/GetPlatformDisbursementResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        5XX:
          $ref: '#/components/responses/InternalError'
      security:
        - Authorization: []
components:
  parameters:
    disbursementId:
      name: disbursementId
      in: path
      description: The unique identifier for the disbursement
      required: true
      schema:
        type: string
        format: uuid
  responses:
    GetPlatformDisbursementResponse:
      description: Disbursement details
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformDisbursement'
    BadRequestError:
      description: Bad input provided by client
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
    NotFoundError:
      description: Requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NotFoundError'
    InternalError:
      description: Internal error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalError'
  schemas:
    PlatformDisbursement:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique transaction identifier
          example: 87eec1a4-d757-45be-a75e-f3638d044750
        tenantKey:
          type: string
          description: Identifies which business this transaction belongs to
          example: tbl28153208
        status:
          type: string
          description: Transaction status
          enum:
            - SUCCESS
            - FAILED
            - INITIATED
            - PROCESSING
            - ROUTED
          example: SUCCESS
        referenceId:
          type: string
          format: uuid
          description: >-
            External reference ID. Payroll transactions from the same run share
            the same referenceId.
          example: 9c4829a8-0177-4dad-a0d8-e4f8fc42276a
        description:
          type: string
          description: Human-readable description of the transaction
          example: January 2026 Payment
        type:
          type: string
          description: >
            Transaction type. The possible values depend on the endpoint — see
            the operation description for the set each endpoint returns. A
            business disbursement is one of: PAYROLL_TOTAL, PAYROLL,
            PAYROLL_FEE, PAYROLL_REVERSAL, DEPOSIT, DEPOSIT_REVERSAL, VENDOR,
            REVENUE_SHARE_PAYOUT, REIMBURSEMENT, SUBSCRIPTION_PAYMENT,
            STATUTORY_DEPOSIT.
          enum:
            - PAYOUT
            - PAYROLL
            - PAYROLL_TOTAL
            - PAYROLL_FEE
            - PAYROLL_REVERSAL
            - VENDOR
            - DEPOSIT
            - DEPOSIT_REVERSAL
            - REVENUE_SHARE_PAYOUT
            - REIMBURSEMENT
            - SUBSCRIPTION_PAYMENT
            - STATUTORY_DEPOSIT
            - CARD_MAINTENANCE_FEE
            - CARD_CREATION_FEE
            - STOCK_BUY
            - STOCK_SELL
            - INTEREST
          example: PAYROLL_TOTAL
        fxRate:
          type: number
          nullable: true
          description: >-
            Foreign exchange rate applied. Only present for cross-currency
            transactions.
          example: 5.7896
        paymentMethod:
          type: string
          description: How funds were delivered
          enum:
            - bank
            - momo
            - wallet
            - ach
            - card
            - proxy
          example: bank
        paymentDetails:
          $ref: '#/components/schemas/paymentMethods'
        userId:
          type: string
          format: uuid
          description: >-
            The wallet/user account ID. Present on wallet-based transactions.
            For payroll, only present when payment is delivered to a wallet.
          example: 8cb1d569-5dfd-4b33-b25e-4fab0ee14251
        personId:
          type: string
          format: uuid
          nullable: true
          description: The employee or contractor ID. Present only on payroll transactions.
          example: 7fc25070-8037-44f8-8c42-9d05ffc01f0b
        userName:
          type: string
          description: Recipient name
          example: Paula Torres
        amount:
          description: Amount the recipient receives in the destination currency
          allOf:
            - $ref: '#/components/schemas/Amount'
        sourceAmount:
          description: Cost in the source currency before fees
          allOf:
            - $ref: '#/components/schemas/Amount'
        feeAmount:
          description: Fees charged in the source currency
          allOf:
            - $ref: '#/components/schemas/Amount'
        totalAmount:
          description: Total debited from the sender (sourceAmount + feeAmount)
          allOf:
            - $ref: '#/components/schemas/Amount'
        fxRevenueShare:
          nullable: true
          description: Revenue earned from the FX spread. Only present when applicable.
          allOf:
            - $ref: '#/components/schemas/RevenueShare'
        feeRevenueShare:
          nullable: true
          description: Revenue earned from transaction fees. Only present when applicable.
          allOf:
            - $ref: '#/components/schemas/RevenueShare'
        totalRevenueShare:
          nullable: true
          description: Combined total revenue share
          allOf:
            - $ref: '#/components/schemas/Amount'
        estimatedDelivery:
          type: string
          nullable: true
          description: Estimated time the funds will be delivered to the recipient
        externalReference:
          type: string
          nullable: true
          description: External reference associated with the transaction, when available
        createdTimestamp:
          type: string
          description: Timestamp when the transaction was created
          example: 2026-01-28 14:29:09 +0000 UTC
        lastUpdatedTimestamp:
          type: string
          description: Timestamp when the transaction was last updated
          example: 2026-01-28 14:29:18 +0000 UTC
    BadRequestError:
      description: Bad input provided by client
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            params:
              description: A map for meta data around the error that occurred
              type: object
      example:
        code: invalid_request_body
        message: The request body provided is not valid
        params:
          field: Value is invalid.
    NotFoundError:
      description: Not Found
      allOf:
        - $ref: '#/components/schemas/Error'
      example:
        code: resource_not_found
        message: Requested resource could not be found.
    InternalError:
      description: Internal server error
      allOf:
        - $ref: '#/components/schemas/Error'
      example:
        code: internal_error
        message: An unexpected error occurred. Please try again later.
    paymentMethods:
      type: object
      required:
        - preferredMethod
      properties:
        preferredMethod:
          type: string
          enum:
            - momo
            - bank
            - swift
            - ach
            - wallet
            - wire
          description: The preferred payment method type
          example: bank
        momo:
          $ref: '#/components/schemas/momoDetails'
        bank:
          $ref: '#/components/schemas/bankDetails'
        swift:
          $ref: '#/components/schemas/swiftDetails'
        ach:
          $ref: '#/components/schemas/achDetails'
        wallet:
          $ref: '#/components/schemas/walletDetails'
        wire:
          $ref: '#/components/schemas/wireDetails'
    Amount:
      type: object
      required:
        - value
        - currency
      properties:
        value:
          type: string
          description: The value of the amount
          example: '10.00'
        currency:
          type: string
          description: The currency of the asset
          example: USD
    RevenueShare:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/Amount'
        rate:
          type: number
          description: The revenue share percentage
          example: 1
    Error:
      type: object
      properties:
        code:
          description: A machine parsable error code
          type: string
          enum:
            - invalid_request_body
            - resource_not_found
            - forbidden
            - internal_error
        message:
          description: A human readable message describing the error
          type: string
    momoDetails:
      type: object
      properties:
        accountName:
          type: string
          description: The name associated with the mobile money account
          example: John Doe
        provider:
          type: string
          description: The name of the mobile money provider
          example: MTN
        providerCode:
          type: string
          description: The code identifying the mobile money provider
          example: MTN
        phoneNumber:
          $ref: '#/components/schemas/phoneNumber'
        currency:
          type: string
          description: The currency of the mobile money account
          example: GHS
    bankDetails:
      type: object
      properties:
        accountName:
          type: string
          description: The name on the bank account
          example: John Doe
        accountNumber:
          type: string
          description: The bank account number
          example: '1234567890'
        accountType:
          type: string
          description: The type of bank account (e.g., Checking, Savings)
          example: Checking
        ownerType:
          type: string
          description: The type of account owner (e.g., individual, business)
          example: individual
        bankCode:
          type: string
          description: The bank identification code
          example: EXMPJPJT
        bankName:
          type: string
          description: The name of the bank
          example: Gotham City Bank
        branchName:
          type: string
          description: The name of the bank branch
          example: Downtown Branch
        sortCode:
          type: string
          description: The bank sort code (used in some countries like UK)
          example: '401234'
        iban:
          type: string
          description: The International Bank Account Number
          example: GB00000000000000000000
        provider:
          type: string
          description: The platform providing this account (e.g., wise)
          example: wise
        currency:
          type: string
          description: The currency of the bank account
          example: USD
        beneficiaryId:
          $ref: '#/components/schemas/beneficiaryId'
        address:
          $ref: '#/components/schemas/address'
        phoneNumber:
          $ref: '#/components/schemas/phoneNumber'
        email:
          type: string
          format: email
          description: The email address of the account holder
          example: john.doe@example.com
    swiftDetails:
      type: object
      required:
        - currency
        - iban
        - accountName
        - accountNumber
        - bankName
        - swiftCode
        - address
      properties:
        currency:
          type: string
          description: The currency of the bank account
          example: EUR
        iban:
          type: string
          description: The International Bank Account Number
          example: DE00000000000000000000
        accountName:
          type: string
          description: The name on the bank account
          example: John Doe
        accountNumber:
          type: string
          description: The bank account number
          example: '1234567890'
        bankName:
          type: string
          description: The name of the bank
          example: Example Bank
        swiftCode:
          type: string
          description: The SWIFT/BIC code of the bank
          example: EXMPDEFF
        address:
          $ref: '#/components/schemas/address'
    achDetails:
      type: object
      properties:
        bankName:
          type: string
          description: The name of the bank
          example: Example Bank
        accountName:
          type: string
          description: The name on the bank account
          example: John Doe
        routingNumber:
          type: string
          description: The ACH routing number of the bank
          example: '000000000'
        accountNumber:
          type: string
          description: The bank account number
          example: '1234567890'
        accountType:
          type: string
          description: The type of bank account (Checking or Savings)
          example: Checking
        provider:
          type: string
          description: The platform providing this account (e.g., wise)
          example: wise
        address:
          $ref: '#/components/schemas/address'
    walletDetails:
      type: object
      properties:
        type:
          type: string
          description: The type of wallet account
          enum:
            - user
            - business
          example: user
        identifier:
          type: string
          description: The unique identifier for the wallet account
          example: 69a2a928-ed49-4e53-92ec-a72b4ee7eacc
        currency:
          type: string
          description: The currency of the wallet
          example: USD
    wireDetails:
      type: object
      description: Wire transfer payment details
      properties:
        bankName:
          type: string
          description: The name of the bank
          example: Example Bank
        accountName:
          type: string
          description: The name on the account
          example: John Doe
        routingNumber:
          type: string
          description: The routing number
          example: '000000000'
        accountNumber:
          type: string
          description: The account number
          example: '123456789'
        address:
          $ref: '#/components/schemas/address'
    phoneNumber:
      type: object
      description: Person's phone number
      properties:
        countryCode:
          type: string
          example: '1'
        number:
          type: string
          example: '2345678901'
    beneficiaryId:
      type: object
      description: ID details for the beneficiary
      properties:
        type:
          type: string
          enum:
            - NIT
            - CC
            - CE
            - TI
            - PASS
          description: Type of beneficiary ID
          example: NIT
        value:
          type: string
          description: ID number of the beneficiary
          example: '123456789'
    address:
      type: object
      description: Address
      required:
        - countryCode
      properties:
        line1:
          type: string
          example: Street 1
        line2:
          type: string
          example: Apt 1
        city:
          type: string
          example: Gotham
        postalCode:
          type: string
          example: '10001'
        state:
          type: string
          example: NY
        countryCode:
          type: string
          example: US
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      bearerFormat: API_SECRET_KEY

````