Chilkat Online Tools

TCL / Fatture in Cloud API v2 - API Reference / Create Payment Method

Back to Collection Items

load ./chilkat.dll

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

set 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.

# {
#   "data": {
#     "name": "<string>",
#     "id": "<integer>",
#     "type": "standard",
#     "is_default": "<boolean>",
#     "default_payment_account": {
#       "name": "<string>",
#       "id": "<integer>",
#       "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>"
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "data.name" "<string>"
CkJsonObject_UpdateString $json "data.id" "<integer>"
CkJsonObject_UpdateString $json "data.type" "standard"
CkJsonObject_UpdateString $json "data.is_default" "<boolean>"
CkJsonObject_UpdateString $json "data.default_payment_account.name" "<string>"
CkJsonObject_UpdateString $json "data.default_payment_account.id" "<integer>"
CkJsonObject_UpdateString $json "data.default_payment_account.type" "standard"
CkJsonObject_UpdateString $json "data.default_payment_account.iban" "<string>"
CkJsonObject_UpdateString $json "data.default_payment_account.sia" "<string>"
CkJsonObject_UpdateString $json "data.default_payment_account.cuc" "<string>"
CkJsonObject_UpdateString $json "data.default_payment_account.virtual" "<boolean>"
CkJsonObject_UpdateString $json "data.details[0].title" "<string>"
CkJsonObject_UpdateString $json "data.details[0].description" "<string>"
CkJsonObject_UpdateString $json "data.details[1].title" "<string>"
CkJsonObject_UpdateString $json "data.details[1].description" "<string>"
CkJsonObject_UpdateString $json "data.bank_iban" "<string>"
CkJsonObject_UpdateString $json "data.bank_name" "<string>"
CkJsonObject_UpdateString $json "data.bank_beneficiary" "<string>"
CkJsonObject_UpdateString $json "data.ei_payment_method" "<string>"

CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Accept" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api-v2.fattureincloud.it/c/:company_id/settings/payment_methods" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

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

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

set Id [CkJsonObject_stringOf $jResp "data.id"]
set Name [CkJsonObject_stringOf $jResp "data.name"]
set v_Type [CkJsonObject_stringOf $jResp "data.type"]
set Is_default [CkJsonObject_stringOf $jResp "data.is_default"]
set Default_payment_accountId [CkJsonObject_stringOf $jResp "data.default_payment_account.id"]
set Default_payment_accountName [CkJsonObject_stringOf $jResp "data.default_payment_account.name"]
set Default_payment_accountType [CkJsonObject_stringOf $jResp "data.default_payment_account.type"]
set Iban [CkJsonObject_stringOf $jResp "data.default_payment_account.iban"]
set Sia [CkJsonObject_stringOf $jResp "data.default_payment_account.sia"]
set Cuc [CkJsonObject_stringOf $jResp "data.default_payment_account.cuc"]
set v_Virtual [CkJsonObject_stringOf $jResp "data.default_payment_account.virtual"]
set Bank_iban [CkJsonObject_stringOf $jResp "data.bank_iban"]
set Bank_name [CkJsonObject_stringOf $jResp "data.bank_name"]
set Bank_beneficiary [CkJsonObject_stringOf $jResp "data.bank_beneficiary"]
set Ei_payment_method [CkJsonObject_stringOf $jResp "data.ei_payment_method"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data.details"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set title [CkJsonObject_stringOf $jResp "data.details[i].title"]
    set description [CkJsonObject_stringOf $jResp "data.details[i].description"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "name": "<string>",
    "id": "<integer>",
    "type": "standard",
    "is_default": "<boolean>",
    "default_payment_account": {
      "name": "<string>",
      "id": "<integer>",
      "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>"
  }
}'
https://api-v2.fattureincloud.it/c/:company_id/settings/payment_methods

Postman Collection Item JSON

{
  "name": "Create Payment Method",
  "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": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"name\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"type\": \"standard\",\n    \"is_default\": \"<boolean>\",\n    \"default_payment_account\": {\n      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\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}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/c/:company_id/settings/payment_methods",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "settings",
        "payment_methods"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Creates a new payment method."
  },
  "response": [
    {
      "name": "Example response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"name\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"type\": \"standard\",\n    \"is_default\": \"<boolean>\",\n    \"default_payment_account\": {\n      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/settings/payment_methods",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "settings",
            "payment_methods"
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\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}"
    }
  ]
}