{
  "delivery": {
    "method": "link"
  },
  "amount": 0,
  "notes": null,
  "tax_exempt": true,
  "payee": {
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "country_code": "string",
    "phone_number": "string"
  }
}
{
  "success": true,
  "payout_link": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "link": "string",
    "original_amount": 0,
    "amount": 0,
    "status": "created",
    "api_app_name": "string",
    "payee": {}
  }
}
{
  "delivery": {
    "method": "link"
  },
  "amount": 0,
  "notes": null,
  "tax_exempt": true,
  "payee": {
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "country_code": "string",
    "phone_number": "string"
  }
}
{
  "success": true,
  "payout_link": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "link": "string",
    "original_amount": 0,
    "amount": 0,
    "status": "created",
    "api_app_name": "string",
    "payee": {}
  }
}

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
delivery
object
required
amount
number
required
notes
any

Custom data that will be attached to the transaction when the recipient claims the link.

tax_exempt
boolean

Flags as tax exempt for the purpose of collecting form 1099.

payee
object

Response

200 - application/json
success
boolean
payout_link
object

The payout link if success is true