Skip to main content
GET
List payouts

Authorizations

Authorization
string
header
required

Organization API key using Authorization: Bearer sk_....

Query Parameters

filter
object

Filter fields encoded with qs bracket notation.

skip
number
default:0

Pagination offset.

Required range: x >= 0
Example:

0

take
number
default:20

Pagination limit.

Required range: 1 <= x <= 100
Example:

20

Response

Payouts list

id
string
required

Unique identifier of the payout.

Example:

"po_1234567890abcdefghij"

createdAt
string<date-time>
required

When the payout was recorded.

updatedAt
string<date-time>
required

When the payout was last updated.

settleDate
string<date-time>
required

When the payout settled in the organization's bank account.

isApproximateDate
boolean
required

Whether the settle date is an estimate.

inconsistent
boolean
required

Whether its amounts are inconsistent with its linked records and transactions.

organizationId
string
required

Organization that received the payout.

currency
string
required

ISO 4217 currency code.

Example:

"MXN"

grossAmount
integer
required

Amount before fees, in minor currency units.

Example:

1500000

netAmount
integer | null
required

Amount deposited after fees, in minor currency units.

Example:

1440000

quentliFee
integer | null
required

Quentli fee, in minor currency units.

quentliFeeTax
integer | null
required

Tax on the Quentli fee, in minor currency units.

processorFee
integer | null
required

Processor fee, in minor currency units.

processorFeeTax
integer | null
required

Tax on the processor fee, in minor currency units.

disputesAmount
integer | null
required

Dispute amount deducted from this payout, in minor currency units.

processor
enum<string>
required

Payment processor that generated the payout.

Available options:
FISERV,
STRIPE,
KUSHKI,
SANTANDER,
TAPI,
QUENTLI
payer
enum<string>
required

Party that sent the payout.

Available options:
AMEX,
FISERV,
STRIPE,
KUSHKI,
SANTANDER,
TAPI,
QUENTLI
externalId
string | null
required

Payout identifier at the payment processor.

stripePayoutId
string | null
required

Stripe payout identifier, when paid by Stripe.

cep
string | null
required

URL of the SPEI electronic payment receipt (CEP), when available.