Authorizations

Authorization
string
headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
user_id
string

The user's id.

payee
object

The payee. This is optional.

amount
integer
required

Amount to be paid in cents.

delivery
object
force_collect_compliance_information
boolean
default: false

Force the collection of 1099 or W-8 information. Defaults to false.

tax_exempt
boolean

Payout links marked as tax_exempt will not be counted towards the 1099 threshold.

metadata

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

memo
string

Add a memo to the top of the Payout Link

idempotency_key
string | null

Unique UUID key that prevents duplicate requests from being processed. If a payout link with the idempotency key exists, a new link will not be created and the existing link will be returned instead.

payout_fee_party
enum<string> | null

Overrides the setting for which party will pay fees on this payout. This takes precedence over the default for your application.

Available options:
user,
platform
additional_steps
enum<string>[]

Array of steps in the flow.

Available options:
compliance,
id-verification,
background-check,
manage-payments,
manage-payouts,
payout,
redirect
accounting_data
object

Response

200 - application/json
id
string

ID of the payout-link.

created
string

Date the payout-link was created.

link
string

URL to access the payout-link.

amount
number

The amount to pay in cents.

status
enum<string>

Status of the payout-link.

Available options:
created,
delivery_pending,
delivery_failed,
sent,
delivered,
claimed,
reversed,
canceled,
expired
payee
object

Information about the payee. It is used to pre-fill information.

delivery
object
tax_exempt
boolean

Transfers marked as tax_exempt will not be counted towards the 1099 threshold.

claimed_user_id
string

ID of the user that has claimed the payout-link.

flow_id
string

ID of the payout flow UI that is sent to the user.

metadata

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.