SQL Server / New FreshBooks / Provision FreshBooks Payments
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "fname": "Marshall",
-- "lname": "Johnston",
-- "email": "api.freshbooks@gmail.com",
-- "orgname": "Kevin's Corral",
-- "redirect_base_uri": "https://my.freshbooks.com/#/gatewayConnectRedirect/fbpay/",
-- "country": "CA",
-- "allow_multiple_provision": true
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'fname', 'Marshall'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'lname', 'Johnston'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'email', 'api.freshbooks@gmail.com'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'orgname', 'Kevin''s Corral'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'redirect_base_uri', 'https://my.freshbooks.com/#/gatewayConnectRedirect/fbpay/'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'country', 'CA'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'allow_multiple_provision', 1
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://api.freshbooks.com/payments/account/{{accountId}}/gateway/fbpay', 'application/json', @json
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"fname": "Marshall",
"lname": "Johnston",
"email": "api.freshbooks@gmail.com",
"orgname": "Kevin\'s Corral",
"redirect_base_uri": "https://my.freshbooks.com/#/gatewayConnectRedirect/fbpay/",
"country": "CA",
"allow_multiple_provision": true
}'
https://api.freshbooks.com/payments/account/{{accountId}}/gateway/fbpay
Postman Collection Item JSON
{
"name": "Provision FreshBooks Payments",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"fname\": \"Marshall\",\n \"lname\": \"Johnston\",\n \"email\": \"api.freshbooks@gmail.com\",\n \"orgname\": \"Kevin's Corral\",\n \"redirect_base_uri\": \"https://my.freshbooks.com/#/gatewayConnectRedirect/fbpay/\",\n \"country\": \"CA\",\n \"allow_multiple_provision\": true\n}"
},
"url": {
"raw": "https://api.freshbooks.com/payments/account/{{accountId}}/gateway/fbpay",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"payments",
"account",
"{{accountId}}",
"gateway",
"fbpay"
]
},
"description": "This endpoint is used to provision the ability to use FreshBooks Payments on your invoices. This is typically called at the beginning of new account setup. if you create a new account via the API and don't call this endpoint you will have to manually provision your payment processing account from the settings under \"Accept Online Payments\"."
},
"response": [
{
"name": "Add FreshBooks Payments",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"fname\": \"Marshall\",\n \"lname\": \"Johnston\",\n \"email\": \"mjohnston@freshbooks.com\",\n \"orgname\": \"Kevin's Corral\",\n \"redirect_base_uri\": \"https://my.freshbooks.com/#/gatewayConnectRedirect/fbpay/\",\n \"country\": \"CA\",\n \"allow_multiple_provision\": true\n}"
},
"url": {
"raw": "https://my.freshbooks.com/service/api/payments/account/lwy0vG/gateway/fbpay",
"protocol": "https",
"host": [
"my",
"freshbooks",
"com"
],
"path": [
"service",
"api",
"payments",
"account",
"lwy0vG",
"gateway",
"fbpay"
]
}
},
"status": "CREATED",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "X-CardApp-Version",
"value": "1904.32.0"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABV1FUDwYGV1QTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FAkpXURQRTEVURAkRQ1VWEUgEA0QHTwNBFlJQQwRAT0MEQA0RRFQEXAJbUF8RDxZoVlYSAUZXSj0UBhFfF0oBXWdSUEMEQEMdUR9SSgQDVFZSCgoJXFRaBwgEVFIDGgFVV09AAlsAWwsJUAAHUApXCQMGUkYaUQAKEF1u"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Wed, 25 Apr 2018 16:57:41 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Content-Length",
"value": "4"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Thu, 25 Apr 2019 16:57:41 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17366-MDW"
},
{
"key": "X-Cache",
"value": "MISS"
},
{
"key": "X-Cache-Hits",
"value": "0"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "null"
}
]
}
