Disbursements
/
Get Disbursement Intent Status

Get Disbursement Intent Status

GET
https://api.vivamo.co/v1/disbursement-intents/{disbursementIntentId}/status

Retrieve the current status of a disbursement intent by disbursementIntentId.

Once a disbursement exists, the top-level status mirrors that disbursement's status exactly — including approved, which an OTC payout holds until a venue cashier settles it in person. The intent's 2-hour window only bounds how long a disbursement may still be created against it; it never overrides the status of one already created.

no-disbursement means no disbursement has been created yet and the window is still open. expired means the window closed with no disbursement ever created — nothing was attempted, so this is not a failure.

Path parameters

    disbursementIntentId
    string
    Required
    The Vivamo disbursement intent ID returned when the intent was created.

Response

Disbursement intent status.
    status
    string

    The disbursement's status when one exists, otherwise no-disbursement or expired.

      no-disbursement
      string
      expired
      string
      pending-validation
      string
      pending
      string
      approved
      string
      success
      string
      failed
      string
      rejected
      string
      declined
      string
      voided
      string
      refunded
      string
    disbursement
    object
    Omitted entirely when no disbursement has been created.
      id
      string
      Unique disbursement ID.
      status
      string

      Disbursement status. approved means the payout has been authorised but not yet settled — an OTC payout stays approved until a venue cashier hands over the funds, which is normal and must not be treated as a failure.

        pending-validation
        string
        pending
        string
        approved
        string
        success
        string
        failed
        string
        rejected
        string
        declined
        string
        voided
        string
        refunded
        string
      createdAt
      string
      Timestamp when the disbursement was created.
      type
      string
      Payout method type used.
        card
        string
        bank
        string
        pay_by_bank
        string
        crypto
        string
        otc
        string
Built with