Chilkat Online Tools

VB6 / Fatture in Cloud API v2 - API Reference / Modify Payment Method

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

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

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

http.SetRequestHeader "Content-Type","application/json"
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader "Accept","application/json"

Dim sbRequestBody As New ChilkatStringBuilder
success = json.EmitSb(sbRequestBody)

Dim resp As ChilkatHttpResponse
Set resp = http.PTextSb("PUT","https://api-v2.fattureincloud.it/c/:company_id/settings/payment_methods/:payment_method_id",sbRequestBody,"utf-8","application/json",0,0)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' 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

Dim title As String
Dim description As String

Dim Id As String
Id = jResp.StringOf("data.id")
Dim Name As String
Name = jResp.StringOf("data.name")
Dim v_Type As String
v_Type = jResp.StringOf("data.type")
Dim Is_default As String
Is_default = jResp.StringOf("data.is_default")
Dim Default_payment_accountId As String
Default_payment_accountId = jResp.StringOf("data.default_payment_account.id")
Dim Default_payment_accountName As String
Default_payment_accountName = jResp.StringOf("data.default_payment_account.name")
Dim Default_payment_accountType As String
Default_payment_accountType = jResp.StringOf("data.default_payment_account.type")
Dim Iban As String
Iban = jResp.StringOf("data.default_payment_account.iban")
Dim Sia As String
Sia = jResp.StringOf("data.default_payment_account.sia")
Dim Cuc As String
Cuc = jResp.StringOf("data.default_payment_account.cuc")
Dim v_Virtual As String
v_Virtual = jResp.StringOf("data.default_payment_account.virtual")
Dim Bank_iban As String
Bank_iban = jResp.StringOf("data.bank_iban")
Dim Bank_name As String
Bank_name = jResp.StringOf("data.bank_name")
Dim Bank_beneficiary As String
Bank_beneficiary = jResp.StringOf("data.bank_beneficiary")
Dim Ei_payment_method As String
Ei_payment_method = jResp.StringOf("data.ei_payment_method")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("data.details")
Do While i < count_i
    jResp.I = i
    title = jResp.StringOf("data.details[i].title")
    description = jResp.StringOf("data.details[i].description")
    i = i + 1
Loop

Curl Command

curl -X PUT
	-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/:payment_method_id

Postman Collection Item JSON

{
  "name": "Modify 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": "PUT",
    "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/:payment_method_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "settings",
        "payment_methods",
        ":payment_method_id"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        },
        {
          "key": "payment_method_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Modifies the specified payment method."
  },
  "response": [
    {
      "name": "Example response",
      "originalRequest": {
        "method": "PUT",
        "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/:payment_method_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "settings",
            "payment_methods",
            ":payment_method_id"
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "payment_method_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}"
    }
  ]
}