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. Returns the overall status (pending-validation, pending, success, failed, rejected) and the disbursement record.

Path parameters

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

Response

Disbursement intent status.
    status
    string
    Overall intent status.
      pending-validation
      string
      pending
      string
      success
      string
      failed
      string
      rejected
      string
    disbursement
    object
    An individual disbursement record within a disbursement intent.
      id
      string
      Unique disbursement ID.
      status
      string
      Disbursement status.
        pending-validation
        string
        pending
        string
        success
        string
        failed
        string
        rejected
        string
        declined
        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
      messages
      array of object
      Processing messages associated with this disbursement.
Built with