Donations
4 routes. Paths are relative to https://api.intersink.com/v1.
- GET/donations/campaign/{campaignId}Get total donation balance and records for a campaign
- GET/donations/campaign/{campaignId}/collection_historyGet withdrawal history for a campaign
- POST/donations/campaign/{campaignId}/withdrawWithdraw funds from a campaign's collection
- GET/donations/meFetch all donations made by the active profile
Get total donation balance and records for a campaign
GET/donations/campaign/{campaignId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| campaignIdrequired | number, path |
Response
200. The payload in data is not described in the spec yet.
Get withdrawal history for a campaign
GET/donations/campaign/{campaignId}/collection_history
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| campaignIdrequired | number, path | |
| limitrequired | string, query | |
| offsetrequired | string, query |
Response
200. The payload in data is not described in the spec yet.
Withdraw funds from a campaign's collection
POST/donations/campaign/{campaignId}/withdraw
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| campaignIdrequired | number, path | |
| Idempotency-Key | string, header | Optional client-generated key (8-128 chars, [A-Za-z0-9_-]). A retry with the same key and body replays the first response (Idempotent-Replayed: true); 409 while the first is in flight; 422 if the body differs. |
Request body application/json
| Field | Type | Description |
|---|---|---|
| campaign_id | number | Campaign ID to withdraw from (Integer) |
| amountrequired | number | Amount to withdraw, in major units (e.g. rupees) with at most 2 decimals. Must be > 0 and <= 99999.99. Minimum 1, maximum 99999.99. |
| descriptionrequired | string | Description for the withdrawal At most 2000 characters. |
| file_id | number | Proof document: id of a file record (integer) you own Minimum 1. |
| banking_id | number | Bank account (banking.id) to pay out to. Required when you have more than one personal bank account. Minimum 1. |
Response
201. The payload in data is not described in the spec yet.
Fetch all donations made by the active profile
GET/donations/me
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| active_profile_idrequired | string, query |
Response
200. The payload in data is not described in the spec yet.