Create a new Tip Link

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Body Params

name

string

required

Name this tip link. This should indicate something about the purpose. This is displayed on the payment page.

description

string

required

Description this tip link. This should indicate description about the purpose. This is displayed on the payment page.

image_url

string | null

ImageUrl this tip link.

after_payment_message

string

required

AfterPaymentMessage this tip link. This will show when payment complete.

contract_id

string | null

A contract for the Tip Link. This is useful for more complex scenarios than simple flat splits.

splits

array of objects

required

These define simple splits between contacts. When a Tip Link is used, and funds clear, the money will automatically flow to these contacts as though it was coming from the user that owns the tip link.

splits*

object

string | null

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

200Success

404Not Found

defaultError