Skip to main content
POST
Preview a Quick Pay

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Body

application/json

Preview a Quick-Pay disbursement (POST /payouts/quick-pay/preview). Validated by normalizeV1Body (lib/api/payouts/quick-pay.schema.ts:78-155): email + a non-empty lineItems array are required and the total is derived from the line items — there is no top-level amount field. Numeric fields also accept a numeric string.

email
string<email>
required
lineItems
object[]
required

Non-empty line items (max 100). Each needs a description plus at least one of amountCents / unitAmountCents / unitPrice / amount.

Required array length: 1 - 100 elements
notes
string
Maximum string length: 500
dryRun
boolean

Response

The Quick Pay dry-run preview (recipient resolution + fee/net computation). No money moves.

data
object
required

Dry-run preview of a Quick Pay: validates the recipient + line items, resolves whether the recipient is an existing SideShift user, and computes the transfer fee + net amount. No money moves.