Chilkat Online Tools

phpExt / New FreshBooks / Enable Payment Options On Invoice

Back to Collection Items

<?php

include("chilkat_9_5_0.php");

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

$http = new CkHttp();

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "has_credit_card": true,
//   "has_ach_transfer": true,
//   "allow_partial_payments": true,
//   "gateway_name": "fbpay"
// }

$json = new CkJsonObject();
$json->UpdateBool('has_credit_card',true);
$json->UpdateBool('has_ach_transfer',true);
$json->UpdateBool('allow_partial_payments',true);
$json->UpdateString('gateway_name','fbpay');

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');

// resp is a CkHttpResponse
$resp = $http->PostJson3('https://api.freshbooks.com/payments/account/{{accountid}}/invoice/{{invoiceid}}/payment_options','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "has_credit_card": true,
    "has_ach_transfer": true,
    "allow_partial_payments": true,
    "gateway_name": "fbpay"
}'
https://api.freshbooks.com/payments/account/{{accountid}}/invoice/{{invoiceid}}/payment_options

Postman Collection Item JSON

{
  "name": "Enable Payment Options On Invoice",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"has_credit_card\": true,\n    \"has_ach_transfer\": true,\n    \"allow_partial_payments\": true,\n    \"gateway_name\": \"fbpay\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.freshbooks.com/payments/account/{{accountid}}/invoice/{{invoiceid}}/payment_options",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "payments",
        "account",
        "{{accountid}}",
        "invoice",
        "{{invoiceid}}",
        "payment_options"
      ]
    }
  },
  "response": [
  ]
}