Skip to main content

Payment

A payment

A payment groups the approved conversions it settles. Reached through affiliates { payments }, the totals are recalculated from that affiliate's share of the payment rather than the payment as a whole.

caution

Cancelled payments are excluded only when the query carries at least one argument — any argument, including limit. A bare payments { … } with no arguments returns cancelled payments alongside the rest.

Fields

FieldTypeAvailabilityNotes
idInt!The record's Refersion id.
createdStringUnix timestamp in seconds, not an ISO 8601 date.
total_conversionsIntCounted from the payment's approved conversions when you query it.
totalStringSummed from the payment's approved conversions when you query it, rather than read from the payment record.
commission_totalStringSummed from the payment's approved conversions when you query it, rather than read from the payment record.
currencyStringISO 4217 currency code.
payment_methodStringHow the payment was made.
noteString
shopShop
conversions[Conversion]Takes arguments — see below.
affiliates[Affiliate]Takes arguments — see below.

Sorting

sort accepts id, created, commission_total, total on this type, and sorts descending. Any other value is ignored without an error.

Field arguments

conversions

ArgumentTypeNotes
idIDReturns only the record with this id.
statusStringExact match. The returned type lists the values that can appear.
typeStringExact match. The returned type lists the values that can appear.
created_fromIntUnix timestamp in seconds. Exclusive — matches rows created strictly after it.
created_toIntUnix timestamp in seconds. Inclusive — matches rows created at or before it.
affiliate_idIDReturns only records belonging to this affiliate.
offer_idIDReturns only records tied to this offer.
sortStringField to sort by, descending. Each type accepts its own short list — see Sorting on the returned type's page. Anything else is ignored without an error.
limitIntRows to return. Anything outside 1–200 is replaced by 200.
beforeIDReturns only rows with an id lower than this. Cursor-style paging.
afterIDReturns only rows with an id higher than this. Cursor-style paging.
offsetIntRows to skip before returning results.

affiliates

ArgumentTypeNotes
idIDReturns only the record with this id.
statusStringExact match. The returned type lists the values that can appear.
emailStringExact match on the affiliate's email address.
created_fromIntUnix timestamp in seconds. Exclusive — matches rows created strictly after it.
created_toIntUnix timestamp in seconds. Inclusive — matches rows created at or before it.
last_login_fromIntUnix timestamp in seconds. Exclusive.
last_login_toIntUnix timestamp in seconds. Inclusive.
last_conversion_fromIntUnix timestamp in seconds. Exclusive.
last_conversion_toIntUnix timestamp in seconds. Inclusive.
sortStringField to sort by, descending. Each type accepts its own short list — see Sorting on the returned type's page. Anything else is ignored without an error.
beforeIDReturns only rows with an id lower than this. Cursor-style paging.
afterIDReturns only rows with an id higher than this. Cursor-style paging.
limitIntRows to return. Anything outside 1–200 is replaced by 200.
offsetIntRows to skip before returning results.

Referenced by