Add Payouts with the API

Edited

Use the Lumanu API to add payouts straight from your own systems, such as a campaign tool, CRM, or internal platform. Payouts created through the API show up in your workspace like any other payout, and your team can approve and fund them in the dashboard or through the API.

In the API, payouts are called payables.

What you can do with the API

  • Create, approve, unapprove, and cancel payouts

  • Pay approved payouts from your balance, or create a funding invoice for them

  • Check a payout's status and get its invoice PDF

  • Invite vendors, and look them up by name, email, or Lumanu ID

  • See your workspace balance, transactions, and deposits that haven't been applied yet

  • List projects and see each project's balance

  • Get webhook notifications when a payout is created, approved, unapproved, canceled, or paid

What a payout needs

  • Vendor: Their email address, Lumanu ID, or workspace ID

  • Amount: In cents, so $1,500.00 is 150000

  • Description: What the payment is for

You can also add a due date, a project, custom field values, and line items. If the vendor isn't on Lumanu yet, you can have Lumanu send them an invite.

New payouts start in Needs approval, the same as payouts added in the dashboard.

Get set up

  1. Email support@lumanu.com to request API access. Lumanu sends you a client ID and client secret.

  2. Build and test in the sandbox first. It works like production without moving real money, and you can simulate deposits there.

  3. Switch to your production credentials when you're ready to go live. Keep separate credentials for each environment.

Developer docs

Was this article helpful?

Sorry about that! Care to tell us more?

Thanks for the feedback!

There was an issue submitting your feedback
Please check your connection and try again.