Set Bags payout token cashout
curl --request POST \
--url https://public-api-v2.bags.fm/api/v1/bags-payout/token/cashout \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"tokenMint": "<string>",
"cashout": {
"username": "<string>"
}
}
'import requests
url = "https://public-api-v2.bags.fm/api/v1/bags-payout/token/cashout"
payload = {
"tokenMint": "<string>",
"cashout": { "username": "<string>" }
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({tokenMint: '<string>', cashout: {username: '<string>'}})
};
fetch('https://public-api-v2.bags.fm/api/v1/bags-payout/token/cashout', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public-api-v2.bags.fm/api/v1/bags-payout/token/cashout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tokenMint' => '<string>',
'cashout' => [
'username' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public-api-v2.bags.fm/api/v1/bags-payout/token/cashout"
payload := strings.NewReader("{\n \"tokenMint\": \"<string>\",\n \"cashout\": {\n \"username\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://public-api-v2.bags.fm/api/v1/bags-payout/token/cashout")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"tokenMint\": \"<string>\",\n \"cashout\": {\n \"username\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api-v2.bags.fm/api/v1/bags-payout/token/cashout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tokenMint\": \"<string>\",\n \"cashout\": {\n \"username\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"response": {
"tokenMint": "<string>",
"cashoutMethod": "venmo",
"cashoutMethodLabel": "Venmo",
"username": "<string>",
"status": "active",
"paysPayoutBot": true,
"stats": {
"totalClaimedLamports": "<string>",
"confirmedClaimCount": 123,
"totalBridgedLamports": "<string>",
"totalUsdcReceivedRaw": "<string>",
"totalUsdcPaidRaw": "<string>",
"totalFiatPaidCents": "<string>",
"payoutCount": 123,
"paidPayoutCount": 123,
"openPayoutCount": 123,
"lastClaimAt": "<string>",
"lastPayoutAt": "<string>",
"lastPaidAt": "<string>"
},
"pendingClaims": [
{
"cashoutMethod": "venmo",
"username": "<string>",
"isCurrentMapping": true,
"confirmedCount": 123,
"confirmedLamports": "<string>",
"inFlightCount": 123,
"underReviewCount": 123,
"oldestAt": "<string>",
"newestAt": "<string>"
}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}
}{
"success": false,
"response": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"response": "<string>"
}{
"success": false,
"response": "<string>"
}{
"success": false,
"response": "<string>"
}{
"success": false,
"response": "<string>"
}{
"success": false,
"response": "<string>"
}{
"success": false,
"response": "<string>"
}Bags Payout
Set Bags Payout Token Cashout
Change the payout handle of a token whose fee-share config already exists. Only the token’s fee-share manager may call this. Setting a handle other than the current one runs a handle check, which is limited per user per hour. A token whose payouts were disabled cannot be changed.
For a token that is being launched, send payoutCashout with the fee-share config request instead.
POST
/
bags-payout
/
token
/
cashout
Set Bags payout token cashout
curl --request POST \
--url https://public-api-v2.bags.fm/api/v1/bags-payout/token/cashout \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"tokenMint": "<string>",
"cashout": {
"username": "<string>"
}
}
'import requests
url = "https://public-api-v2.bags.fm/api/v1/bags-payout/token/cashout"
payload = {
"tokenMint": "<string>",
"cashout": { "username": "<string>" }
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({tokenMint: '<string>', cashout: {username: '<string>'}})
};
fetch('https://public-api-v2.bags.fm/api/v1/bags-payout/token/cashout', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public-api-v2.bags.fm/api/v1/bags-payout/token/cashout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tokenMint' => '<string>',
'cashout' => [
'username' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public-api-v2.bags.fm/api/v1/bags-payout/token/cashout"
payload := strings.NewReader("{\n \"tokenMint\": \"<string>\",\n \"cashout\": {\n \"username\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://public-api-v2.bags.fm/api/v1/bags-payout/token/cashout")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"tokenMint\": \"<string>\",\n \"cashout\": {\n \"username\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api-v2.bags.fm/api/v1/bags-payout/token/cashout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tokenMint\": \"<string>\",\n \"cashout\": {\n \"username\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"response": {
"tokenMint": "<string>",
"cashoutMethod": "venmo",
"cashoutMethodLabel": "Venmo",
"username": "<string>",
"status": "active",
"paysPayoutBot": true,
"stats": {
"totalClaimedLamports": "<string>",
"confirmedClaimCount": 123,
"totalBridgedLamports": "<string>",
"totalUsdcReceivedRaw": "<string>",
"totalUsdcPaidRaw": "<string>",
"totalFiatPaidCents": "<string>",
"payoutCount": 123,
"paidPayoutCount": 123,
"openPayoutCount": 123,
"lastClaimAt": "<string>",
"lastPayoutAt": "<string>",
"lastPaidAt": "<string>"
},
"pendingClaims": [
{
"cashoutMethod": "venmo",
"username": "<string>",
"isCurrentMapping": true,
"confirmedCount": 123,
"confirmedLamports": "<string>",
"inFlightCount": 123,
"underReviewCount": 123,
"oldestAt": "<string>",
"newestAt": "<string>"
}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}
}{
"success": false,
"response": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"response": "<string>"
}{
"success": false,
"response": "<string>"
}{
"success": false,
"response": "<string>"
}{
"success": false,
"response": "<string>"
}{
"success": false,
"response": "<string>"
}{
"success": false,
"response": "<string>"
}Authorizations
API key authentication. Provide your API key as the header value.
Body
application/json