API Documentation

/getBuckets
A High Level API operation used to get tipping bucket data.
Production:
Test:
https://tippingcircle.com/rest/v1/getBuckets
http://test.tippingcircle.com/rest/v1/getBuckets

Request
  Param Description
* consumer_key Consumer key for the application.
* idType The type of uniqueId being passed in.  (Options: "userId", "email", "bucketId", "public")
uniqueId The unique id according to the specified idType. If idType is "public" then this value can be null or a userId/email can be provided to make the results more tailored to the user.
* includeBucketTips Boolean: if true, the bucket's transaction history will be included in the results.
GET
/getBuckets?consumer_key={consumer_key}
&idType={idType}&uniqueId={uniqueId}
&includeBucketTips={includeBucketTips}

Header
Content-Type: 'application/json'


Example
{
"consumer_key": "E4ZcTipHc3CozLB3jknSTK2et",
"idType": "email",
"uniqueId": "email@example.com",
"includeBucketTips": true
}

Response
The success response includes the tipping bucket data.
{
"success": true,
"message": "String content",
"errorCode": 0,
"buckets": [{
"bucketId": 4567826,
"title": "Cindy Fights Cancer Fundraiser",
"descr": "Please help me raise money for Cindy. The medical bills are mounting up as she fights to overcome cancer.",
"imageOrVideoUrl": "https://imageOrVideoUrl",
"goal": 5000.00,
"deadline": "\/Date(928174800000-0700)\/",
"daysRemaining": 15,
"bucketUrl": "https://tippingcircle.com/bucketUrl",
"isClosed": false,
"totalTips": 53,
"runningTotal": 2085.00,
"dateCreated": "\/Date(928174800000-0700)\/"
"receiverSocialConnectionId": 865214,
"receiverFullName": "John Doe",
"receiverPhotoUrl": "https://profilephotourl",
"bucketTips": [{
"Amount": 10.00,
"CompleteDate": "\/Date(928174800000-0700)\/",
"Confirmation": "97L63015AX502144T",
"Message": "Thanks for covering for me last night.",
"PaymentId": 3685477,
"SourceFirstName":"Jane",
"SourceFullName":"Jane Doe",
"SourceLastName":"Doe",
"SourceProfilePhotoUrl": "https://profilephotourl",
"SourceUserId": 2357,
"Title": "Jane tipped you $10.00"
}]
}]
}