Sign in
payments

List unpaid transactions

get/admin/payments/transactions/unpaid

Query parameters

uptostring

Fetch unpaid transactions up to this date (YYYY-MM-DD format)

affiliate_idstring

Filter transactions by affiliate ID

group_idstring

Filter transactions for affiliates belonging to this group

tagstring

Filter transactions for affiliates with this tag

payment_methodstring

Filter transactions for affiliates with this payment method

affiliate_status'all' | 'approved' | 'invited' | 'blocked'

Filter transactions by affiliate status. Defaults to approved/invited. Use 'all' for all statuses or 'blocked' for blocked affiliates

tx_typestring

Filter by transaction type (e.g. 'orders' or 'rewards' or 'compensation_plan'). Returns all by default

Response

affiliatesobject

Map of affiliate_id to affiliate details for all affiliates present in the transactions

currency_conversion_multiplierobject

Map of currency code to conversion multiplier

Example response

{
  "transactions": [
    {
      "tx_id": 283381,
      "affiliate_id": 227847,
      "amount": 35,
      "currency": "USD",
      "event_type": "insert",
      "entity_type": "rewards",
      "entity_id": 69462,
      "metadata": {
        "reward_type": "signup_bonus",
        "amount": 35,
        "status": "approved"
      },
      "created_at": "2019-09-09T09:05:49.000Z"
    }
  ],
  "affiliates": {
    "123456": {
      "affiliate_id": 123456,
      "tin": null,
      "phone": null,
      "group_id": null,
      "vat_exempt": false,
      "country": "US",
      "name": "Jane Smith",
      "email": "jane.smith@example.com",
      "payment_method": "bank_transfer",
      "payment_details_data": null,
      "conversion_rate": 1,
      "currency": "USD"
    },
    "227847": {
      "affiliate_id": 227847,
      "tin": null,
      "phone": null,
      "group_id": null,
      "vat_exempt": true,
      "country": null,
      "name": "Dalinar Kholin",
      "email": "automaticenrollme@mailinator.com",
      "payment_method": "paypal",
      "payment_details_data": null,
      "conversion_rate": 1,
      "currency": "USD"
    }
  },
  "currency_conversion_multiplier": {
    "USD": 1
  }
}

Changes

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