Chilkat Online Tools

Ruby / Commercetools / Create Payment

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

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

# The following JSON is sent in the request body.

# {
#   "key": "123456",
#   "interfaceId": "789011",
#   "amountPlanned": {
#     "currencyCode": "USD",
#     "centAmount": 1000
#   },
#   "paymentMethodInfo": {
#     "paymentInterface": "STRIPE",
#     "method": "CREDIT_CARD",
#     "name": {
#       "en": "Credit Card"
#     }
#   },
#   "transactions": [
#     {
#       "timestamp": "2015-10-20T08:54:24.000Z",
#       "type": "Charge",
#       "amount": {
#         "currencyCode": "USD",
#         "centAmount": 1000
#       },
#       "state": "Pending"
#     }
#   ]
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("key","123456")
json.UpdateString("interfaceId","789011")
json.UpdateString("amountPlanned.currencyCode","USD")
json.UpdateInt("amountPlanned.centAmount",1000)
json.UpdateString("paymentMethodInfo.paymentInterface","STRIPE")
json.UpdateString("paymentMethodInfo.method","CREDIT_CARD")
json.UpdateString("paymentMethodInfo.name.en","Credit Card")
json.UpdateString("transactions[0].timestamp","2015-10-20T08:54:24.000Z")
json.UpdateString("transactions[0].type","Charge")
json.UpdateString("transactions[0].amount.currencyCode","USD")
json.UpdateInt("transactions[0].amount.centAmount",1000)
json.UpdateString("transactions[0].state","Pending")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("post","https://domain.com/{{project-key}}/payments",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "key" : "123456",
  "interfaceId" : "789011",
  "amountPlanned" : {
    "currencyCode" : "USD",
    "centAmount" : 1000
  },
  "paymentMethodInfo" : {
    "paymentInterface" : "STRIPE",
    "method" : "CREDIT_CARD",
    "name" : {
      "en" : "Credit Card"
    }
  },
  "transactions" : [ {
    "timestamp" : "2015-10-20T08:54:24.000Z",
    "type" : "Charge",
    "amount" : {
      "currencyCode" : "USD",
      "centAmount" : 1000
    },
    "state" : "Pending"
  } ]
}'
https://domain.com/{{project-key}}/payments

Postman Collection Item JSON

{
  "name": "Create Payment",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "tests[\"Status code \" + responseCode.code] = responseCode.code === 200 || responseCode.code === 201;",
          "var data = JSON.parse(responseBody);",
          "if(data.results && data.results[0] && data.results[0].id && data.results[0].version){",
          "    pm.environment.set(\"payment-id\", data.results[0].id); ",
          "    pm.environment.set(\"payment-version\", data.results[0].version);",
          "}",
          "if(data.results && data.results[0] && data.results[0].key){",
          "    pm.environment.set(\"payment-key\", data.results[0].key); ",
          "}",
          "if(data.version){",
          "    pm.environment.set(\"payment-version\", data.version);",
          "}",
          "if(data.id){",
          "    pm.environment.set(\"payment-id\", data.id); ",
          "}",
          "if(data.key){",
          "    pm.environment.set(\"payment-key\", data.key);",
          "}",
          ""
        ]
      }
    }
  ],
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": {
        "accessToken": "{{ctp_access_token}}",
        "addTokenTo": "header",
        "tokenType": "Bearer"
      }
    },
    "method": "post",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/payments",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "payments"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "To create a payment object a payment draft object has to be given with the request.",
    "body": {
      "mode": "raw",
      "raw": "{\n  \"key\" : \"123456\",\n  \"interfaceId\" : \"789011\",\n  \"amountPlanned\" : {\n    \"currencyCode\" : \"USD\",\n    \"centAmount\" : 1000\n  },\n  \"paymentMethodInfo\" : {\n    \"paymentInterface\" : \"STRIPE\",\n    \"method\" : \"CREDIT_CARD\",\n    \"name\" : {\n      \"en\" : \"Credit Card\"\n    }\n  },\n  \"transactions\" : [ {\n    \"timestamp\" : \"2015-10-20T08:54:24.000Z\",\n    \"type\" : \"Charge\",\n    \"amount\" : {\n      \"currencyCode\" : \"USD\",\n      \"centAmount\" : 1000\n    },\n    \"state\" : \"Pending\"\n  } ]\n}"
    }
  },
  "response": [
  ]
}