JUjustifi
Proceeds

List Proceeds

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

get/proceeds

Request

Query parameters

created_beforestring date-time

filter records which were created before the date and time (UTC) specified. Dates without time specified will default to 00:00:00

created_afterstring date-time

filter records which were created after the date and time (UTC) specified. Dates without time specified will default to 00:00:00

deposits_beforestring date-time

filter records which deposit before the date and time (UTC) specified. Dates without time specified will default to 00:00:00

deposits_afterstring date-time

filter records which deposit after the date and time (UTC) specified. Dates without time specified will default to 00:00:00

Headers

Authorizationstring required

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

Response

Successfully list proceeds

idnumber

the object id

typestring

the object type, or array of objects

Example response

{
  "id": 1,
  "type": "array",
  "data": [
    {
      "id": "po_xyz",
      "amount": 100000,
      "bank_account": {
        "country": "US",
        "currency": "usd"
      },
      "currency": "usd",
      "deposits_at": "2021-01-01T12:00:00Z",
      "refunds_count": 5,
      "refunds_total": 10000,
      "payments_count": 50,
      "payments_total": 110000,
      "other_total": 100,
      "platform_fees_total": 271961,
      "justifi_fees_total": 703,
      "interchange_network_fees": -10318,
      "status": "scheduled",
      "metadata": {
        "platform_payout_id": "cp_12345"
      },
      "created_at": "2021-01-01T12:00:00Z",
      "updated_at": "2021-01-01T12:00:00Z"
    }
  ],
  "page_info": {
    "end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd",
    "start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.