Skip to content
Reference
/
reports

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
swagger.json
swagger.yaml
Overview
Talli API Support

api-support@talli.ai

License

Proprietary and Confidential

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

Get Campaign Payout Methods Report

Request

Retrieves a report detailing the distribution of payout methods selected by beneficiaries for a specific campaign.

Security
oauth2
Path
campaignIdstring(uuid)required
curl -i -X GET \
  'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/reports/campaigns/{campaignId}/payout-methods' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
campaignIdstring(uuid)

Unique identifier of the campaign

campaignNamestring

Name of the campaign

payoutMethodsArray of objects(Talli.Api.Contracts.Reporting.PayoutMethodUsage)

List of payout methods with their usage metrics

generationDatestring(date-time)

Date and time when this report was generated

totalCountinteger(int32)

Total count of payout instructions across all payout methods

totalAmountnumber(double)

Total monetary amount across all payout methods

Response
application/json
{
  "campaignId": "13f8bf6d-dc27-4a04-bffe-6e5b13c19ddf",
  "campaignName": "string",
  "payoutMethods": [
    { … }
  ],
  "generationDate": "2019-08-24T14:15:22Z",
  "totalCount": 0,
  "totalAmount": 0.1
}

Get Campaign Conversion Report

Request

Retrieves a report analyzing conversion metrics for a specific campaign, including notification delivery and payout claim rates.

Security
oauth2
Path
campaignIdstring(uuid)required
curl -i -X GET \
  'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/reports/campaigns/{campaignId}/conversion' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
campaignIdstring(uuid)

Unique identifier of the campaign

campaignNamestring

Name of the campaign

conversionStagesobject(Talli.Api.Contracts.Reporting.ConversionStages)
generationDatestring(date-time)

Date and time when this report was generated

Response
application/json
{
  "campaignId": "13f8bf6d-dc27-4a04-bffe-6e5b13c19ddf",
  "campaignName": "string",
  "conversionStages": {
    "eligible": { … },
    "communicated": { … },
    "actioned": { … },
    "completed": { … },
    "excluded": { … }
  },
  "generationDate": "2019-08-24T14:15:22Z"
}

Get Campaign Statistics Report

Request

Retrieves comprehensive statistics for a specific campaign, including overall performance metrics, budget utilization, and timeline analysis.

Security
oauth2
Path
campaignIdstring(uuid)required
curl -i -X GET \
  'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/reports/campaigns/{campaignId}/statistics' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
campaignIdstring(uuid)

Unique identifier of the campaign

campaignNamestring

Name of the campaign

metricsobject(Talli.Api.Contracts.Reporting.CampaignMetrics)
generationDatestring(date-time)

Date and time when this report was generated

Response
application/json
{
  "campaignId": "13f8bf6d-dc27-4a04-bffe-6e5b13c19ddf",
  "campaignName": "string",
  "metrics": {
    "totalFundsReceived": 0.1,
    "totalPayoutsSentAmount": 0.1,
    "totalPayoutsSentCount": 0,
    "totalPayoutsSentPrecentage": 0,
    "unredeemedFundsAmount": 0.1,
    "unredeemedFundsPercentage": 0,
    "availableToDisburse": 0.1,
    "availableToDisbursePercentage": 0,
    "numberOfBeneficiaries": 0
  },
  "generationDate": "2019-08-24T14:15:22Z"
}

Get Campaign Payouts History Report

Request

Retrieves a historical record of all payouts processed for a specific campaign, including timestamps, amounts, and status changes.

Security
oauth2
Path
campaignIdstring(uuid)required
curl -i -X GET \
  'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/reports/campaigns/{campaignId}/payouts-history' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
campaignIdstring(uuid)

Unique identifier of the campaign

campaignNamestring

Name of the campaign

reportPeriodobject(Talli.Api.Contracts.Reporting.PayoutsHistoryPeriod)
dailyActivityArray of objects(Talli.Api.Contracts.Reporting.DailyActivity)

List of daily payout activities within the report period

summaryobject(Talli.Api.Contracts.Reporting.PayoutsHistorySummary)
generationDatestring(date-time)

Date and time when this report was generated

Response
application/json
{
  "campaignId": "13f8bf6d-dc27-4a04-bffe-6e5b13c19ddf",
  "campaignName": "string",
  "reportPeriod": {
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z",
    "days": 0
  },
  "dailyActivity": [
    { … }
  ],
  "summary": {
    "payoutsSent": { … },
    "payoutsRedeemed": { … },
    "averagePayoutAmount": 0.1,
    "averageDailyPayouts": 0.1
  },
  "generationDate": "2019-08-24T14:15:22Z"
}

Get Campaign Basic Report

Request

Retrieves a basic CSV report for a specific campaign with sorting and pagination options. The report contains fundamental information about payout instructions and their current status.

Security
oauth2
Path
campaignIdstring(uuid)required
Query
pageNumberinteger(int32)required
pageSizeinteger(int32)required
sortByinteger(int32)(Talli.Campaigns.Contracts.Requests.BasicCampaignReportSortableColumn)
Enum"PayoutInstructionId""PayoutInstructionStatus""CreatedOn""UpdatedOn""BeneficiaryFirstName""BeneficiaryLastName""PayoutInstructionAmount""BeneficiaryEmail""BeneficiaryPhoneNumber""SelectedPayoutMethod"
sortDirectioninteger(int32)(Talli.Common.Contracts.Pagination.SortDirection)
Enum"Ascending""Descending"
curl -i -X GET \
  'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/reports/campaigns/{campaignId}/basic?pageNumber=0&pageSize=0&sortBy=PayoutInstructionId&sortDirection=Ascending' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodytext/csv
string
Response
No content

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

campaign-drafts

Operations

templates

Operations