Skip to main content
POST
/
partners
/
payments
Find All Payments
curl --request POST \
  --url https://api.eflow.team/v1/partners/payments \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "timezone_id": 67,
  "from": "2024-01-01",
  "to": "2024-01-31",
  "query": {},
  "filter": {
    "payment_status": [
      "success"
    ]
  }
}
'
{
  "payments": [
    {
      "partner_payment_id": 123,
      "partner_id": 123,
      "network_id": 123,
      "partner_connection_id": 123,
      "payment_type": "pay",
      "payment_status": "pending",
      "payment_provider_payment_status": "unpaid",
      "amount": 123,
      "currency": "<string>",
      "payee_amount": 123,
      "payee_fee": 123,
      "payer_amount": 123,
      "payer_fee": 123,
      "time_created": 123,
      "time_saved": 123,
      "time_paid": 123
    }
  ],
  "paging": {
    "page": 123,
    "page_size": 123,
    "total_count": 123
  }
}

Authorizations

X-Eflow-Api-Key
string
header
required

The marketplace partner's API key. Uses the X-Eflow-Api-Key header. The key belongs to the marketplace partner user.

Query Parameters

page
integer
default:1

Page number (1-based).

page_size
integer
default:50

Number of results per page.

Body

application/json
timezone_id
integer
required

Timezone identifier for the request.

from
string
required

Start date for the payment search. Format yyyy-MM-dd.

to
string
required

End date for the payment search. Format yyyy-MM-dd.

query
object

Query configuration for additional filtering.

filter
object

Structured filters to narrow payment results.

Response

200 - application/json

OK

payments
object[]

Array of payment objects.

paging
object