Chilkat Online Tools

Swift / GP-API Collection / TRA_11.2 ACH Refund

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "account_name": "{{acc_name}}",
    //   "channel": "CNP",
    //   "type": "REFUND",
    //   "amount": "12345",
    //   "currency": "USD",
    //   "reference": "{{reference}}",
    //   "country": "US",
    //   "payment_method": {
    //     "name": "ANGELA SMITH",
    //     "entry_mode": "ECOM",
    //     "bank_transfer": {
    //       "number": "1234567890",
    //       "number_type": "SAVING",
    //       "check_reference": "123",
    //       "sec_code": "WEB",
    //       "merchant_notes": "123",
    //       "bank": {
    //         "code": "083908420",
    //         "name": "First Union",
    //         "address": {
    //           "line_1": "12000 Smoketown Rd",
    //           "line_2": "Apt 3B",
    //           "line_3": "X",
    //           "city": "Mesa",
    //           "state": "AZ",
    //           "postal_code": "22192",
    //           "country": "USA"
    //         }
    //       }
    //     }
    //   },
    //   "payer": {
    //     "name": "ANGELA SMITH",
    //     "reference": "123",
    //     "date_of_birth": "1967-08-13",
    //     "landline_phone": "235555",
    //     "mobile_phone": "222222",
    //     "billing_address": {
    //       "line_1": "Address Line 1",
    //       "line_2": "Address Line 2",
    //       "city": "PUNE",
    //       "state": "AZ",
    //       "postal_code": "411015",
    //       "country": "USA"
    //     }
    //   }
    // }

    let json = CkoJsonObject()
    json.UpdateString("account_name", value: "{{acc_name}}")
    json.UpdateString("channel", value: "CNP")
    json.UpdateString("type", value: "REFUND")
    json.UpdateString("amount", value: "12345")
    json.UpdateString("currency", value: "USD")
    json.UpdateString("reference", value: "{{reference}}")
    json.UpdateString("country", value: "US")
    json.UpdateString("payment_method.name", value: "ANGELA SMITH")
    json.UpdateString("payment_method.entry_mode", value: "ECOM")
    json.UpdateString("payment_method.bank_transfer.number", value: "1234567890")
    json.UpdateString("payment_method.bank_transfer.number_type", value: "SAVING")
    json.UpdateString("payment_method.bank_transfer.check_reference", value: "123")
    json.UpdateString("payment_method.bank_transfer.sec_code", value: "WEB")
    json.UpdateString("payment_method.bank_transfer.merchant_notes", value: "123")
    json.UpdateString("payment_method.bank_transfer.bank.code", value: "083908420")
    json.UpdateString("payment_method.bank_transfer.bank.name", value: "First Union")
    json.UpdateString("payment_method.bank_transfer.bank.address.line_1", value: "12000 Smoketown Rd")
    json.UpdateString("payment_method.bank_transfer.bank.address.line_2", value: "Apt 3B")
    json.UpdateString("payment_method.bank_transfer.bank.address.line_3", value: "X")
    json.UpdateString("payment_method.bank_transfer.bank.address.city", value: "Mesa")
    json.UpdateString("payment_method.bank_transfer.bank.address.state", value: "AZ")
    json.UpdateString("payment_method.bank_transfer.bank.address.postal_code", value: "22192")
    json.UpdateString("payment_method.bank_transfer.bank.address.country", value: "USA")
    json.UpdateString("payer.name", value: "ANGELA SMITH")
    json.UpdateString("payer.reference", value: "123")
    json.UpdateString("payer.date_of_birth", value: "1967-08-13")
    json.UpdateString("payer.landline_phone", value: "235555")
    json.UpdateString("payer.mobile_phone", value: "222222")
    json.UpdateString("payer.billing_address.line_1", value: "Address Line 1")
    json.UpdateString("payer.billing_address.line_2", value: "Address Line 2")
    json.UpdateString("payer.billing_address.city", value: "PUNE")
    json.UpdateString("payer.billing_address.state", value: "AZ")
    json.UpdateString("payer.billing_address.postal_code", value: "411015")
    json.UpdateString("payer.billing_address.country", value: "USA")

    http.SetRequestHeader("Content-Type", value: "application/json")
    http.SetRequestHeader("X-GP-Idempotency", value: "12348")
    http.SetRequestHeader("X-GP-Version", value: "{{version}}")
    // Adds the "Authorization: Bearer {{token}}" header.
    http.AuthToken = "{{token}}"
    http.SetRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.PostJson3("https://{{url}}/ucp/transactions", contentType: "application/json", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    print("\(resp!.StatusCode.intValue)")
    print("\(resp!.BodyStr)")
    resp = nil

}

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Authorization: Bearer {{token}}"
	-H "Accept: application/json"
	-H "X-GP-Version: {{version}}"
	-H "X-GP-Idempotency: 12348"
	-d '{
    "account_name": "{{acc_name}}",
    "channel": "CNP",
    "type": "REFUND",
    "amount": "12345",
    "currency": "USD",
    "reference": "{{reference}}",
    "country": "US",
    "payment_method": {
        "name": "ANGELA SMITH",
        "entry_mode": "ECOM",
        "bank_transfer": {
            "number": "1234567890",
            "number_type": "SAVING",
            "check_reference": "123",
            "sec_code": "WEB",
            "merchant_notes": "123",
            "bank": {
                "code": "083908420",
                "name": "First Union",
                "address": {
                    "line_1": "12000 Smoketown Rd",
                    "line_2": "Apt 3B",
                    "line_3": "X",
                    "city": "Mesa",
                    "state": "AZ",
                    "postal_code": "22192",
                    "country": "USA"
                }
            }
        }
    },
    "payer": {
        "name": "ANGELA SMITH",
        "reference": "123",
        "date_of_birth": "1967-08-13",
        "landline_phone": "235555",
        "mobile_phone": "222222",
        "billing_address": {
            "line_1": "Address Line 1",
            "line_2": "Address Line 2",
            "city": "PUNE",
            "state": "AZ",
            "postal_code": "411015",
            "country": "USA"
        }
    }
}'
https://{{url}}/ucp/transactions

