logo

Payouts

Each day, a payout containing that day's funds is automatically created for the purpose of distributing those funds to the active bank account. Payout amounts are calculated by summing the associated balance transactions for that specific day.

List Payouts

Request
query Parameters
created_before
string <datetime>

Filter records which were created before the date or datetime specified. UTC time. Dates without time specified will default to 00:00:00

Example: created_before=2022-01-01T00:00:00Z
created_after
string <datetime>

Filter records which were created after the date or datetime specified. UTC time. Dates without time specified will default to 00:00:00

Example: created_after=2022-01-01T00:00:00Z
deposits_before
string <datetime>

Filter records which deposit before the date or datetime specified. UTC time. Dates without time specified will default to 00:00:00

Example: deposits_before=2022-01-01T00:00:00Z
deposits_after
string <datetime>

Filter records which deposit after the date or datetime specified. UTC time. Dates without time specified will default to 00:00:00

Example: deposits_after=2022-01-01T00:00:00Z
header Parameters
Authorization
required
string

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Example: Bearer {access_token}
Responses
200

Successfully list payouts

get/payouts
Request samples 
Response samples 
application/json
{
  • "id": 1,
  • "type": "array",
  • "data": [
    ],
  • "page_info": {
    }
}
Get a Payout
Get information about a payout.


Request 
path Parameters
id
required
string <uuid> 
 
header Parameters
Authorization
required
string
the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)


 
 Example:  Bearer {access_token}
Responses 
200
Successfully get a payout


get/payouts/{id}
Request samples 
Response samples 
application/json
{
  • "id": 1,
  • "type": "payout",
  • "data": {
    },
  • "page_info": "string"
}
Update a Payout
Change a payout's metadata.


Request 
path Parameters
id
required
string <uuid> 
 
header Parameters
Idempotency-Key
required
string <uuid> 
a string to identify your request (we recommend using a generated uuid, but you may use any unique string) see Idempotent Requests


 
 Example:  my-request-123abc
Authorization
required
string
the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)


 
 Example:  Bearer {access_token}
Request Body schema: application/json
metadata
object <json> 
any useful information you'd like to store alongside this payout; when you update metadata, any previous metadata will be overwritten


 
Responses 
200
Payout update was successful


patch/payouts/{id}
Request samples 
application/json
{
  • "metadata": {
    }
}
Response samples 
application/json
{
  • "id": 1,
  • "type": "payout",
  • "data": {
    },
  • "page_info": "string"
}
Get a Payout CSV Report
Get a link to a CSV report with information a payout and balance transactions related to that payout. CSV report headers include id, currency, amount, fee, net, source_id, source_account_id, source_type, source_amount, available_on and created_at.


Request 
path Parameters
id
required
string <uuid> 
 
header Parameters
Authorization
required
string
the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)


 
 Example:  Bearer {access_token}
Responses 
200
Successfully get a link to a csv report for a payout


get/reports/payouts/{id}
Request samples 
Response samples 
application/json
{}
➔ Next to Balance Transactions