Chilkat Online Tools

PureBasic / GP-API Collection / TKA_1.0 Get Payment Method

Back to Collection Items

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Adds the "Authorization: Bearer {{token}}" header.
    CkHttp::setCkAuthToken(http, "{{token}}")
    CkHttp::ckSetRequestHeader(http,"X-GP-Version","{{version}}")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://{{url}}/ucp/payment-methods/{{pmt_id}}",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    Debug "Response status code = " + Str(CkHttp::ckLastStatus(http))
    Debug CkStringBuilder::ckGetAsString(sbResponseBody)


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X GET
	-H "Authorization: Bearer {{token}}"
	-H "X-GP-Version: {{version}}"
https://{{url}}/ucp/payment-methods/{{pmt_id}}

Postman Collection Item JSON

{
  "name": "TKA_1.0 Get Payment Method",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "\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"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "type": "text",
        "value": "Bearer {{token}}"
      },
      {
        "key": "X-GP-Version",
        "type": "text",
        "value": "{{version}}"
      }
    ],
    "url": {
      "raw": "https://{{url}}/ucp/payment-methods/{{pmt_id}}",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "payment-methods",
        "{{pmt_id}}"
      ],
      "query": [
        {
          "key": "account_name",
          "value": "{{token_acc_name}}",
          "disabled": true
        },
        {
          "key": "account_name",
          "value": "Reporting",
          "disabled": true
        },
        {
          "key": "from_time_created",
          "value": "2019-04-01",
          "disabled": true
        },
        {
          "key": "system.hierarchy",
          "value": "",
          "disabled": true
        },
        {
          "key": "system.mid",
          "value": "",
          "disabled": true
        },
        {
          "key": "amount",
          "value": "5939",
          "disabled": true
        },
        {
          "key": "status",
          "value": "SPLIT_FUNDING",
          "disabled": true
        }
      ]
    },
    "description": "This request returns a stored card in the global payments system. User must input token they received from tokenization into query string in order to return the stored card. In response, the only card details that will be returned will be the expiry month, year and masked card number.\r\n\r\nFor more info on getting a payment method, visit: https://developer.globalpay.com/api/payment-methods-tokenization#/Read/get_payment_methods__id_"
  },
  "response": [
  ]
}