Error
A valid request URL is required to generate request examples{
"id": {
"hex": "<string>",
"base58": "<string>"
},
"feeBps": "<string>",
"beneficiaries": [
{
"id": "<string>",
"name": "<string>",
"logo": "<string>",
"type": "charity",
"weight": "<string>"
}
]
}{
"defined": true,
"code": "VALIDATION_ERROR",
"status": 400,
"message": "Validation failed",
"data": {
"error": "<string>",
"code": "VALIDATION_ERROR",
"issues": [
null
]
}
}{
"defined": true,
"code": "BENEFICIARY_UNAVAILABLE",
"status": 409,
"message": "A beneficiary is temporarily unavailable for new configs.",
"data": {
"error": "<string>",
"code": "BENEFICIARY_UNAVAILABLE"
}
}{
"defined": true,
"code": "PAYLOAD_TOO_LARGE",
"status": 413,
"message": "Request body too large",
"data": {
"error": "<string>",
"code": "PAYLOAD_TOO_LARGE"
}
}API Reference
Create a beneficiary config
Create an immutable config naming charities and campaigns. Users are not supported. Weights are positive safe integers. Equivalent requests return the existing config. New configs require eligible beneficiaries; retries preserve existing configs. The standard API fee is 20% (2,000 basis points), set by the server.
POST
/
v2
/
configs
Error
A valid request URL is required to generate request examples{
"id": {
"hex": "<string>",
"base58": "<string>"
},
"feeBps": "<string>",
"beneficiaries": [
{
"id": "<string>",
"name": "<string>",
"logo": "<string>",
"type": "charity",
"weight": "<string>"
}
]
}{
"defined": true,
"code": "VALIDATION_ERROR",
"status": 400,
"message": "Validation failed",
"data": {
"error": "<string>",
"code": "VALIDATION_ERROR",
"issues": [
null
]
}
}{
"defined": true,
"code": "BENEFICIARY_UNAVAILABLE",
"status": 409,
"message": "A beneficiary is temporarily unavailable for new configs.",
"data": {
"error": "<string>",
"code": "BENEFICIARY_UNAVAILABLE"
}
}{
"defined": true,
"code": "PAYLOAD_TOO_LARGE",
"status": 413,
"message": "Request body too large",
"data": {
"error": "<string>",
"code": "PAYLOAD_TOO_LARGE"
}
}Authorizations
Was this page helpful?