Chilkat Online Tools

PureBasic / PaymentsOS Testing with Mock Provider / 5. GET Void

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

    CkHttp::ckSetRequestHeader(http,"x-payments-os-env","{{x-payments-os-env}}")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    CkHttp::ckSetRequestHeader(http,"app_id","{{app_id}}")
    CkHttp::ckSetRequestHeader(http,"private_key","{{private_key}}")
    CkHttp::ckSetRequestHeader(http,"idempotency_key","{{$randomInt}}")
    CkHttp::ckSetRequestHeader(http,"api-version","1.3.0")

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

    success = CkHttp::ckQuickGetSb(http,"https://api.paymentsos.com/payments/{{paymentid}}/voids/{{voidid}}",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 "app_id: {{app_id}}"
	-H "private_key: {{private_key}}"
	-H "Content-Type: application/json"
	-H "api-version: 1.3.0"
	-H "x-payments-os-env: {{x-payments-os-env}}"
	-H "idempotency_key: {{$randomInt}}"
https://api.paymentsos.com/payments/{{paymentid}}/voids/{{voidid}}

Postman Collection Item JSON

{
  "name": "5. GET Void",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "var jsonData = JSON.parse(responseBody);",
          "postman.setEnvironmentVariable(\"authorizationid\", jsonData.id);"
        ]
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "app_id",
        "value": "{{app_id}}"
      },
      {
        "key": "private_key",
        "value": "{{private_key}}"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "api-version",
        "value": "1.3.0"
      },
      {
        "key": "x-payments-os-env",
        "value": "{{x-payments-os-env}}"
      },
      {
        "key": "idempotency_key",
        "value": "{{$randomInt}}"
      }
    ],
    "url": {
      "raw": "https://api.paymentsos.com/payments/{{paymentid}}/voids/{{voidid}}",
      "protocol": "https",
      "host": [
        "api",
        "paymentsos",
        "com"
      ],
      "path": [
        "payments",
        "{{paymentid}}",
        "voids",
        "{{voidid}}"
      ]
    },
    "description": "Create a new authorization"
  },
  "response": [
  ]
}