Postman Collection Item JSON

{
  "name": "TRA_11.2 ACH Refund",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "pm.environment.unset(\"trn_id\");\r",
          "\r",
          "var jsonData = JSON.parse(responseBody);\r",
          "postman.setEnvironmentVariable(\"trn_id\", jsonData.id);\r",
          "postman.setEnvironmentVariable(\"reference\", jsonData.reference);\r",
          "postman.setEnvironmentVariable(\"batch_id\", jsonData.batch_id);\r",
          "postman.setEnvironmentVariable(\"act_id\", jsonData.action.id);\r",
          "\r",
          "tests[\"Transaction ID \" + pm.environment.get(\"trn_id\")] = true;\r",
          "\r",
          "tests[\"Response time is acceptable\"] = _.inRange(responseTime, 100, 1500); \r",
          "\r",
          "\r",
          "pm.test(\"Successful POST request\", function () {\r",
          "    pm.expect(pm.response.code).to.be.oneOf([200,201,202]);\r",
          "});\r",
          "\r",
          "pm.test(\"Status code name has string\", function () {\r",
          "    pm.response.to.have.status(\"OK\");\r",
          "});"
        ],
        "type": "text/javascript"
      }
    },
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          "var str = String(\"00000000\"+ Math.floor(Math.random()*100000000) + 1).slice(-8);",
          "",
          "pm.environment.set(\"reference\",str);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{token}}"
      },
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "X-GP-Version",
        "value": "{{version}}",
        "type": "text"
      },
      {
        "key": "X-GP-Idempotency",
        "value": "12348",
        "type": "text",
        "disabled": true
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"account_name\": \"{{acc_name}}\",\n    \"channel\": \"CNP\",\n    \"type\": \"REFUND\",\n    \"amount\": \"12345\",\n    \"currency\": \"USD\",\n    \"reference\": \"{{reference}}\",\n    \"country\": \"US\",\n    \"payment_method\": {\n        \"name\": \"ANGELA SMITH\",\n        \"entry_mode\": \"ECOM\",\n        \"bank_transfer\": {\n            \"number\": \"1234567890\",\n            \"number_type\": \"SAVING\",\n            \"check_reference\": \"123\",\n            \"sec_code\": \"WEB\",\n            \"merchant_notes\": \"123\",\n            \"bank\": {\n                \"code\": \"083908420\",\n                \"name\": \"First Union\",\n                \"address\": {\n                    \"line_1\": \"12000 Smoketown Rd\",\n                    \"line_2\": \"Apt 3B\",\n                    \"line_3\": \"X\",\n                    \"city\": \"Mesa\",\n                    \"state\": \"AZ\",\n                    \"postal_code\": \"22192\",\n                    \"country\": \"USA\"\n                }\n            }\n        }\n    },\n    \"payer\": {\n        \"name\": \"ANGELA SMITH\",\n        \"reference\": \"123\",\n        \"date_of_birth\": \"1967-08-13\",\n        \"landline_phone\": \"235555\",\n        \"mobile_phone\": \"222222\",\n        \"billing_address\": {\n            \"line_1\": \"Address Line 1\",\n            \"line_2\": \"Address Line 2\",\n            \"city\": \"PUNE\",\n            \"state\": \"AZ\",\n            \"postal_code\": \"411015\",\n            \"country\": \"USA\"\n        }\n    }\n}\n"
    },
    "url": {
      "raw": "https://{{url}}/ucp/transactions",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "transactions"
      ]
    }
  },
  "response": [
  ]
}