API Documentation

/getPreapprovalKey
A High Level API operation used to get a tip preapproval key.  Special permissions are required to access this endpoint.
Production:
Test:
https://tippingcircle.com/rest/v1/getPreapprovalKey
http://test.tippingcircle.com/rest/v1/getPreapprovalKey

Request
  Param Description
* consumer_key Consumer key for the application.
* userId The user's unique id.  (Data type: int64)
GET
/getPreapprovalKey?consumer_key={consumer_key}
&userId={userId}

Header
Content-Type: 'application/json'


Example
{
"consumer_key": "E4ZcTipHc3CozLB3jknSTK2et",
"userId": 123456
}

Response
The success response includes the PayPal URL with the Preapproval Key so the user can complete the preapproval at paypal.com.
{
"success": true,
"message": "https://www.paypal.com . . .",
"errorCode": 0,
}