Chilkat Online Tools

phpExt / Fatture in Cloud API v2 - API Reference / List Payment Methods

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

$queryParams = new CkJsonObject();
$queryParams->UpdateString('fields','<string>');
$queryParams->UpdateString('fieldset','basic');
$queryParams->UpdateString('sort','<string>');

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

// resp is a CkHttpResponse
$resp = $http->QuickRequestParams('GET','https://api-v2.fattureincloud.it/c/:company_id/info/payment_methods',$queryParams);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "data": [
//     {
//       "id": "<integer>",
//       "name": "<string>",
//       "type": "standard",
//       "is_default": "<boolean>",
//       "default_payment_account": {
//         "id": "<integer>",
//         "name": "<string>",
//         "type": "standard",
//         "iban": "<string>",
//         "sia": "<string>",
//         "cuc": "<string>",
//         "virtual": "<boolean>"
//       },
//       "details": [
//         {
//           "title": "<string>",
//           "description": "<string>"
//         },
//         {
//           "title": "<string>",
//           "description": "<string>"
//         }
//       ],
//       "bank_iban": "<string>",
//       "bank_name": "<string>",
//       "bank_beneficiary": "<string>",
//       "ei_payment_method": "<string>"
//     },
//     {
//       "id": "<integer>",
//       "name": "<string>",
//       "type": "standard",
//       "is_default": "<boolean>",
//       "default_payment_account": {
//         "id": "<integer>",
//         "name": "<string>",
//         "type": "standard",
//         "iban": "<string>",
//         "sia": "<string>",
//         "cuc": "<string>",
//         "virtual": "<boolean>"
//       },
//       "details": [
//         {
//           "title": "<string>",
//           "description": "<string>"
//         },
//         {
//           "title": "<string>",
//           "description": "<string>"
//         }
//       ],
//       "bank_iban": "<string>",
//       "bank_name": "<string>",
//       "bank_beneficiary": "<string>",
//       "ei_payment_method": "<string>"
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$i = 0;
$count_i = $jResp->SizeOfArray('data');
while ($i < $count_i) {
    $jResp->put_I($i);
    $id = $jResp->stringOf('data[i].id');
    $name = $jResp->stringOf('data[i].name');
    $v_type = $jResp->stringOf('data[i].type');
    $is_default = $jResp->stringOf('data[i].is_default');
    $Id = $jResp->stringOf('data[i].default_payment_account.id');
    $Name = $jResp->stringOf('data[i].default_payment_account.name');
    $v_Type = $jResp->stringOf('data[i].default_payment_account.type');
    $Iban = $jResp->stringOf('data[i].default_payment_account.iban');
    $Sia = $jResp->stringOf('data[i].default_payment_account.sia');
    $Cuc = $jResp->stringOf('data[i].default_payment_account.cuc');
    $v_Virtual = $jResp->stringOf('data[i].default_payment_account.virtual');
    $bank_iban = $jResp->stringOf('data[i].bank_iban');
    $bank_name = $jResp->stringOf('data[i].bank_name');
    $bank_beneficiary = $jResp->stringOf('data[i].bank_beneficiary');
    $ei_payment_method = $jResp->stringOf('data[i].ei_payment_method');
    $j = 0;
    $count_j = $jResp->SizeOfArray('data[i].details');
    while ($j < $count_j) {
        $jResp->put_J($j);
        $title = $jResp->stringOf('data[i].details[j].title');
        $description = $jResp->stringOf('data[i].details[j].description');
        $j = $j + 1;
    }

    $i = $i + 1;
}


?>

Curl Command

curl -G -d "fields=%3Cstring%3E"
	-d "fieldset=basic"
	-d "sort=%3Cstring%3E"
	-H "Authorization: Bearer <access_token>"
	-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/info/payment_methods

Postman Collection Item JSON

{
  "name": "List Payment Methods",
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": [
        {
          "key": "scope",
          "value": "entity.clients:r entity.clients:a entity.suppliers:r entity.suppliers:a products:r products:a issued_documents.invoices:r issued_documents.credit_notes:r issued_documents.receipts:r issued_documents.orders:r issued_documents.quotes:r issued_documents.proformas:r issued_documents.delivery_notes:r issued_documents.work_reports:r issued_documents.supplier_orders:r issued_documents.self_invoices:r issued_documents.invoices:a issued_documents.credit_notes:a issued_documents.receipts:a issued_documents.orders:a issued_documents.quotes:a issued_documents.proformas:a issued_documents.delivery_notes:a issued_documents.work_reports:a issued_documents.supplier_orders:a issued_documents.self_invoices:a received_documents:r received_documents:a stock:r stock:a receipts:r receipts:a taxes:r taxes:a archive:r archive:a cashbook:r cashbook:a settings:r settings:a situation:r",
          "type": "string"
        },
        {
          "key": "redirect_uri",
          "value": "https://api-v2.fattureincloud.it/oauth/token",
          "type": "string"
        },
        {
          "key": "accessTokenUrl",
          "value": "https://api-v2.fattureincloud.it/oauth/token",
          "type": "string"
        },
        {
          "key": "authUrl",
          "value": "https://api-v2.fattureincloud.it/oauth/authorize",
          "type": "string"
        },
        {
          "key": "grant_type",
          "value": "authorization_code",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/c/:company_id/info/payment_methods?fields=<string>&fieldset=basic&sort=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "info",
        "payment_methods"
      ],
      "query": [
        {
          "key": "fields",
          "value": "<string>",
          "description": "List of comma-separated fields."
        },
        {
          "key": "fieldset",
          "value": "basic",
          "description": "Name of the fieldset."
        },
        {
          "key": "sort",
          "value": "<string>",
          "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
        }
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Lists the available payment methods."
  },
  "response": [
    {
      "name": "Payment methods list.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/info/payment_methods?fields=<string>&fieldset=basic&sort=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "info",
            "payment_methods"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            },
            {
              "key": "sort",
              "value": "<string>",
              "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"type\": \"standard\",\n      \"is_default\": \"<boolean>\",\n      \"default_payment_account\": {\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\",\n        \"type\": \"standard\",\n        \"iban\": \"<string>\",\n        \"sia\": \"<string>\",\n        \"cuc\": \"<string>\",\n        \"virtual\": \"<boolean>\"\n      },\n      \"details\": [\n        {\n          \"title\": \"<string>\",\n          \"description\": \"<string>\"\n        },\n        {\n          \"title\": \"<string>\",\n          \"description\": \"<string>\"\n        }\n      ],\n      \"bank_iban\": \"<string>\",\n      \"bank_name\": \"<string>\",\n      \"bank_beneficiary\": \"<string>\",\n      \"ei_payment_method\": \"<string>\"\n    },\n    {\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"type\": \"standard\",\n      \"is_default\": \"<boolean>\",\n      \"default_payment_account\": {\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\",\n        \"type\": \"standard\",\n        \"iban\": \"<string>\",\n        \"sia\": \"<string>\",\n        \"cuc\": \"<string>\",\n        \"virtual\": \"<boolean>\"\n      },\n      \"details\": [\n        {\n          \"title\": \"<string>\",\n          \"description\": \"<string>\"\n        },\n        {\n          \"title\": \"<string>\",\n          \"description\": \"<string>\"\n        }\n      ],\n      \"bank_iban\": \"<string>\",\n      \"bank_name\": \"<string>\",\n      \"bank_beneficiary\": \"<string>\",\n      \"ei_payment_method\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/info/payment_methods?fields=<string>&fieldset=basic&sort=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "info",
            "payment_methods"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            },
            {
              "key": "sort",
              "value": "<string>",
              "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/info/payment_methods?fields=<string>&fieldset=basic&sort=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "info",
            "payment_methods"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            },
            {
              "key": "sort",
              "value": "<string>",
              "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}