Chilkat Online Tools

Foxpro / New FreshBooks / 2. [FBPAY] - Create Setup Intent Using Payment Method Key

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnIntVal
LOCAL lcId
LOCAL lcGateway_name
LOCAL lcCredit_card_uuid
LOCAL lnCard_holder_user_id
LOCAL lcSaved_to_system_id
LOCAL lcCard_type
LOCAL lcExpiry_year
LOCAL lcExpiry_month
LOCAL lcLast_four_digits
LOCAL lcCard_holder_name
LOCAL lnSystem
LOCAL lnClient
LOCAL i
LOCAL lnCount_i

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* 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
*       }
*     ]
*   }
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("credit_card.saved_to_system_id","yDDAb0")
loJson.UpdateInt("credit_card.card_holder_user_id",146211)
loJson.UpdateBool("credit_card.access.system",0)
loJson.UpdateBool("credit_card.access.client",0)
loJson.UpdateInt("credit_card.access.invoice_profiles[0]",33)
loJson.UpdateString("credit_card.credit_card_tokens[0].token","token_123")
loJson.UpdateString("credit_card.credit_card_tokens[0].gateway_name","fbpay")
loJson.UpdateBool("credit_card.credit_card_tokens[0].is_primary",1)

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

loResp = loHttp.PostJson3("https://api.freshbooks.com/payments/account/{{accountid}}/credit-card","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

lcCredit_card_uuid = loJResp.StringOf("credit_card.credit_card_uuid")
lnCard_holder_user_id = loJResp.IntOf("credit_card.card_holder_user_id")
lcSaved_to_system_id = loJResp.StringOf("credit_card.saved_to_system_id")
lcCard_type = loJResp.StringOf("credit_card.card_type")
lcExpiry_year = loJResp.StringOf("credit_card.expiry_year")
lcExpiry_month = loJResp.StringOf("credit_card.expiry_month")
lcLast_four_digits = loJResp.StringOf("credit_card.last_four_digits")
lcCard_holder_name = loJResp.StringOf("credit_card.card_holder_name")
lnSystem = loJResp.BoolOf("credit_card.access.system")
lnClient = loJResp.BoolOf("credit_card.access.client")
i = 0
lnCount_i = loJResp.SizeOfArray("credit_card.access.invoice_profiles")
DO WHILE i < lnCount_i
    loJResp.I = i
    lnIntVal = loJResp.IntOf("credit_card.access.invoice_profiles[i]")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("credit_card.credit_card_tokens")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("credit_card.credit_card_tokens[i].id")
    lcGateway_name = loJResp.StringOf("credit_card.credit_card_tokens[i].gateway_name")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp

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}"
    }
  ]
}