Skip to content

Talli Campaign Manager API (v2)

The Talli Campaign Manager API provides programmatic access to create and manage payout campaigns, payout instructions, and reports. This API powers the Talli console interface and can be integrated with third-party systems to automate workflows.

Key Resources

  • Campaigns: Create and manage fund distribution campaigns.
  • Campaign drafts: Create and manage campaign drafts.
  • Payout Instructions: Send and track payments to beneficiaries.
  • Payout Methods: View available payment methods (PayPal, ACH, gift cards, etc.).
  • Payouts: Details about selected payout
    • Gift Cards: View details of a gift card requested by the beneficiary
    • Prepaid Cards: View details of a prepaid card requested by the beneficiary
    • Transfers: View details of Paypal, Venmo or ACH transfer requested by the beneficiary
  • Reports: Access analytics and statistics about campaign performance.
  • Funding sources: Create and manage funding sources.
  • Templates: Create and manage templates.

Authentication

All requests require OAuth 2.0 authentication using Auth0 with appropriate scopes.

Download OpenAPI description
Overview
Languages
Servers
Mock server

https://docs.talli.ai/_mock/reference/swagger/

campaigns

Endpoints for creating and managing campaigns. A campaign represents a distribution of funds to multiple beneficiaries.

Operations

payout-instructions

Endpoints for creating and managing payout instructions. A payout instruction represents an intention to pay a specific amount of money to a beneficiary.It is associated with one and only one campaign.

Operations

payout-methods

Endpoints for viewing and managing available payout methods, such as ACH, PayPal, and gift cards.

Operations

reports

Endpoints for accessing analytics and reporting data about campaigns and payouts.

Operations

ach-transfers

Endpoints for managing ACH bank transfers as a payout method.

Operations

gift-cards

Endpoints for managing gift card payouts and retrieving gift card details.

Operations

paypal-transfers

Endpoints for managing PayPal payouts and retrieving PayPal transfer details.

Operations

prepaid-cards

Endpoints for managing prepaid card payouts and retrieving prepaid card details.

Operations

venmo-transfers

Endpoints for managing Venmo transfers and retrieving Venmo transaction details.

Operations

funding-sources

Represents an account connected to a business entity that can be used as a source of funds for one or multiple campaigns. Each funding source corresponds to a separate bank account in our payment system and maintains it's own banking details and fund management capabilities

Operations

List Funding Sources

Request

Retrieves a paginated list of funding sources for the organization. Funding sources represent accounts that can be used to fund campaigns, including the primary organization account and settlement funds.

Security
oauth2
Query
pageinteger(int32)
Default 1
pageSizeinteger(int32)
Default 20
curl -i -X GET \
  'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/funding-sources?page=1&pageSize=20' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
pageNumberinteger(int32)
pageSizeinteger(int32)
totalPagesinteger(int32)read-only
totalItemsinteger(int32)
dataArray of objects(Talli.Api.Contracts.FundingSource.FundingSourceResponse)
Response
application/json
{ "pageNumber": 0, "pageSize": 0, "totalPages": 0, "totalItems": 0, "data": [ { … } ] }

Create Settlement Fund

Request

Creates a new settlement fund (FBO account) for the organization. The settlement fund inherits business details from the organization's primary account and requires a settlement fund name plus optional supporting documents.

Security
oauth2
Bodymultipart/form-data
settlementFundNamestring
w9Formstring or null(binary)
finalApprovalOrderstring or null(binary)
preliminaryApprovalOrderstring or null(binary)
settlementAgreementstring or null(binary)
curl -i -X POST \
  https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/funding-sources \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F settlementFundName=string \
  -F w9Form=string \
  -F finalApprovalOrder=string \
  -F preliminaryApprovalOrder=string \
  -F settlementAgreement=string

Responses

Created

Bodyapplication/json
idstring(uuid)
namestring
typeinteger(int32)(Talli.Api.Contracts.FundingSource.FundingSourceType)
Enum"OrganizationAccount""SettlementFund"
statusinteger(int32)(Talli.Api.Contracts.FundingSource.FundingSourceStatus)
Enum"Pending""Active""Rejected"
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "type": "OrganizationAccount", "status": "Pending" }

Get Funding Source

Request

Retrieves a specific funding source by its unique identifier. Returns the funding source details including banking information and current status.

Security
oauth2
Path
idstring(uuid)required
curl -i -X GET \
  'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/funding-sources/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
idstring(uuid)
namestring
typeinteger(int32)(Talli.Api.Contracts.FundingSource.FundingSourceType)
Enum"OrganizationAccount""SettlementFund"
statusinteger(int32)(Talli.Api.Contracts.FundingSource.FundingSourceStatus)
Enum"Pending""Active""Rejected"
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "type": "OrganizationAccount", "status": "Pending" }

campaign-drafts

Operations

templates

Operations