List all Payout Links
curl --request GET \
--url https://api.senddotssandbox.com/api/v2/payout-links \
--header 'Authorization: <authorization>'
{
"data": [
{
"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"
}
],
"has_more": "boolean"
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Query Parameters
A limit on the number of objects to be returned, between 1 and 100.
A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with aaa
, your subsequent call can include starting_after
=aaa
in order to fetch the next page of the list.
A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with aaa
, your subsequent call can include ending_before
=aaa
in order to fetch the previous page of the list.
Response
Array of payout-links
.
true
if there are more payout-links
.
curl --request GET \
--url https://api.senddotssandbox.com/api/v2/payout-links \
--header 'Authorization: <authorization>'
{
"data": [
{
"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"
}
],
"has_more": "boolean"
}