Chilkat Online Tools

PowerBuilder / New FreshBooks / Provision FreshBooks Payments

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// 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
// }

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.UpdateString("fname","Marshall")
loo_Json.UpdateString("lname","Johnston")
loo_Json.UpdateString("email","api.freshbooks@gmail.com")
loo_Json.UpdateString("orgname","Kevin's Corral")
loo_Json.UpdateString("redirect_base_uri","https://my.freshbooks.com/#/gatewayConnectRedirect/fbpay/")
loo_Json.UpdateString("country","CA")
loo_Json.UpdateBool("allow_multiple_provision",1)

// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("Content-Type","application/json")

loo_Resp = loo_Http.PostJson3("https://api.freshbooks.com/payments/account/{{accountId}}/gateway/fbpay","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    return
end if

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Resp.GetBodySb(loo_SbResponseBody)

loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Resp.Header
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_Http
    destroy loo_Json
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

destroy loo_Resp


destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp

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