Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

JustiFi Reports API

Reports can be used to pull data for various different resources. They are CSV format, and can be filtered by date and sub account.Once a the create endpoint is called via POST, a report will be in `created` status. The report will move to `processing` status once it is being generated.Finally, when the report is generated, and the CSV file is available, the report will be in `completed` status.To download a report, you can use the `download_url` provided in the response when retrieving a report. We use presigned URLs to allow you to download the report directlyfrom our S3 bucket.## Report Types### Payout ReportContains balance transaction data for payouts.| Column | Description || ------ | ----------- || id | Balance transaction ID || type | Transaction type || currency | Currency || amount | Amount in cents || fee | Fee amount in cents || net | Net amount in cents || source_id | Source object ID || source_account_id | Source account ID || source_type | Source object type || source_amount | Source amount in cents || available_on | When funds become available || payment_id | Associated payment ID || created_at | Creation timestamp || payment_method_name | Payment method name || source_payment_id | Payment ID associated with the source || payout_id | Associated payout ID || payout_created_at | Payout creation timestamp || payout_deposits_at | Expected payout deposit date |### Proceeds ReportContains platform proceeds data.| Column | Description || ------ | ----------- || id | Balance transaction ID || type | Transaction type || currency | Currency code || amount | Amount in cents || fee | Fee amount in cents || net | Net amount in cents || source_id | Source object ID || source_account_id | Source account ID || source_type | Source object type || source_amount | Source amount in cents || application_fee_amount | Application fee in cents || platform_fee_amount | Platform fee in cents || proceeds | Calculated proceeds in cents || available_on | When funds become available || created_at | Creation timestamp || fee_major_category | Fee major category || fee_minor_category | Fee minor category || fee_description | Fee description || fee_product_code | Fee product code || fee_batch_date | Fee batch date || payment_method_type | Payment method type || payment_method_brand | Payment method brand || source_payment_id | Payment ID associated with the source || payout_id | Associated payout ID || payout_created_at | Payout creation timestamp || payout_deposits_at | Expected payout deposit date |

JustiFi Reports API is one of 27 APIs that JustiFi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 3 operations across 2 paths, and defines 11 schemas. It is described by OpenAPI 3.0.0.

Requests are made against a single base URL, https://api.justifi.ai/v1.

3 operations 2 paths 11 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
Base URL
https://api.justifi.ai/v1
Terms of Service
Resource Areas
1

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Reports 3

Reports can be used to pull data for various different resources. They are CSV format, and can be filtered by date and sub account. Once a the create endpoint is called via POST,…

POST
/reports
Create a report
CreateReport 2 params body → 200
GET
/reports
List Reports
ListSubAccounts 3 params → 200
GET
/reports/{id}
Get a report
GetReport 3 params → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Report (12 properties), ReportPaymentListParameters (7 properties), Envelope (4 properties), ReportProceedsParameters (4 properties). Each schema is shown below with its type and property counts.

Envelope-list
object
4 properties
ReportParameters
Envelope
object
4 properties
ReportType
string
which report was generated
PageInfo
object
4 properties
Report
object
12 properties
ReportSubAccountSummaryParameters
object
4 properties 1 required
ReportPayoutParameters
object
4 properties 1 required
ReportProceedsParameters
object
4 properties 1 required
ReportInterchangeFeeParameters
object
4 properties 1 required
ReportPaymentListParameters
object
7 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

justifi-reports-api-openapi.yml Raw ↑

Other APIs JustiFi publishes across the network.

JustiFi Ach Return Fees API
JustiFi Address API
JustiFi API Credentials API
JustiFi Balance Transactions API
JustiFi Bank Account API
JustiFi Bind Insurance API
JustiFi Business API
JustiFi Checkouts API
JustiFi Disputes API
JustiFi Document API
JustiFi Fee Configurations API
JustiFi Identity API