Skip to main content
GET
Get Bags payout feed

Authorizations

x-api-key
string
header
required

API key authentication. Provide your API key as the header value.

Query Parameters

limit
integer
default:100

Maximum number of events to return (1 to 100, default 100)

Required range: 1 <= x <= 100
sort
enum<string>
default:time

Sort order: time orders by payment time, newest first (default); amount by cash paid in USD, largest first

Available options:
time,
amount
before
integer

Unix timestamp in seconds. Returns only events older than this, for paging with sort=time. Rejected with 400 when sort=amount

Required range: x >= 1
cursor
string

Opaque page cursor for sort=amount, taken from the previous response's nextCursor. Rejected with 400 when sort=time, or when it is not a well-formed cursor

Maximum string length: 4096
minAmountCents
integer

Lower bound (inclusive) on the cash paid, in USD cents

Required range: x >= 1
maxAmountCents
integer

Upper bound (inclusive) on the cash paid, in USD cents. Must be at least minAmountCents

Required range: x >= 1
onlyFirstPayments
enum<string>
default:false

Return only each handle's first payment per token

Available options:
true,
false
method
enum<string>
default:xmoney

Payout method: xmoney (default), cashapp, venmo or all Payout method to return events for: xmoney (default), cashapp, venmo, or all for every method.

Available options:
xmoney,
cashapp,
venmo,
all

Response

Successfully retrieved the payout feed

success
boolean
required
Example:

true

response
object