Using Shared Wallets on API Created Jobs and Capture Requests

Overview of Wallet Share

Wallet shares enable you to share your wallet to another organization. This is useful when you are contracting out capture to another company, or in general when you need to pay for a job outside of your org.

Getting started

To use shared wallets, first ask your Hover rep to create a shared wallet for your Org and the Org you would like to share a wallet to/from. Once set up, the Hover rep will share the Wallet ID to you.

Using a shared Wallet ID

Use the Wallet ID as the job[wallet_id] body parameter in your request to create Jobs or Capture Requests via the API. This can be seen in the parameters for Capture Requests here. The Jobs API reference doc will be updated shortly, but the same flow exists using the job[wallet_id] body parameter.

All jobs created with the shared wallet's ID will charge the shared wallet of the other Org and the both Orgs will have access to view the Job and its details.