GoodFunds Gateway - RESTful API Documentation

Connections

Connections provides the ability to check against the Secure Vault System API Credentials to ensure valid responses. Also can provide the ability to store system information or product versions.

POST connection

Test software connection.

    Resource Information

  • Method: POST
  • URL: https://demo.goodfundsgateway.com/demoapi/connection.json
  • Requires authentication? Yes

Method Parameters

N/A

Query Parameters

Parameter Type Required Description
software_info node N Software Info Node: This is your current software information
version string N Current Version to track version control in your software with ours.
external_software node N External Software Info Node: Any external software that is being used with your software. (Example: QuickBooks, Google Apps, etc...)
product string N Software, Product Name, or App name that is being used.
desktop_info node N Desktop Information Node: This is helpful when needing to track your clients current computer / server OS
osversion string N Clients current OS Version. (Example: Microsoft Windows NT 6.1.7601 Service Pack 1)

PHP Example CC Request: (json format)

      $data = array(
        'software_info'  => array(
          'version'   => '3.1.10.0'
        ),
        'external_software' =>  array(
          'product'   =>  'QuickBooks Pro 2016'
        ),
        'desktop_info'  =>  array(
          'osversion'   =>  'Microsoft Windows NT 6.1.7601 Service Pack 1'
        )
      );

      $data_string = json_encode($data);

      $ch = curl_init('https://demo.goodfundsgateway.com/demoapi/connection.json/software');
      curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
      curl_setopt($ch, CURLOPT_SSLVERSION, 6);
      curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string);
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
      curl_setopt($ch, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: ' . strlen($data_string),
          'svs-api-id: [SVS API ID]',
          'svs-api-key: [SVS API KEY]')
      );                       
                                                                                                                           
      $result = curl_exec($ch);
      $err = curl_error($ch);

      curl_close($ch);

      if ($err) {
        echo "cURL Error #:" . $err;
      } else {
        echo $result;
      }
    

Response data: (json format)

      {
        "status":"success",
        "successMessage":
        {
          "response_code":203,
          "message":
            {
              "account":
              {
                "CreditCardGateway":
                {
                  "gateway_id":"[Gateway ID]",
                  "alias":"Converge Credit Card",
                  "allows_refunds":1,
                  "allows_level3":1
                },
                "ECheckGateway":
                {
                  "gateway_id":"[Gateway ID]",
                  "alias":"Converge ACH",
                  "allows_refunds":0,
                  "allows_level3":1
                },
                "parent_client_id":"[Your Client ID]"
                }
              }
        }
      }