SQL Server / New FreshBooks / 2. [FBPAY] - Create Setup Intent Using Payment Method Key
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.
-- {
-- "credit_card": {
-- "saved_to_system_id": "yDDAb0",
-- "card_holder_user_id": 146211,
-- "access": {
-- "system": false,
-- "client": false,
-- "invoice_profiles": [
-- 33
-- ]
-- },
-- "credit_card_tokens": [
-- {
-- "token": "token_123",
-- "gateway_name": "fbpay",
-- "is_primary": 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, 'credit_card.saved_to_system_id', 'yDDAb0'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'credit_card.card_holder_user_id', 146211
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'credit_card.access.system', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'credit_card.access.client', 0
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'credit_card.access.invoice_profiles[0]', 33
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'credit_card.credit_card_tokens[0].token', 'token_123'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'credit_card.credit_card_tokens[0].gateway_name', 'fbpay'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'credit_card.credit_card_tokens[0].is_primary', 1
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://api.freshbooks.com/payments/account/{{accountid}}/credit-card', '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
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "credit_card": {
-- "credit_card_uuid": "7c8d965555554d40ddde59sadasdc7180asda7ba",
-- "card_holder_user_id": 123456,
-- "saved_to_system_id": "E86Qd",
-- "card_type": "visa",
-- "expiry_year": "2024",
-- "expiry_month": "9",
-- "last_four_digits": "0234",
-- "card_holder_name": "John Johnston",
-- "access": {
-- "system": true,
-- "client": false,
-- "invoice_profiles": [
-- 121212
-- ]
-- },
-- "credit_card_tokens": [
-- {
-- "id": "fbpay+akdjhadkjashckJNCksajncasc",
-- "gateway_name": "fbpay"
-- }
-- ]
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @intVal int
DECLARE @id nvarchar(4000)
DECLARE @gateway_name nvarchar(4000)
DECLARE @Credit_card_uuid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Credit_card_uuid OUT, 'credit_card.credit_card_uuid'
DECLARE @Card_holder_user_id int
EXEC sp_OAMethod @jResp, 'IntOf', @Card_holder_user_id OUT, 'credit_card.card_holder_user_id'
DECLARE @Saved_to_system_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Saved_to_system_id OUT, 'credit_card.saved_to_system_id'
DECLARE @Card_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Card_type OUT, 'credit_card.card_type'
DECLARE @Expiry_year nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Expiry_year OUT, 'credit_card.expiry_year'
DECLARE @Expiry_month nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Expiry_month OUT, 'credit_card.expiry_month'
DECLARE @Last_four_digits nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Last_four_digits OUT, 'credit_card.last_four_digits'
DECLARE @Card_holder_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Card_holder_name OUT, 'credit_card.card_holder_name'
DECLARE @System int
EXEC sp_OAMethod @jResp, 'BoolOf', @System OUT, 'credit_card.access.system'
DECLARE @Client int
EXEC sp_OAMethod @jResp, 'BoolOf', @Client OUT, 'credit_card.access.client'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'credit_card.access.invoice_profiles'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'IntOf', @intVal OUT, 'credit_card.access.invoice_profiles[i]'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'credit_card.credit_card_tokens'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'credit_card.credit_card_tokens[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @gateway_name OUT, 'credit_card.credit_card_tokens[i].gateway_name'
SELECT @i = @i + 1
END
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>"
-d '{
"credit_card": {
"saved_to_system_id": "yDDAb0",
"card_holder_user_id": 146211,
"access": {
"system": false,
"client": false,
"invoice_profiles": [
33
]
},
"credit_card_tokens": [
{
"token": "token_123",
"gateway_name": "fbpay",
"is_primary": true
}
]
}
}'
https://api.freshbooks.com/payments/account/{{accountid}}/credit-card
Postman Collection Item JSON
{
"name": "2. [FBPAY] - Create Setup Intent Using Payment Method Key",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"credit_card\": {\n \"saved_to_system_id\": \"yDDAb0\",\n \"card_holder_user_id\": 146211,\n \"access\": {\n \"system\": false,\n \"client\": false,\n \"invoice_profiles\": [\n 33\n ]\n },\n \"credit_card_tokens\": [\n {\n \"token\": \"token_123\",\n \"gateway_name\": \"fbpay\",\n \"is_primary\": true\n }\n ]\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/payments/account/{{accountid}}/credit-card",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"payments",
"account",
"{{accountid}}",
"credit-card"
]
}
},
"response": [
{
"name": "2. [FBPAY] - Create Setup Intent Using Payment Method Key",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"credit_card\": {\n \"saved_to_system_id\": \"E86Qp\",\n \"card_holder_user_id\": 590529,\n \"access\": {\n \"system\": true,\n \"client\": false,\n \"invoice_profiles\": [\n 26627\n ]\n },\n \"credit_card_tokens\": [\n {\n \"token\": \"1111111\",\n \"gateway_name\": \"fbpay\",\n \"is_primary\": true\n }\n ]\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/payments/account/E86Qp/credit-card",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"payments",
"account",
"E86Qp",
"credit-card"
]
}
},
"status": "CREATED",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Date",
"value": "Fri, 31 Jul 2020 20:33:18 GMT"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Content-Length",
"value": "438"
},
{
"key": "X-CardApp-Version",
"value": "2007.68.0"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABV1FUDwYGV1QTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FAkpXURQRTEVURAkRQ1VWEUgAEFUGURZnW1VAV0tLBEIORhAHUw0CFAZcWkQHABBTQ1IVC0REUAdET1IcURZQCQEBBgBcClIJVwtWVA4bVVNTFBEFVVJRUwBUX1MHAgAAVFFQEk5eA1RLUW8="
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Content-Security-Policy",
"value": "default-src 'self'"
},
{
"key": "X-Content-Security-Policy",
"value": "default-src 'self'"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31556926; includeSubDomains; preload"
},
{
"key": "Referrer-Policy",
"value": "strict-origin-when-cross-origin"
},
{
"key": "X-RateLimit-Limit",
"value": "600"
},
{
"key": "X-RateLimit-Remaining",
"value": "598"
},
{
"key": "X-RateLimit-Reset",
"value": "1596227656"
},
{
"key": "Retry-After",
"value": "57"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Alt-Svc",
"value": "h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
}
],
"cookie": [
],
"body": "{\n \"credit_card\": {\n \"credit_card_uuid\": \"7c8d965555554d40ddde59sadasdc7180asda7ba\",\n \"card_holder_user_id\": 123456,\n \"saved_to_system_id\": \"E86Qd\",\n \"card_type\": \"visa\",\n \"expiry_year\": \"2024\",\n \"expiry_month\": \"9\",\n \"last_four_digits\": \"0234\",\n \"card_holder_name\": \"John Johnston\",\n \"access\": {\n \"system\": true,\n \"client\": false,\n \"invoice_profiles\": [121212]\n },\n \"credit_card_tokens\": [\n {\n \"id\": \"fbpay+akdjhadkjashckJNCksajncasc\",\n \"gateway_name\": \"fbpay\"\n }\n ]\n }\n}"
}
]
}
