- Payout Links
- Cancel a Payout Link
Payout Links
Cancel a Payout Link
Cancel a payout link
DELETE
/api/v2/payout-links/{payout_link_id}
client_id*
api_key*
curl --request DELETE \
--url https://api.senddotssandbox.com/api/v2/payout-links/{payout_link_id} \
--header 'Authorization: Basic AUTH_VALUE'
Parameters
payout_link_idRequired
string
Id of the payout link
Response
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
string
Status of the payout-link
.
Available options:
claimed
, delivery_pending
, delivery_failed
, delivered
, canceled
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
.
metadata
string | object | null
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.
curl --request DELETE \
--url https://api.senddotssandbox.com/api/v2/payout-links/{payout_link_id} \
--header 'Authorization: Basic AUTH_VALUE'