DELETE
/
v2
/
payout-links
/
{payout_link_id}
Authorization
Path
curl --request DELETE \
  --url https://api.senddotssandbox.com/api/v2/payout-links/{payout_link_id} \
  --header 'Authorization: <authorization>'
{
  "amount": "number",
  "claimed_user_id": "string",
  "created": "string",
  "delivery": {
    "country_code": "string",
    "email": "string",
    "method": "link",
    "phone_number": "string"
  },
  "flow_id": "string",
  "id": "string",
  "link": "string",
  "metadata": [
    "string",
    "object",
    "null"
  ],
  "payee": {
    "country_code": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "phone_number": "string"
  },
  "status": "sent",
  "tax_exempt": "boolean"
}

Authorizations

Authorizationheaderrequired
string

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

Path Parameters

payout_link_idrequired
string

Id of the payout link

Response

200 - application/json
amount
number

The amount to pay in cents.

claimed_user_id
string

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

created
string

Date the payout-link was created.

delivery
object
flow_id
string

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

id
string

ID of the payout-link.

link
string

URL to access the payout-link.

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.

payee
object

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

status
enum<string>

Status of the payout-link.

Available options:
sent,
claimed,
delivery_pending,
delivery_failed,
delivered,
canceled
tax_exempt
boolean

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