---
title: Create additional fulfilment payment
slug: docs/demo/create-additional-fulfilment-payment
description: Learn how to make a payment using the Fictive API with this code example featuring a CURL request. Explore the step-by-step guide on how to include necessary parameters like payment date, method, VAT amount, and more for a successful transaction.
docTags: 
createdAt: 2022-03-21T20:12:45.000Z
---

{
  "id": "C_RkJe2Mas3YRfkWtmjd1",
  "data": {
    "url": "https://api.fictive.com/REST/api/accounts/{accountReference}/fulfilments/{fulfilmentReference}/payments",
    "name": "Create additional fulfilment payment",
    "method": "POST",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "accountReference",
          "type": "string",
          "description": "ID of the eSuite account"
        },
        {
          "kind": "required",
          "name": "fulfilmentReference",
          "type": "string",
          "description": "Fulfilment resource identifier"
        }
      ],
      "queryParameters": [],
      "headerParameters": [
        {
          "kind": "optional",
          "name": "X-TokenId",
          "type": "string",
          "description": "The eSuite Token Id"
        },
        {
          "kind": "optional",
          "name": "X-SessionId",
          "type": "string",
          "description": "The eSuite Session Id"
        },
        {
          "kind": "required",
          "name": "X-Version",
          "type": "string",
          "description": "The eSuite Version"
        },
        {
          "kind": "optional",
          "name": "Origin",
          "type": "string",
          "description": "The eSuite Origin"
        }
      ],
      "bodyDataParameters": [
        {
          "kind": "required",
          "name": "payment",
          "type": "object",
          "schema": [
            {
              "kind": "optional",
              "name": "paymentDate",
              "type": "string<date-time>",
              "example": "",
              "description": "The date the payment will happen."
            },
            {
              "kind": "optional",
              "name": "paymentMethod",
              "type": "string",
              "example": "",
              "description": "Payment method."
            },
            {
              "kind": "optional",
              "name": "vatAmount",
              "type": "number<double>",
              "example": "",
              "description": "Payment vat amount."
            },
            {
              "kind": "optional",
              "name": "grossAmount",
              "type": "number<double>",
              "example": "",
              "description": "Payment gross amount."
            },
            {
              "kind": "optional",
              "name": "netAmount",
              "type": "number<double>",
              "example": "",
              "description": "Payment net amount."
            },
            {
              "kind": "optional",
              "name": "currency",
              "type": "string<ZZZ | GBP | EUR | USD | AUD | CAD | SEK | DKK | JPY | FictiveCREDITS | SAR | BGN | TWD | CZK | ILS | HUF | ISK | KRW | NOK | PLN | BRL | CHF | RON | RUB | HRK | ALL | THB | TRY | PKR | IDR | UAH | BYR | EEK | LVL | LTL | TJS | IRR | VND | AMD | AZN | MKD | ZAR | GEL | INR | MYR | KZT | KGS | KES | TMT | UZS | MNT | CNY | KHR | LAK | SYP | LKR | ETB | NPR | AFN | PHP | MVR | NIO | BOB | CLP | NZD | GTQ | RWF | XOF | IQD | MXN | CSD | BND | BDT | DZD | EGP | HKD | PEN | LYD | SGD | BAM | MOP | CRC | MAD | PAB | TND | DOP | OMR | JMD | VEB | YER | COP | RSD | BZD | JOD | TTD | ARS | LBP | ZWL | KWD | AED | UYU | BHD | PYG | QAR | HNL>",
              "example": "",
              "description": "Payment currency."
            },
            {
              "kind": "optional",
              "name": "customPaymentParameters",
              "type": "object",
              "schema": [],
              "example": {},
              "description": "Custom payment parameters of the payment."
            }
          ],
          "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v2.PaymentInstructions.AdditionalPayment",
          "customType": "FictiveGlobal.Api.Rest.Dtos.v2.PaymentInstructions.AdditionalPayment",
          "isExpanded": true,
          "description": "This is a class used to save additional payments."
        }
      ],
      "formDataParameters": []
    },
    "responses": [
      {
        "isExpanded": true,
        "statusCode": "202",
        "description": "No Content",
        "jsonExample": ""
      },
      {
        "isExpanded": true,
        "statusCode": "400",
        "description": "• Invalid payment date provided\r\n            <br />• Invalid payment method provided\r\n            <br />• Invalid format for VAT amount\r\n            <br />• Invalid format for net amount\r\n            <br />• Invalid format for gross amount\r\n            <br />• Invalid currency provided",
        "jsonExample": ""
      },
      {
        "isExpanded": true,
        "statusCode": "401",
        "description": "API Authentication Failure: Invalid Authentication Type/Credentials Provided",
        "jsonExample": ""
      },
      {
        "isExpanded": true,
        "statusCode": "404",
        "description": "• Account cannot be found\r\n            <br />• Fulfilment cannot be found",
        "jsonExample": ""
      },
      {
        "isExpanded": true,
        "statusCode": "412",
        "description": "• Fulfilments is in an invalid status to add an additional payment\r\n            <br />• Offline payment are not enabled for your instance.\r\n            <br />• The sum of net and VAT must equal the gross amount provided\r\n            <br />• [Currency ISO Code] is not enabled for your instance\r\n            <br />• The currency provided must match that used for other transactions for the fulfilment\r\n            <br />• [Parameter Name] is not configured as a custom payment parameter for your instance",
        "jsonExample": ""
      }
    ],
    "contentType": "application/json",
    "description": "This endpoint will provide the ability to add an additional payment to an existing fulfilment within eSuite",
    "examples": {
      "languages": [
        {
          "id": "lzCGRygSa2PK103wZOlcJ",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url https://api.fictive.com/REST/api/accounts/{accountReference}/fulfilments/{fulfilmentReference}/payments \\\n     --header 'accept: application/json' \\\n     --header 'x-version: string'"
        },
        {
          "id": "U5c9Iy6MVL1hz9h6QlbOK",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-version\", \"string\");\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.fictive.com/REST/api/accounts/{accountReference}/fulfilments/{fulfilmentReference}/payments\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "TM7TmqY97-5OQYBdS2Ryi",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.fictive.com/REST/api/accounts/{accountReference}/fulfilments/{fulfilmentReference}/payments\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-version\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "RnMMNG8sY-ZGEFsZMM58r",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.fictive.com/REST/api/accounts/{accountReference}/fulfilments/{fulfilmentReference}/payments\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json',\n   'x-version': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "lzCGRygSa2PK103wZOlcJ"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-202",
          "language": "202",
          "code": "// No Content\n"
        },
        {
          "id": "response-1-400",
          "language": "400",
          "code": "// • Invalid payment date provided\r\n            • Invalid payment method provided\r\n            • Invalid format for VAT amount\r\n            • Invalid format for net amount\r\n            • Invalid format for gross amount\r\n            • Invalid currency provided\n"
        },
        {
          "id": "response-2-401",
          "language": "401",
          "code": "// API Authentication Failure: Invalid Authentication Type/Credentials Provided\n"
        },
        {
          "id": "response-3-404",
          "language": "404",
          "code": "// • Account cannot be found\r\n            • Fulfilment cannot be found\n"
        },
        {
          "id": "response-4-412",
          "language": "412",
          "code": "// • Fulfilments is in an invalid status to add an additional payment\r\n            • Offline payment are not enabled for your instance.\r\n            • The sum of net and VAT must equal the gross amount provided\r\n            • [Currency ISO Code] is not enabled for your instance\r\n            • The currency provided must match that used for other transactions for the fulfilment\r\n            • [Parameter Name] is not configured as a custom payment parameter for your instance\n"
        }
      ],
      "selectedLanguageId": "response-0-202"
    }
  },
  "type": "api-oas-v2",
  "children": [
    {
      "text": ""
    }
  ]
}