---
title: CARE Settlement EU
slug: public-apis/care-settlement-eu
createdAt: 2026-06-10T18:51:42.322Z
---

{
  "id": "OtVFefgVhwREhvFB-uC1S",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "https://rtd01.eu.accertify.net/icNowImport/{settlementimporterID}",
    "name": "CARE Settlement EU",
    "description": "<p>The CARE API accepts data for Final CARE Request. This incudes claims, adjustments, refunds, returns, &#x26; exchanges.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "settlementimporterID",
          "type": "string",
          "description": ""
        }
      ],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "optional",
          "name": "settlementtransaction",
          "type": "object",
          "description": "<p>There are two data flows for processing your CARE Settlements:</p>",
          "schema": [
            {
              "name": "eventSource",
              "kind": "required",
              "type": "string<agentPhone | agentStore | affiliate | kiosk | mobileApp | other | web>",
              "description": "<p>[REQUIRED] Required. Where or how the event originated.</p>",
              "enum": [
                "agentPhone",
                "agentStore",
                "affiliate",
                "kiosk",
                "mobileApp",
                "other",
                "web"
              ]
            },
            {
              "name": "careID",
              "kind": "required",
              "type": "string",
              "description": "Required. Unique identifier for this CARE settlement or request.",
              "example": "32sfdu8f23234"
            },
            {
              "name": "careTransactionDateTime",
              "kind": "optional",
              "type": "string<date-time>",
              "description": "<p>Imperative. Time the request or settlement was sent via API in RFC3339 format yyyy-MM-dd'T'HH:mm</p><div></div>.<p></p>\n<p><strong>Note</strong>: This field does not accept future dates.</p>",
              "example": "2022-07-12T15:46:34+00:00",
              "format": "date-time"
            },
            {
              "name": "careRequestAmount",
              "kind": "required",
              "type": "number<float>",
              "description": "<p>[CONDITIONAL] Required for Request. Total amount associated with the request in local currency.</p>",
              "example": 1082.91,
              "format": "float"
            },
            {
              "name": "careSettlementAmount",
              "kind": "required",
              "type": "number<float>",
              "description": "<p>[CONDITIONAL] Required for Settlements. Total amount associated with the settlement in local currency.</p>",
              "example": 1082.91,
              "format": "float"
            },
            {
              "name": "careCurrencyCode",
              "kind": "required",
              "type": "string",
              "description": "<p>Required. Required. Consumer's local three-character currency code in ISO 4217 format. This applies to all amounts in the API. You should only pass us one universal Currency Code.\n<strong>Notes</strong>: - If reshipping or $0 is the careAmount, put the currency code from the original transaction.</p>\n<ul>\n<li>If store credit, translate the careAmount to USD and put USD here.</li>\n</ul>",
              "example": "USD"
            },
            {
              "name": "careEventType",
              "kind": "required",
              "type": "string<claim | adjustment | refund | reship | return | exchange>",
              "description": "<p>Required. Type of request or settlement.</p>\n<p>Options are:</p>\n<ul>\n<li>claim</li>\n<li>adjustment</li>\n<li>refund</li>\n<li>reship</li>\n<li>return</li>\n<li>exchange</li>\n</ul>",
              "enum": [
                "claim",
                "adjustment",
                "refund",
                "reship",
                "return",
                "exchange"
              ]
            },
            {
              "name": "careReason",
              "kind": "required",
              "type": "string<boxDamaged | didNotReceive | duplicateItem | itemDamaged | itemDefective | itemIncorrect | itemNotNeeded | itemNoLongerWanted>",
              "description": "<p>Required. Your customized reason for the request or settlement.</p>\n<p>Options are:</p>\n<ul>\n<li>boxDamaged</li>\n<li>didNotReceive</li>\n<li>duplicateItem</li>\n<li>itemDamaged</li>\n<li>itemDefective</li>\n<li>itemIncorrect</li>\n<li>itemNotNeeded</li>\n<li>itemNoLongerWanted</li>\n</ul>",
              "example": "itemNoLongerWanted",
              "enum": [
                "boxDamaged",
                "didNotReceive",
                "duplicateItem",
                "itemDamaged",
                "itemDefective",
                "itemIncorrect",
                "itemNotNeeded",
                "itemNoLongerWanted"
              ]
            },
            {
              "name": "originalTransactionID",
              "kind": "required",
              "type": "string",
              "description": "Required. Original transaction's unique identifier. \n \n",
              "example": 32432234
            },
            {
              "name": "accountID",
              "kind": "optional",
              "type": "string",
              "description": "Imperative. Unique identifier you associated with the account.\n    \n",
              "example": 98893298432
            },
            {
              "name": "ipAddress",
              "kind": "optional",
              "type": "string",
              "description": "<p>[IMPERATIVE] Imperative. User's IP Address you captured. Maximum field length = 45 characters.</p>",
              "example": "192.168.41.17"
            },
            {
              "name": "emailAddress",
              "kind": "optional",
              "type": "string",
              "description": "<p>[IMPERATIVE] Imperative. User's email address associated with their Account. Maximum field length = 100 characters.</p>",
              "example": "a@b.com"
            },
            {
              "name": "items",
              "kind": "optional",
              "type": "array",
              "description": "Array introducing the items block.",
              "example": "",
              "itemType": "object",
              "customType": "object[]",
              "schema": [
                {
                  "name": "isGiftCard",
                  "kind": "optional",
                  "type": "string<true | false>",
                  "description": "<p>Optional. Whether or not the transacted item was a gift card.</p>\n<p>Options are:</p>\n<ul>\n<li>true</li>\n<li>false</li>\n</ul>",
                  "enum": [
                    "true",
                    "false"
                  ]
                },
                {
                  "name": "brandName",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. The brand name of the transacted item. Maximum field length = 20 characters.</p>",
                  "example": "Apple"
                },
                {
                  "name": "category",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Category the item falls under. Maximum field length = 100 characters.</p>",
                  "example": "Computer"
                },
                {
                  "name": "description",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Description of the transacted item. Maximum field length = 40 characters.</p>",
                  "example": "Macbook Pro"
                },
                {
                  "name": "itemID",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Item identifier, such as a SKU number, that you provide. Maximum field length = 20 characters.</p>",
                  "example": "SKU123"
                },
                {
                  "name": "price",
                  "kind": "optional",
                  "type": "number",
                  "description": "<p>Optional. Cost of the individual item. Format = two decimals.</p>",
                  "example": 9.99
                },
                {
                  "name": "quantity",
                  "kind": "optional",
                  "type": "number",
                  "description": "<p>Optional. Quantity of the transacted item. This field takes decimals. Maximum field length = 12 characters.</p>",
                  "example": 3
                },
                {
                  "name": "addressID",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Identifier we apply to addresses to differentiate orders with multiples. Maximum field length = 40 characters.</p>",
                  "example": "23kj423klj234j"
                },
                {
                  "name": "productCondition",
                  "kind": "optional",
                  "type": "string<new | openPackage | other | refurbished | used>",
                  "description": "<p>Optional. Condition of the product.</p>\n<p>Options are:</p>\n<ul>\n<li>new</li>\n<li>openPackage</li>\n<li>other</li>\n<li>refurbished</li>\n<li>used</li>\n</ul>",
                  "enum": [
                    "new",
                    "openPackage",
                    "other",
                    "refurbished",
                    "used"
                  ]
                },
                {
                  "name": "shippingCompany",
                  "kind": "optional",
                  "type": "string<dhl | fedex | ups | usps | other>",
                  "description": "<p>Optional. Name of shipping company for merchant-to-consumer initial delivery.</p>\n<p>Options are:</p>\n<ul>\n<li>dhl</li>\n<li>fedex</li>\n<li>ups</li>\n<li>usps</li>\n<li>other</li>\n</ul>",
                  "enum": [
                    "dhl",
                    "fedex",
                    "ups",
                    "usps",
                    "other"
                  ]
                },
                {
                  "name": "shippingMethod",
                  "kind": "optional",
                  "type": "string<digital | ground | international | other | nextDay | sameDay | storePickup | twoDay | threeDay>",
                  "description": "<p>Optional. How the item was shipped from customer to merchant.</p>\n<p>Options are:</p>\n<ul>\n<li>digital</li>\n<li>ground</li>\n<li>international</li>\n<li>other</li>\n<li>nextDay</li>\n<li>sameDay</li>\n<li>storePickup</li>\n<li>twoDay</li>\n<li>threeDay</li>\n</ul>",
                  "enum": [
                    "digital",
                    "ground",
                    "international",
                    "other",
                    "nextDay",
                    "sameDay",
                    "storePickup",
                    "twoDay",
                    "threeDay"
                  ]
                },
                {
                  "name": "shippingTrackingNumber",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Shipping company tracking number. Maximum field length = 30 characters.</p>",
                  "example": "23l4fdswerea02"
                },
                {
                  "name": "isLargeItemDelivery",
                  "kind": "optional",
                  "type": "string<true | false>",
                  "description": "<p>Optional. Whether this is delivery of a large item.</p>\n<p>Options are:</p>\n<ul>\n<li>true</li>\n<li>false</li>\n</ul>",
                  "enum": [
                    "true",
                    "false"
                  ]
                },
                {
                  "name": "careItemReason",
                  "kind": "optional",
                  "type": "string<boxDamaged | didNotReceive | duplicateItem | itemDamaged | itemDefective | itemIncorrect | itemNotNeeded | itemNoLongerWanted>",
                  "description": "<p>Optional. Reason the customer gave for the adjustment for that item.</p>\n<p>Options are:</p>\n<ul>\n<li>boxDamaged</li>\n<li>didNotReceive</li>\n<li>duplicateItem</li>\n<li>itemDamaged</li>\n<li>itemDefective</li>\n<li>itemIncorrect</li>\n<li>itemNotNeeded</li>\n<li>itemNoLongerWanted</li>\n</ul>",
                  "enum": [
                    "boxDamaged",
                    "didNotReceive",
                    "duplicateItem",
                    "itemDamaged",
                    "itemDefective",
                    "itemIncorrect",
                    "itemNotNeeded",
                    "itemNoLongerWanted"
                  ]
                },
                {
                  "name": "careSettlementReason",
                  "kind": "optional",
                  "type": "string<inspectedAndInvoiced | emptyBox>",
                  "description": "Optional. The reason for the settlement decision.",
                  "example": "inspectedAndInvoiced",
                  "enum": [
                    "inspectedAndInvoiced",
                    "emptyBox"
                  ]
                },
                {
                  "name": "careSettlementDecision",
                  "kind": "optional",
                  "type": "string<accept | deny | review>",
                  "description": "Required. The outcome of the care transaction.",
                  "example": "deny",
                  "enum": [
                    "accept",
                    "deny",
                    "review"
                  ]
                },
                {
                  "name": "careSettlementPrice",
                  "kind": "optional",
                  "type": "number",
                  "description": "Optional. Retail cost of the items in the itemID.",
                  "example": 121.49
                },
                {
                  "name": "careSettlementUnits",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Number of items in the itemID.",
                  "example": "1"
                },
                {
                  "name": "originationScanPostCode",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. The postal code where the origination scan of the return occurred. \n",
                  "example": 60143
                },
                {
                  "name": "returnDeliveryDateTime",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Date and time the item was returned in RFC3339 format yyyy-MM-dd.</p>\n<p><strong>Note</strong>: This field does not accept future dates.</p>",
                  "example": "2022-01-01T17:07:24-07:00"
                },
                {
                  "name": "returnShippingMethod",
                  "kind": "optional",
                  "type": "string<ground | international | other | nextDay | sameDay | storePickup | twoDay | threeDay>",
                  "description": "<p>Optional. How the item was shipped from customer to merchant.</p>\n<p>Options are:</p>\n<ul>\n<li>ground</li>\n<li>international</li>\n<li>other</li>\n<li>nextDay</li>\n<li>sameDay</li>\n<li>storePickup</li>\n<li>twoDay</li>\n<li>threeDay</li>\n</ul>",
                  "example": "ground",
                  "enum": [
                    "ground",
                    "international",
                    "other",
                    "nextDay",
                    "sameDay",
                    "storePickup",
                    "twoDay",
                    "threeDay"
                  ]
                },
                {
                  "name": "returnTrackingNumber",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Shipping company tracking number on the item's return.\n",
                  "example": "23jkljksldsj23e4"
                },
                {
                  "name": "originalDeliveryDateTime",
                  "kind": "optional",
                  "type": "string<date-time>",
                  "description": "<p>Optional. Time the item was originally delivered in RFC3339 format yyyy-MM-dd'T'HH:mm</p><div></div>.<p></p>\n<p><strong>Note</strong>: This field does not accept future dates.</p>",
                  "example": "2022-03-11T17:07:24-07:00",
                  "format": "date-time"
                },
                {
                  "name": "isDeliveryImageProvided",
                  "kind": "optional",
                  "type": "string<true | false>",
                  "description": "<p>Optional. Whether the item's original delivery has an image.</p>\n<p>Options are:</p>\n<ul>\n<li>true</li>\n<li>false</li>\n</ul>",
                  "enum": [
                    "true",
                    "false"
                  ]
                },
                {
                  "name": "deliveryImage",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Signature image (Base 64 encoded) of the item's delivery. Maximum field length = 4000 characters.</p>"
                }
              ]
            },
            {
              "name": "brand",
              "kind": "optional",
              "type": "string",
              "description": "<p>[OPTIONAL] Optional. The brand submitting the event. Maximum field length = 50 characters.</p>\n<p><strong>Note</strong>: For clients with multiple brands under one corporate entity.</p>",
              "example": "Acme"
            },
            {
              "name": "addresses",
              "kind": "optional",
              "type": "array",
              "description": "Array introducing the addresses block.",
              "example": "",
              "itemType": "object",
              "customType": "object[]",
              "schema": [
                {
                  "name": "address1",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Address line 1.",
                  "example": "1863 Main Street"
                },
                {
                  "name": "address2",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Address line 2.",
                  "example": "Apt 7"
                },
                {
                  "name": "addressID",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Identifier for the address."
                },
                {
                  "name": "addressType",
                  "kind": "optional",
                  "type": "string<shipping | billing>",
                  "description": "Optional. Address type.",
                  "example": "shipping",
                  "enum": [
                    "shipping",
                    "billing"
                  ]
                },
                {
                  "name": "city",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. City.",
                  "example": "Anaheim"
                },
                {
                  "name": "country",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Country code.",
                  "example": "US"
                },
                {
                  "name": "emailAddress",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Email address associated with the address.",
                  "example": "jane.doe123@gmail.com"
                },
                {
                  "name": "firstName",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. First name associated with the address."
                },
                {
                  "name": "lastName",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Last name associated with the address."
                },
                {
                  "name": "phone",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Phone number associated with the address.",
                  "example": "3125555555"
                },
                {
                  "name": "phoneCountryCode",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Phone country code associated with the address.",
                  "example": "001"
                },
                {
                  "name": "postCode",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Postal code.",
                  "example": "92802"
                },
                {
                  "name": "region",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Region/state/province.</p>",
                  "example": "CA"
                }
              ]
            },
            {
              "name": "paymentMethods",
              "kind": "optional",
              "type": "array",
              "description": "Array introducing the paymentMethods block.",
              "example": "",
              "itemType": "object",
              "customType": "object[]",
              "schema": [
                {
                  "name": "cardBin",
                  "kind": "optional",
                  "type": "number<float>",
                  "description": "Optional. Card BIN.",
                  "example": 345678,
                  "format": "float"
                },
                {
                  "name": "cardLastFour",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Card last four.",
                  "example": "4564"
                },
                {
                  "name": "cardNumber",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Card number.",
                  "example": "Kb7ofu6hYN4WxM4_INAZigXoWlAi79LuhcSpwx5UcVc"
                },
                {
                  "name": "cardToken",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Card token."
                },
                {
                  "name": "emailAddress",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Email address associated with the payment method.",
                  "example": "jane.doe123@gmail.com"
                },
                {
                  "name": "expirationDay",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Expiration day.",
                  "example": "12"
                },
                {
                  "name": "expirationMonth",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Expiration month.",
                  "example": "11"
                },
                {
                  "name": "expirationYear",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Expiration year.",
                  "example": "2026"
                },
                {
                  "name": "giftCardBIN",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Gift card BIN.",
                  "example": "4111"
                },
                {
                  "name": "giftCardLastFour",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Gift card last four.",
                  "example": "1111"
                },
                {
                  "name": "giftCardNumber",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Gift card number.",
                  "example": "a789sdf8asdfasd89f789asd78"
                },
                {
                  "name": "isPaymentStoredOnFile",
                  "kind": "optional",
                  "type": "boolean",
                  "description": "Optional. Indicates whether the payment method is stored on file.",
                  "example": true
                },
                {
                  "name": "loyaltyProgramName",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Loyalty program name.",
                  "example": "Acme Platinum"
                },
                {
                  "name": "nameOnAccount",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Name on account.",
                  "example": "Jane Doe"
                },
                {
                  "name": "nameOnCreditCard",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Name on credit card.",
                  "example": "Jane Doe"
                },
                {
                  "name": "paymentMethodAmount",
                  "kind": "optional",
                  "type": "number<float>",
                  "description": "Optional. Amount for this payment method.",
                  "example": 1,
                  "format": "float"
                },
                {
                  "name": "paymentMethodBalanceAmount",
                  "kind": "optional",
                  "type": "number<float>",
                  "description": "Optional. Balance amount for this payment method.",
                  "format": "float"
                },
                {
                  "name": "paymentMethodID",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Identifier for the payment method.",
                  "example": "2ljr9vxsdfew"
                },
                {
                  "name": "paymentType",
                  "kind": "optional",
                  "type": "string<creditCard | digitalWallet | giftCard | voucher | loyaltyPoints | bankAccount>",
                  "description": "Optional. Payment method type.",
                  "example": "creditCard",
                  "enum": [
                    "creditCard",
                    "digitalWallet",
                    "giftCard",
                    "voucher",
                    "loyaltyPoints",
                    "bankAccount"
                  ]
                },
                {
                  "name": "points",
                  "kind": "optional",
                  "type": "number<float>",
                  "description": "Optional. Loyalty points.",
                  "example": 50000,
                  "format": "float"
                },
                {
                  "name": "walletStatus",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Digital wallet status.",
                  "example": "active"
                },
                {
                  "name": "walletType",
                  "kind": "optional",
                  "type": "string",
                  "description": "Optional. Digital wallet type.",
                  "example": "Applepay"
                }
              ]
            }
          ],
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "oauth2",
          "name": "oauth2",
          "kind": "optional",
          "type": "oauth2",
          "description": ""
        }
      ]
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "Success response",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "Success response",
            "customType": "successResponse",
            "schema": [
              {
                "name": "transaction-results",
                "kind": "optional",
                "type": "object",
                "description": "A block indicating the results of your successful call.",
                "example": "{\"transaction-id\":\"ba563b98-36fa-42f2-a8af-3fd4af34e347\",\"cross-reference\":\"f85b9ed2-fe5a-425a-9ff5-a9988e56110b\",\"remarks\":\"\",\"warnings\":{}}",
                "schema": [
                  {
                    "name": "transaction-id",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>Transaction's unique identifier. Typically, this is your order number.</p>\n<p><strong>Note</strong>: This is the transactionID field.</p>"
                  },
                  {
                    "name": "cross-reference",
                    "kind": "optional",
                    "type": "string",
                    "description": "Unique identifier Accertify assigns to this transaction. It is a cross reference to the transactionID field."
                  },
                  {
                    "name": "remarks",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>Details left by an analyst if they resolve the transaction.</p>\n<p><strong>Example</strong>: AT: 5/5/21 1:04</p><div></div> PM CDT<p></p>"
                  },
                  {
                    "name": "warnings",
                    "kind": "optional",
                    "type": "object",
                    "description": "Validation warning we provide even if the transaction comes through successfully.",
                    "example": "",
                    "schema": []
                  }
                ]
              }
            ],
            "modelRef": "#/definitions/successResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "400",
        "description": "Error response",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"error\":\"The request could not be processed\",\"validation_response\":{\"errors\":{\"Transaction ID\":\"A unique transaction ID is required (max length = 40)\"},\"status\":false}}",
            "description": "Error response",
            "customType": "errorResponse",
            "schema": [
              {
                "name": "validation_response",
                "kind": "optional",
                "type": "object",
                "description": "",
                "example": "",
                "schema": [
                  {
                    "name": "errors",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "status",
                    "kind": "optional",
                    "type": "string<true when there are no errors | false when there are errors>",
                    "description": "<p>Whether the validation has errors.</p>\n<p>Options are:</p>\n<ul>\n<li>true when there are no errors.</li>\n<li>false when there are errors.</li>\n</ul>",
                    "enum": [
                      "true when there are no errors",
                      "false when there are errors"
                    ]
                  },
                  {
                    "name": "error",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  }
                ]
              }
            ],
            "modelRef": "#/definitions/errorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "500",
        "description": "Error response",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"error\":\"The request could not be processed\",\"validation_response\":{\"errors\":{\"Transaction ID\":\"A unique transaction ID is required (max length = 40)\"},\"status\":false}}",
            "description": "Error response",
            "customType": "errorResponse",
            "schema": [
              {
                "name": "validation_response",
                "kind": "optional",
                "type": "object",
                "description": "",
                "example": "",
                "schema": [
                  {
                    "name": "errors",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "status",
                    "kind": "optional",
                    "type": "string<true when there are no errors | false when there are errors>",
                    "description": "<p>Whether the validation has errors.</p>\n<p>Options are:</p>\n<ul>\n<li>true when there are no errors.</li>\n<li>false when there are errors.</li>\n</ul>",
                    "enum": [
                      "true when there are no errors",
                      "false when there are errors"
                    ]
                  },
                  {
                    "name": "error",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  }
                ]
              }
            ],
            "modelRef": "#/definitions/errorResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url https://rtd01.eu.accertify.net/icNowImport/{settlementimporterID} \\\n     --header 'accept: application/json' \\\n     --header 'content-type: application/json' \\\n     --data '{\n     \"eventSource\": \"\",\n     \"careID\": \"32sfdu8f23234\",\n     \"careRequestAmount\": 1082.91,\n     \"careSettlementAmount\": 1082.91,\n     \"careCurrencyCode\": \"USD\",\n     \"careEventType\": \"\",\n     \"careReason\": \"itemNoLongerWanted\",\n     \"originalTransactionID\": 32432234\n     }'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n   \"eventSource\": \"\",\n   \"careID\": \"32sfdu8f23234\",\n   \"careRequestAmount\": 1082.91,\n   \"careSettlementAmount\": 1082.91,\n   \"careCurrencyCode\": \"USD\",\n   \"careEventType\": \"\",\n   \"careReason\": \"itemNoLongerWanted\",\n   \"originalTransactionID\": 32432234\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"https://rtd01.eu.accertify.net/icNowImport/{settlementimporterID}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://rtd01.eu.accertify.net/icNowImport/{settlementimporterID}\")\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.body = JSON.dump({\n   \"eventSource\": \"\",\n   \"careID\": \"32sfdu8f23234\",\n   \"careRequestAmount\": 1082.91,\n   \"careSettlementAmount\": 1082.91,\n   \"careCurrencyCode\": \"USD\",\n   \"careEventType\": \"\",\n   \"careReason\": \"itemNoLongerWanted\",\n   \"originalTransactionID\": 32432234\n})\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://rtd01.eu.accertify.net/icNowImport/{settlementimporterID}\"\n\npayload = json.dumps({\n   \"eventSource\": \"\",\n   \"careID\": \"32sfdu8f23234\",\n   \"careRequestAmount\": 1082.91,\n   \"careSettlementAmount\": 1082.91,\n   \"careCurrencyCode\": \"USD\",\n   \"careEventType\": \"\",\n   \"careReason\": \"itemNoLongerWanted\",\n   \"originalTransactionID\": 32432234\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// Success response\n{\n  \"transaction-results\": {\n    \"transaction-id\": \"\",\n    \"cross-reference\": \"\",\n    \"remarks\": \"\",\n    \"warnings\": {}\n  }\n}"
        },
        {
          "id": "response-1-400",
          "language": "400",
          "code": "// Error response\n{\n  \"validation_response\": {\n    \"errors\": [\n      \"\"\n    ],\n    \"status\": \"\",\n    \"error\": \"\"\n  }\n}"
        },
        {
          "id": "response-2-500",
          "language": "500",
          "code": "// Error response\n{\n  \"validation_response\": {\n    \"errors\": [\n      \"\"\n    ],\n    \"status\": \"\",\n    \"error\": \"\"\n  }\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}