SQL Server / GP-API Collection / TRA_4.2 Standalone Refund
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- 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"
-- }
-- }
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'merchant_id', '{{mer_id}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'account_id', '{{tra_id}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'channel', 'CP'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'type', 'REFUND'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'amount', '20045'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'currency', 'CAD'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'country', 'CA'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reference', 'My-Refund-1234345345'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payment_method.first_name', 'Jane'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payment_method.last_name', 'Doe'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payment_method.entry_mode', 'MANUAL'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payment_method.card.number', '4242424242424242'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payment_method.card.expiry_month', '12'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payment_method.card.expiry_year', '22'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-GP-Version', '{{version}}'
-- Adds the "Authorization: Bearer {{token}}" header.
EXEC sp_OASetProperty @http, 'AuthToken', '{{token}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'idempotency', '12345'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://{{url}}/ucp/transactions', 'application/json', @json
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
RETURN
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
END
GO
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": [
]
}
