Chilkat Online Tools

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

Back to Collection Items

import sys
import chilkat

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

http = chilkat.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>"
#   }
# }

json = chilkat.CkJsonObject()
json.UpdateString("data.name","<string>")
json.UpdateString("data.id","<integer>")
json.UpdateString("data.type","standard")
json.UpdateString("data.is_default","<boolean>")
json.UpdateString("data.default_payment_account.name","<string>")
json.UpdateString("data.default_payment_account.id","<integer>")
json.UpdateString("data.default_payment_account.type","standard")
json.UpdateString("data.default_payment_account.iban","<string>")
json.UpdateString("data.default_payment_account.sia","<string>")
json.UpdateString("data.default_payment_account.cuc","<string>")
json.UpdateString("data.default_payment_account.virtual","<boolean>")
json.UpdateString("data.details[0].title","<string>")
json.UpdateString("data.details[0].description","<string>")
json.UpdateString("data.details[1].title","<string>")
json.UpdateString("data.details[1].description","<string>")
json.UpdateString("data.bank_iban","<string>")
json.UpdateString("data.bank_name","<string>")
json.UpdateString("data.bank_beneficiary","<string>")
json.UpdateString("data.ei_payment_method","<string>")

http.SetRequestHeader("Content-Type","application/json")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://api-v2.fattureincloud.it/c/:company_id/settings/payment_methods","application/json",json)
if (http.get_LastMethodSuccess() == False):
    print(http.lastErrorText())
    sys.exit()

sbResponseBody = chilkat.CkStringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)

print("Response Body:")
print(jResp.emit())

respStatusCode = resp.get_StatusCode()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.header())
    print("Failed.")

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

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

Id = jResp.stringOf("data.id")
Name = jResp.stringOf("data.name")
v_Type = jResp.stringOf("data.type")
Is_default = jResp.stringOf("data.is_default")
Default_payment_accountId = jResp.stringOf("data.default_payment_account.id")
Default_payment_accountName = jResp.stringOf("data.default_payment_account.name")
Default_payment_accountType = jResp.stringOf("data.default_payment_account.type")
Iban = jResp.stringOf("data.default_payment_account.iban")
Sia = jResp.stringOf("data.default_payment_account.sia")
Cuc = jResp.stringOf("data.default_payment_account.cuc")
v_Virtual = jResp.stringOf("data.default_payment_account.virtual")
Bank_iban = jResp.stringOf("data.bank_iban")
Bank_name = jResp.stringOf("data.bank_name")
Bank_beneficiary = jResp.stringOf("data.bank_beneficiary")
Ei_payment_method = jResp.stringOf("data.ei_payment_method")
i = 0
count_i = jResp.SizeOfArray("data.details")
while i < count_i :
    jResp.put_I(i)
    title = jResp.stringOf("data.details[i].title")
    description = jResp.stringOf("data.details[i].description")
    i = i + 1

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