List Commissions - Reditus docs

GET

commissions

List Commissions

curl --request GET \
  --url https://api.getreditus.com/api/v1/commissions \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {
        "state": "<string>",
        "amount": 123,
        "currency": "<string>",
        "partner_id": "<string>",
        "referral_id": "<string>",
        "reject_reason": "<string>",
        "state_set_at": 123,
        "paid_at": 123,
        "created_at": 123,
        "updated_at": 123
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 123,
      "per_page": 123,
      "has_more": true
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

state_eq

string

Filter by state (pending, rejected, paid)

partner_id_eq

string

Filter by partner ID

created_at_lt

string

Created before (e.g. "2022-12-24%2012:47:45%20+0200")

created_at_gt

string

Created after (e.g. "2021-11-23%2012:47:45%20+0200")

state_set_at_lt

string

State set at before (e.g. "2022-12-24%2012:47:45%20+0200")

state_set_at_gt

string

State set at after (e.g. "2021-12-24%2012:47:45%20+0200")

page

integer

Page number

per_page

integer

Records to be displayed per page

Required range: x <= 50

Response

200 - application/json

Successful response

data

object[]

Show child attributes

meta

object

Show child attributes

Show CommissionShow data for a commission.

List Commissions

curl --request GET \
  --url https://api.getreditus.com/api/v1/commissions \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {
        "state": "<string>",
        "amount": 123,
        "currency": "<string>",
        "partner_id": "<string>",
        "referral_id": "<string>",
        "reject_reason": "<string>",
        "state_set_at": 123,
        "paid_at": 123,
        "created_at": 123,
        "updated_at": 123
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 123,
      "per_page": 123,
      "has_more": true
    }
  }
}