Error
A valid request URL is required to generate request examples{
"pageKey": "<string>",
"response": [
{
"inputGrossAtomic": "<string>",
"inputNetAtomic": "<string>",
"inputTipAtomic": "<string>",
"inputFeeAtomic": "<string>",
"settledGrossAtomic": "<string>",
"settledNetAtomic": "<string>",
"settledTipAtomic": "<string>",
"settledFeeAtomic": "<string>",
"usdGrossE6": "<string>",
"usdNetE6": "<string>",
"usdTipE6": "<string>",
"usdFeeE6": "<string>",
"status": "pending",
"id": "<string>",
"beneficiaryIndex": 123,
"beneficiaryWeight": "<string>",
"target": {
"participantType": "unknown",
"chain": {
"id": 123,
"name": "<string>",
"type": "bitcoin"
},
"walletAddress": "<string>"
},
"donationReceipt": {
"inputGrossAtomic": "<string>",
"inputNetAtomic": "<string>",
"inputTipAtomic": "<string>",
"inputFeeAtomic": "<string>",
"settledGrossAtomic": "<string>",
"settledNetAtomic": "<string>",
"settledTipAtomic": "<string>",
"settledFeeAtomic": "<string>",
"usdGrossE6": "<string>",
"usdNetE6": "<string>",
"usdTipE6": "<string>",
"usdFeeE6": "<string>",
"status": "pending",
"id": "<string>",
"message": "<string>",
"externalSubject": {
"chainId": 123,
"address": "<string>",
"donationSource": {
"label": "<string>",
"address": "<string>",
"chain": {
"id": 123,
"name": "<string>",
"type": "bitcoin"
},
"developerProjectId": "<string>"
},
"creditedAccount": {
"chain": {
"id": 123,
"name": "<string>",
"type": "bitcoin"
},
"address": "<string>"
},
"type": "token",
"token": {
"id": "<string>",
"chainId": 123,
"address": "<string>",
"name": "<string>",
"symbol": "<string>",
"decimals": 123,
"standard": "NATIVE",
"isNameAppropriate": true
}
},
"beneficiaryWeightDenominator": "<string>",
"config": {
"id": "<string>",
"feeBps": "<string>",
"developerProjectId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"owner": "user",
"user": {
"id": "<string>",
"username": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar": "<string>",
"twitter": {
"accountId": "<string>",
"username": "<string>",
"displayName": "<string>",
"avatar": "<string>",
"description": "<string>"
},
"twitch": {
"accountId": "<string>",
"username": "<string>",
"displayName": "<string>",
"avatar": "<string>",
"description": "<string>"
},
"configId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
},
"inputToken": {
"id": "<string>",
"chainId": 123,
"address": "<string>",
"name": "<string>",
"symbol": "<string>",
"decimals": 123,
"standard": "NATIVE",
"isNameAppropriate": true
},
"settlementToken": {
"id": "<string>",
"chainId": 123,
"address": "<string>",
"name": "<string>",
"symbol": "<string>",
"decimals": 123,
"standard": "NATIVE",
"isNameAppropriate": true
},
"source": {
"participantType": "unknown",
"chain": {
"id": 123,
"name": "<string>",
"type": "bitcoin"
},
"walletAddress": "<string>"
},
"transactionLog": {
"txHash": "<string>",
"logIndex": 123,
"blockNumber": "<string>",
"blockTimestamp": "<string>"
}
}
}
]
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}API Reference
List charity donations received
Paginated list of donations received by a charity.
GET
/
charities
/
{charityId}
/
donations
Error
A valid request URL is required to generate request examples{
"pageKey": "<string>",
"response": [
{
"inputGrossAtomic": "<string>",
"inputNetAtomic": "<string>",
"inputTipAtomic": "<string>",
"inputFeeAtomic": "<string>",
"settledGrossAtomic": "<string>",
"settledNetAtomic": "<string>",
"settledTipAtomic": "<string>",
"settledFeeAtomic": "<string>",
"usdGrossE6": "<string>",
"usdNetE6": "<string>",
"usdTipE6": "<string>",
"usdFeeE6": "<string>",
"status": "pending",
"id": "<string>",
"beneficiaryIndex": 123,
"beneficiaryWeight": "<string>",
"target": {
"participantType": "unknown",
"chain": {
"id": 123,
"name": "<string>",
"type": "bitcoin"
},
"walletAddress": "<string>"
},
"donationReceipt": {
"inputGrossAtomic": "<string>",
"inputNetAtomic": "<string>",
"inputTipAtomic": "<string>",
"inputFeeAtomic": "<string>",
"settledGrossAtomic": "<string>",
"settledNetAtomic": "<string>",
"settledTipAtomic": "<string>",
"settledFeeAtomic": "<string>",
"usdGrossE6": "<string>",
"usdNetE6": "<string>",
"usdTipE6": "<string>",
"usdFeeE6": "<string>",
"status": "pending",
"id": "<string>",
"message": "<string>",
"externalSubject": {
"chainId": 123,
"address": "<string>",
"donationSource": {
"label": "<string>",
"address": "<string>",
"chain": {
"id": 123,
"name": "<string>",
"type": "bitcoin"
},
"developerProjectId": "<string>"
},
"creditedAccount": {
"chain": {
"id": 123,
"name": "<string>",
"type": "bitcoin"
},
"address": "<string>"
},
"type": "token",
"token": {
"id": "<string>",
"chainId": 123,
"address": "<string>",
"name": "<string>",
"symbol": "<string>",
"decimals": 123,
"standard": "NATIVE",
"isNameAppropriate": true
}
},
"beneficiaryWeightDenominator": "<string>",
"config": {
"id": "<string>",
"feeBps": "<string>",
"developerProjectId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"owner": "user",
"user": {
"id": "<string>",
"username": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatar": "<string>",
"twitter": {
"accountId": "<string>",
"username": "<string>",
"displayName": "<string>",
"avatar": "<string>",
"description": "<string>"
},
"twitch": {
"accountId": "<string>",
"username": "<string>",
"displayName": "<string>",
"avatar": "<string>",
"description": "<string>"
},
"configId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
},
"inputToken": {
"id": "<string>",
"chainId": 123,
"address": "<string>",
"name": "<string>",
"symbol": "<string>",
"decimals": 123,
"standard": "NATIVE",
"isNameAppropriate": true
},
"settlementToken": {
"id": "<string>",
"chainId": 123,
"address": "<string>",
"name": "<string>",
"symbol": "<string>",
"decimals": 123,
"standard": "NATIVE",
"isNameAppropriate": true
},
"source": {
"participantType": "unknown",
"chain": {
"id": 123,
"name": "<string>",
"type": "bitcoin"
},
"walletAddress": "<string>"
},
"transactionLog": {
"txHash": "<string>",
"logIndex": 123,
"blockNumber": "<string>",
"blockTimestamp": "<string>"
}
}
}
]
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Developer API key. Required for config create/list/delete and project analytics. Optional on public GET reads (anonymous callers are IP rate-limited). Obtain from the Developer dashboard.
Headers
Optional. Omit for the anonymous IP budget (~20 req/min). Keys share their organization billing-tier limit.
Minimum string length:
1Path Parameters
Charity id
Minimum string length:
1Query Parameters
Page size (min 1, max 200)
Required range:
1 <= x <= 200Cursor for next page (from previous pageKey)
Was this page helpful?