API Reference

Create a new payout

post
https://recipient.payouts.com/api/v1/payouts

Creates a new payout for a recipient. The payout will be sent to the recipient's email with a secure claim link.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Email address of the recipient

string
required
length between 1 and 100

First name of the recipient

string
required
length between 1 and 100

Last name of the recipient

string
required
^\d+(\.\d{1,2})?$

Amount to be paid (decimal string with up to 2 decimal places)

string
enum
^[A-Z]{3}$
Defaults to USD

Three-letter ISO currency code

paymentMethods
array of strings

Array of allowed payment methods. If not specified, all enabled methods are available.

paymentMethods
string
enum

Recommended payment method to highlight for the recipient

string
length ≤ 500

Description or reason for the payout

string
length ≤ 100

Your internal reference ID for this payout

integer
1 to 168
Defaults to 24

Number of hours before the payout link expires

metadata
object

Additional metadata to attach to the payout

uri

URL to receive webhook notifications for this payout

boolean
Defaults to false

Whether this payout requires approval before sending

boolean
Defaults to true

Whether to send email notification to recipient

Responses

Updated 9 months ago

Did this page help you?
Language
Credentials
Bearer
API Key
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago

Did this page help you?