Chilkat Online Tools

Xojo / GP-API Collection / TRA_4.2 Standalone Refund

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 Chilkat.Http
Dim success As Boolean

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

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

// {
//   "merchant_id": "{{mer_id}}",
//   "account_id": "{{tra_id}}",
//   "channel": "CP",
//   "type": "REFUND",
//   "amount": "20045",
//   "currency": "CAD",
//   "country": "CA",
//   "reference": "My-Refund-1234345345",
//   "payment_method": {
//     "first_name": "Jane",
//     "last_name": "Doe",
//     "entry_mode": "MANUAL",
//     "card": {
//       "number": "4242424242424242",
//       "expiry_month": "12",
//       "expiry_year": "22"
//     }
//   }
// }

Dim json As New Chilkat.JsonObject
success = json.UpdateString("merchant_id","{{mer_id}}")
success = json.UpdateString("account_id","{{tra_id}}")
success = json.UpdateString("channel","CP")
success = json.UpdateString("type","REFUND")
success = json.UpdateString("amount","20045")
success = json.UpdateString("currency","CAD")
success = json.UpdateString("country","CA")
success = json.UpdateString("reference","My-Refund-1234345345")
success = json.UpdateString("payment_method.first_name","Jane")
success = json.UpdateString("payment_method.last_name","Doe")
success = json.UpdateString("payment_method.entry_mode","MANUAL")
success = json.UpdateString("payment_method.card.number","4242424242424242")
success = json.UpdateString("payment_method.card.expiry_month","12")
success = json.UpdateString("payment_method.card.expiry_year","22")

http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "X-GP-Version","{{version}}"
// Adds the "Authorization: Bearer {{token}}" header.
http.AuthToken = "{{token}}"
http.SetRequestHeader "idempotency","12345"
http.SetRequestHeader "Accept","application/json"

Dim resp As Chilkat.HttpResponse
resp = http.PostJson3("https://{{url}}/ucp/transactions","application/json",json)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

System.DebugLog(Str(resp.StatusCode))
System.DebugLog(resp.BodyStr)

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Authorization: Bearer {{token}}"
	-H "Accept: application/json"
	-H "X-GP-Version: {{version}}"
	-H "idempotency: 12345"
	-d '{
    "merchant_id":"{{mer_id}}",
    "account_id": "{{tra_id}}",
    "channel": "CP",
    "type": "REFUND",
    "amount": "20045",
    "currency": "CAD",
    "country": "CA",
    "reference": "My-Refund-1234345345",
    "payment_method": {
        "first_name": "Jane",
        "last_name": "Doe",
        "entry_mode": "MANUAL",
        "card": {
        
            "number": "4242424242424242",
            "expiry_month": "12",
            "expiry_year": "22"
            
        }
    }
}'
https://{{url}}/ucp/transactions

Postman Collection Item JSON

{
  "name": "TRA_4.2 Standalone 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(\"stdaloneref_trn_id\", jsonData.id);\r",
          "postman.setEnvironmentVariable(\"reference\", jsonData.reference);\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",
        "type": "text",
        "value": "{{version}}"
      },
      {
        "key": "idempotency",
        "value": "12345",
        "type": "text",
        "disabled": true
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"merchant_id\":\"{{mer_id}}\",\n    \"account_id\": \"{{tra_id}}\",\n    \"channel\": \"CP\",\n    \"type\": \"REFUND\",\n    \"amount\": \"20045\",\n    \"currency\": \"CAD\",\n    \"country\": \"CA\",\n    \"reference\": \"My-Refund-1234345345\",\n    \"payment_method\": {\n        \"first_name\": \"Jane\",\n        \"last_name\": \"Doe\",\n        \"entry_mode\": \"MANUAL\",\n        \"card\": {\n        \n            \"number\": \"4242424242424242\",\n            \"expiry_month\": \"12\",\n            \"expiry_year\": \"22\"\n            \n        }\n    }\n}\n"
    },
    "url": {
      "raw": "https://{{url}}/ucp/transactions",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "transactions"
      ]
    },
    "description": "This request refunds funds to a different card that is not associated with original sale transaction. As you can see in the body of request, card details for Jane Doe have been manually entered in order to send request back to this specific card."
  },
  "response": [
  ]
}