logo

Proceeds

Proceeds represent your platform's take-home portion of the fees from your sellers' financial transactions. Proceeds are batched together according to the payout schedule configured on your account, then transferred to your active bank account.

List Proceeds

List the proceeds payouts for your account. This endpoint supports pagination.

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 proceeds

get/platform/proceeds
Request samples 
Response samples 
application/json
{
  • "id": 1,
  • "type": "array",
  • "data": [
    ],
  • "page_info": {
    }
}
Get a Proceeds Payout
Get information about a proceeds 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 proceeds payout


get/platform/proceeds/{id}
Request samples 
Response samples 
application/json
{
  • "id": 1,
  • "type": "payout",
  • "data": [
    ],
  • "page_info": {
    }
}
➔ Next to Hosted Checkout