Chilkat Online Tools

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

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess

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

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

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

Local $oResp = $oHttp.PostJson3("https://api-v2.fattureincloud.it/c/:company_id/settings/payment_methods","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sTitle
Local $sDescription

Local $sId = $oJResp.StringOf("data.id")
Local $sName = $oJResp.StringOf("data.name")
Local $sV_Type = $oJResp.StringOf("data.type")
Local $sIs_default = $oJResp.StringOf("data.is_default")
Local $sDefault_payment_accountId = $oJResp.StringOf("data.default_payment_account.id")
Local $sDefault_payment_accountName = $oJResp.StringOf("data.default_payment_account.name")
Local $sDefault_payment_accountType = $oJResp.StringOf("data.default_payment_account.type")
Local $sIban = $oJResp.StringOf("data.default_payment_account.iban")
Local $sSia = $oJResp.StringOf("data.default_payment_account.sia")
Local $sCuc = $oJResp.StringOf("data.default_payment_account.cuc")
Local $sV_Virtual = $oJResp.StringOf("data.default_payment_account.virtual")
Local $sBank_iban = $oJResp.StringOf("data.bank_iban")
Local $sBank_name = $oJResp.StringOf("data.bank_name")
Local $sBank_beneficiary = $oJResp.StringOf("data.bank_beneficiary")
Local $sEi_payment_method = $oJResp.StringOf("data.ei_payment_method")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data.details")
While $i < $iCount_i
    $oJResp.I = $i
    $sTitle = $oJResp.StringOf("data.details[i].title")
    $sDescription = $oJResp.StringOf("data.details[i].description")
    $i = $i + 1
Wend

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