Disbursements
/
Proceed With Disbursement

Proceed With Disbursement

POST
https://api.vivamo.co/v1/disbursements/{disbursementIntentId}/proceed/{allow}

Approve or reject a disbursement in pending-validation status. Set allow: true to approve (sends funds immediately) or allow: false to reject (no funds transferred).

Path parameters

    disbursementIntentId
    string
    Required
    The Vivamo disbursement intent ID from the pending-validation list.
    allow
    boolean
    Required

    true to approve the disbursement, false to reject it.

Response

Disbursement approved and sent for processing, or rejected.
    disbursementId
    string
    Unique disbursement ID.
    amount
    string
    The payout amount.
    externalCustomerId
    string
    The customer identifier you provided.
    externalDisbursementId
    string
    Your unique identifier for this disbursement.
    currency
    string
    The currency code.
    status
    string

    The updated status — pending if approved, rejected if rejected.

      pending
      string
      rejected
      string
Built with