Chilkat Online Tools

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

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp

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

loHttp = CreateObject('Chilkat.Http')

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

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

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

loResp = CreateObject('Chilkat.HttpResponse')
lnSuccess = loHttp.HttpJson("POST","https://{{url}}/ucp/transactions",loJson,"application/json",loResp)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loResp
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr

RELEASE loHttp
RELEASE loJson
RELEASE loResp

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