Earnings

Operations for Earnings / Payments

Find All Payments

POST /v1/partners/payments

This endpoint allows you to retrieve a list of all payments, with filtering and pagination options.

Paging

This endpoint supports paging. Refer to our User Guide for usage.

timezone_id int

The timezone ID for the request.

from string

Start date for filtering payments (format: “yyyy-MM-dd”).

to string

End date for filtering payments (format: “yyyy-MM-dd”).

query object

Query parameters for filtering payments.

search_terms object array

Terms used to filter the data.

search_type string

Type of the terms of the search. Can be one of the following values: network_name.

value string

Value of the term to filter by.

filter object

Structured filters for payments.

partner_connection_ids int array

List of partner connection IDs to filter by.

payment_types string array

List of payment types to filter by. Can be one of the following values: pay, veem or tipalti.

network_ids int array

List of network IDs to filter by.

payment_status string

Affiliate payment status to filter by. Can be one of the following values: pending, rejected, success or scheduled.

payment_provider_payment_status string

Payment provider status to filter by. Can be one of the following values: unpaid, in_progress, paid or rejected.

The following examples are different variations of what you can pass as a payload in the following call :

cURL
curl --request POST 'https://api.eflow.team/v1/partners/payments' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Example 1 : Fetch payments for a specific date range and filter by status

{
  "timezone_id":80,
  "from":"2025-10-22",
  "to":"2025-11-21",
  "query":{
    "search_terms":[],
    "filter":{
      "partner_connection_ids":[],
      "payment_types":["pay"],
      "network_ids":[15],
      "payment_provider_payment_status": "paid"
    }
  }
}

To fetch payments using Example 1, you would run the following call:

curl --request POST 'https://api.eflow.team/v1/partners/payments?page=1&page_size=100' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "timezone_id":80,
  "from":"2025-10-22",
  "to":"2025-11-21",
  "query":{
    "search_terms":[],
    "filter":{
      "partner_connection_ids":[],
      "payment_types":["pay"],"network_ids":[15],
      "payment_provider_payment_status":"paid"
    }
  }
}'
Response
{
    "payments": [
        {
            "partner_payment_id": 17,
            "partner_id": 17,
            "network_id": 15,
            "partner_connection_id": 33,
            "payment_type": "tipalti",
            "payment_status": "success",
            "payment_provider_payment_status": "paid",
            "time_invoice_approved": 0,
            "time_payment_approved": 0,
            "time_payment_completed": 0,
            "amount": 1108.8445,
            "currency": "GBP",
            "network_name": "Network Name",
            "payee_original_amount": 29179679.02,
            "payee_fee_amount": 755753.93,
            "payee_paid_amount": 28423925.09,
            "payee_currency": "VND",
            "network_affiliate_payment_id": 45,
            "network_affiliate_invoice_id": 84,
            "time_created": 1762890676,
            "time_approved": 1762890817,
            "time_completed": 1762892530
        },
        {
            "partner_payment_id": 18,
            "partner_id": 17,
            "network_id": 15,
            "partner_connection_id": 33,
            "payment_type": "pay",
            "payment_status": "success",
            "payment_provider_payment_status": "paid",
            "time_invoice_approved": 0,
            "time_payment_approved": 0,
            "time_payment_completed": 0,
            "amount": 283.55,
            "currency": "GBP",
            "network_name": "Network Name",
            "payee_original_amount": 7461760.02,
            "payee_fee_amount": 193259.64,
            "payee_paid_amount": 7268500.38,
            "payee_currency": "VND",
            "network_affiliate_payment_id": 46,
            "network_affiliate_invoice_id": 85,
            "time_created": 1762890794,
            "time_approved": 1762891243,
            "time_completed": 1762892527
        },
        {
            "partner_payment_id": 21,
            "partner_id": 17,
            "network_id": 15,
            "partner_connection_id": 34,
            "payment_type": "pay",
            "payment_status": "success",
            "payment_provider_payment_status": "paid",
            "time_invoice_approved": 0,
            "time_payment_approved": 0,
            "time_payment_completed": 0,
            "amount": 380.91,
            "currency": "USD",
            "network_name": "Network Name",
            "payee_original_amount": 380.91,
            "payee_fee_amount": 0,
            "payee_paid_amount": 380.91,
            "payee_currency": "USD",
            "network_affiliate_payment_id": 47,
            "network_affiliate_invoice_id": 86,
            "time_created": 1762892408,
            "time_approved": 1762892672,
            "time_completed": 1762892974
        },
        {
            "partner_payment_id": 22,
            "partner_id": 17,
            "network_id": 15,
            "partner_connection_id": 34,
            "payment_type": "pay",
            "payment_status": "success",
            "payment_provider_payment_status": "paid",
            "time_invoice_approved": 0,
            "time_payment_approved": 0,
            "time_payment_completed": 0,
            "amount": 382.91,
            "currency": "USD",
            "network_name": "Network Name",
            "payee_original_amount": 382.91,
            "payee_fee_amount": 0,
            "payee_paid_amount": 382.91,
            "payee_currency": "USD",
            "network_affiliate_payment_id": 48,
            "network_affiliate_invoice_id": 89,
            "time_created": 1762892976,
            "time_approved": 1762893007,
            "time_completed": 1762893346
        },
        {
            "partner_payment_id": 23,
            "partner_id": 17,
            "network_id": 15,
            "partner_connection_id": 34,
            "payment_type": "veem",
            "payment_status": "success",
            "payment_provider_payment_status": "paid",
            "time_invoice_approved": 0,
            "time_payment_approved": 0,
            "time_payment_completed": 0,
            "amount": 100,
            "currency": "USD",
            "network_name": "Network Name",
            "payee_original_amount": 100,
            "payee_fee_amount": 0,
            "payee_paid_amount": 100,
            "payee_currency": "USD",
            "network_affiliate_payment_id": 52,
            "network_affiliate_invoice_id": 93,
            "time_created": 1763066964,
            "time_approved": 1763067256,
            "time_completed": 1763067331
        }
    ],
    "paging": {
        "page": 1,
        "page_size": 100,
        "total_count": 5
    }
}