Charges

Charges are individual transactions made by either a credit card or electronic check. Charges will be linked to either recurring charges and/or customers.

Charges are processed immediately via the gateway account specified by the gateway_id in the request or by the default gateway account associated with the API client. Their are two default gateway accounts for processing that can be tied to a API client, which is their default credit card processing gateway account and/or their default echeck processing gateway account.

Charges can be created and records of the charges can be retrieved. However, charges cannot be updated and/or deleted because the records serve as receipts for the transactions made via external payment gateways.

GET charges

List all charges of a specific users transactions.

Resource Information

• Method: GET
• URL: https://demo.goodfundsgateway.com/api/charges.json
• Requires authentication? Yes

Method Parameters

N/A

Query Parameters

PHP Example Request:

      $data = array(
        'internal_id' =>  '123456',
        'filter' => array(
          'limit' =>  5
        )
      );

      if(isset($data))
      {
        $url = 'https://demo.goodfundsgateway.com/api/charges.json?' . http_build_query($data);
      }
      else
      {
        $url = 'https://demo.goodfundsgateway.com/api/charges.json';
      }

      $ch = curl_init($url);
      curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
      curl_setopt($ch, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          '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": 706,
          "message": {
            "charges": [
              {
                "id": "[Client ID]",
                "user_id": "[User ID]",
                "gateway_id": "[Gateway Account ID]",
                "date": "[Transaction Timestamp]",
                "amount": "[Amount]",
                "account_holder_fullname": "[Fullname Printed on Check]",
                "echeck_last_four": "[Bank Account Last Four]",
                "customer_id": "[Customer ID]",
                "internal_id": "[Internal ID]",
                "billing": {
                  "first_name": "[Billing First Name]",
                  "last_name": "[Billing Last Name]",
                  "company": "[Billing Company Name]",
                  "address_1": "[Billing Street Address]",
                  "address_2": "[Billing Address Line 2]",
                  "city": "[Billing City]",
                  "state": "[Billing State]",
                  "country": "[Billing Country]",
                  "postal_code": "[Billing Postal Code]",
                  "email": "[Billing Email]",
                  "phone": "[Billing Phone]"
                },
                "internal_name": [Internal Name],
                "status": "[Status]",
                "refunded": "[Refunded]",
                "type": "[Transaction Type]",
                "authorization": {
                  "auth_id": "[Authorization ID]",
                  "charge_id": "[Charge ID]",
                  "tran_id": "[Transaction ID]",
                  "auth_code": "[Transaction Authorization Code]",
                  "raw_data": {
                    [Full Transaction Response Array]
                  }
                }
              },
              {
                "id": "[Client ID]",
                "user_id": "[User ID]",
                "gateway_id": "[Gateway Account ID]",
                "date": "[Transaction Timestamp]",
                "amount": "[Amount]",
                "card_holder_fullname": "[Card Holder Fullname]",
                "card_type": "[Credit Card Brand]",
                "card_last_four": "[Credit Card Last Four]",
                "customer_id": "[Customer ID]",
                "internal_id": "[Internal ID]",
                "billing": {
                  "first_name": "[Billing First Name]",
                  "last_name": "[Billing Last Name]",
                  "company": "[Billing Company Name]",
                  "address_1": "[Billing Street Address]",
                  "address_2": "[Billing Address Line 2]",
                  "city": "[Billing City]",
                  "state": "[Billing State]",
                  "country": "[Billing Country]",
                  "postal_code": "[Billing Postal Code]",
                  "email": "[Billing Email]",
                  "phone": "[Billing Phone]"
                },
                "internal_name": [Internal Name],
                "status": "[Status]",
                "refunded": "[Refunded]",
                "type": "[Transaction Type]",
                "authorization": {
                  "auth_id": "[Authorization ID]",
                  "charge_id": "[Charge ID]",
                  "tran_id": "[Transaction ID]",
                  "auth_code": "[Transaction Authorization Code]",
                  "raw_data": {
                    [Full Transaction Response Array]
                  }
                }
              }
            ]
          }
        }
      }
    

POST charge

Charge a credit card.

Resource Information

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

Method Parameters

N/A

Query Parameters

PHP Example Request: (json format)

      $data = array(
          'charge_type' =>  'ccauthcapture',
          'gateway_id'   =>  '[Gateway ID]',
          'customer'    =>  array(
            'internal_id'   =>  '1375894109',
            'first_name'    =>  'John',
            'last_name'     =>  'Doe',
            'company'       =>  'John Doe\'s Bakery',
            'address_1'     =>  '321 Way St.',
            'address_2'     =>  'Suite 400',
            'city'          =>  'San Diego',
            'state'         =>  'CA',
            'postal_code'   =>  '92020',
            'country'       =>  'US',
            'phone'         =>  '619-444-5555',
            'email'         =>  'example@domain.com'
          ),
          'billto'  =>  array(
            'first_name'      =>  'John',
            'last_name'       =>  'Doe',
            'company'         =>  'John Doe\'s Bakery',
            'address_1'       =>  '321 Way St.',
            'address_2'       =>  'Suite 400',
            'city'            =>  'San Diego',
            'state'           =>  'CA',
            'postal_code'     =>  '92020',
            'country'         =>  'US',
            'phone'           =>  '619-444-5555',
            'email'           =>  'example@domain.com'
          ),
          'shipto'  =>  array(
            'first_name'    =>  'John',
            'last_name'     =>  'Doe',
            'company'       =>  'John Doe\'s Bakery',
            'address_1'     =>  '321 Way St.',
            'address_2'     =>  'Suite 400',
            'city'          =>  'San Diego',
            'state'         =>  'CA',
            'postal_code'   =>  '92020',
            'country'       =>  'US',
            'phone'         =>  '619-444-5555',
            'email'         =>  'example@domain.com'
          ),
          'level2'  =>  array(
            'invoice_number'  =>  '1090',
            'salestax'        =>  '0.00',
            'customer_code'   =>  '1111',
            'po_number'       =>  '3523'
          ),
          'level3'  =>  array(
            'ship_from_postal_code'   =>  '92106',
            'destination_postal_code' =>  '92020'
          ),
          'creditcard'  =>  array(
            'creditcard_name'       =>  'John Doe',
            'creditcard_number'     =>  '4111111111111111',
            'creditcard_type'       =>  'VISA',
            'creditcard_exp_month'  =>  '05',
            'creditcard_exp_year'   =>  '2018',
            'creditcard_cvv'        =>  '222'
          ),
          'amount'  =>  '1.00'
        );

        $data_string = json_encode($data);

        $ch = curl_init('https://demo.goodfundsgateway.com/api/charge.json');                                                                      
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");                                                                     
        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: UPB0W66B96PCIXU45PRI',
            'svs-api-key: 192QP4J8K4LI5M58P4VDCQN5I2GECDEEHMYPXQKJ')                                                                       
        );                       
                                                                                                                             
        $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": 1,
          "message": {
            "charge": {
              "success": true,
              "charge_id": [Charge ID],
              "trans_id": "[Transaction ID]",
              "approval_code": "[Transaction Authorization Code]",
              "card_number": "[Masked Card Number Used]",
              "raw_data": {
                [Transaction Response Array]
              },
              "amount": "[Amount Processed]"
            }
          }
        }
      }
    

POST charge

Charge a credit card with a specific Payment Method.

Resource Information

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

Method Parameters

N/A

Query Parameters

PHP Example Request: (json format)

      $data = array(
          'charge_type'       =>  'ccauthcapture',
          'gateway_id'         =>  '[Gateway ID]',
          'payment_method_id' =>  '[Payment Method ID]',
          'level2'  =>  array( // Level 2 data to be sent to processor
            'invoice_number'  =>  '1090',
            'salestax'        =>  '0.00',
            'customer_code'   =>  '1111',
            'po_number'       =>  '3523'
          ),
          'creditcard'  =>  array( // Credit Card information
            'cvv'               =>  '222'
          ),
          'amount'  =>  '1.00' // Total amount to charge
        );

        $data_string = json_encode($data);

        $ch = curl_init('https://demo.goodfundsgateway.com/api/charge.json');
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
        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": 1,
          "message": {
            "charge": {
              "success": true,
              "charge_id": [Charge ID],
              "trans_id": "[Transaction ID]",
              "approval_code": "[Transaction Authorization Code]",
              "card_number": "[Masked Card Number Used]",
              "raw_data": {
                [Transaction Response Array]
              },
              "amount": "[Amount Processed]"
            }
          }
        }
      }
    

POST charge

Charge a electronic check.

Resource Information

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

Method Parameters

N/A

Query Parameters

JSON Format Example

      {
        "charge_type":"ecdebit",
        "gateway_id":"[Gateway ID]",
        "customer":
        {
          "internal_id":"174",
          "first_name":"John",
          "last_name":"Doe",
          "company":"John Doe's Bakery",
          "address_1":"321 Way St.",
          "address_2":"Suite 400",
          "city":"San Diego",
          "state":"CA",
          "postal_code":"92020",
          "country":"US",
          "phone":"619-444-5555",
          "email":"demo@gmail.com"
        },
        "billto":
        {
          "first_name":"John",
          "last_name":"Doe",
          "company":"John Doe's Bakery",
          "address_1":"321 Way St.",
          "address_2":"Suite 400",
          "city":"San Diego",
          "state":"CA",
          "postal_code":"92020",
          "country":"US",
          "phone":"619-444-5555",
          "email":"demo@gmail.com"
        },
        "shipto":
        {
          "first_name":"John",
          "last_name":"Doe",
          "company":"John Doe's Bakery",
          "address_1":"321 Way St.",
          "address_2":"Suite 400",
          "city":"San Diego",
          "state":"CA",
          "postal_code":"92020",
          "country":"US",
          "phone":"619-444-5555",
          "email":"demo@gmail.com"
        },
        "level2":
        {
          "invoice_number":"1090",
          "salestax":"0.00",
          "po_number":"3523",
          "customer_code":"1111"
        },
        "echeck":
        {
          "echeck_name":"John Doe",
          "echeck_account_number":"9900000003",
          "echeck_routing_number":"321174851",
          "echeck_check_number":"2020",
          "echeck_account_type":"1",
          "echeck_holder_type":"0",
          "echeck_seccode":"PPD",
          "echeck_agree":"1"
        },
        "amount":"1.00"
      }
    

PHP Example Request: (json format)

      $data = array(
          'charge_type' =>  'ecdebit', //eccredit for credit transactions
          'gateway_id'   =>  '[Gateway ID]',
          'customer'    =>  array( // Customer Job From QB's
            'internal_id'   =>  '1375894109',
            'first_name'    =>  'John',
            'last_name'     =>  'Doe',
            'company'       =>  'John Doe\'s Bakery',
            'address_1'     =>  '321 Way St.',
            'address_2'     =>  'Suite 400',
            'city'          =>  'San Diego',
            'state'         =>  'CA',
            'postal_code'   =>  '92020',
            'country'       =>  'US',
            'phone'         =>  '619-444-5555',
            'email'         =>  'example@domain.com'
          ),
          'billto'  =>  array( // AVS billing information
            'first_name'      =>  'John',
            'last_name'       =>  'Doe',
            'company'         =>  'John Doe\'s Bakery',
            'address_1'       =>  '321 Way St.',
            'address_2'       =>  'Suite 400',
            'city'            =>  'San Diego',
            'state'           =>  'CA',
            'postal_code'     =>  '92020',
            'country'         =>  'US',
            'phone'           =>  '619-444-5555',
            'email'           =>  'example@domain.com'
          ),
          'shipto'  =>  array( // Shipping information
            'first_name'    =>  'John',
            'last_name'     =>  'Doe',
            'company'       =>  'John Doe\'s Bakery',
            'address_1'     =>  '321 Way St.',
            'address_2'     =>  'Suite 400',
            'city'          =>  'San Diego',
            'state'         =>  'CA',
            'postal_code'   =>  '92020',
            'country'       =>  'US',
            'phone'         =>  '619-444-5555',
            'email'         =>  'example@domain.com'
          ),
          'level2'  =>  array( // Level 2 data to be sent to processor
            'invoice_number'  =>  '1090',
            'salestax'        =>  '0.00',
            'customer_code'   =>  '1111',
            'po_number'       =>  '3523'
          ),
          'level3'  =>  array( // Level 3 data to be sent to processor
            'ship_from_postal_code'   =>  '92106',
            'destination_postal_code' =>  '92020'
          ),
          'echeck'  =>  array( // ECheck information
            'echeck_name'           =>  'John Doe',
            'echeck_account_number' =>  '9900000003',
            'echeck_routing_number' =>  '321174851',
            'echeck_check_number'   =>  '2020',
            'echeck_account_type'   =>  '1',
            'echeck_holder_type'    =>  '0',
            'echeck_seccode'        =>  'PPD',
            'echeck_agree'          =>  '1'
          ),
          'amount'  =>  '1.00' // Total amount to charge
        );

        $data_string = json_encode($data);

        $ch = curl_init('https://demo.goodfundsgateway.com/api/charge.json');
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
        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": 1,
          "message": {
            "charge": {
              "success": true,
              "charge_id": [Charge ID],
              "trans_id": "[Transaction ID]",
              "approval_code": "NACREN",
              "bank_account_number": "[Masked Bank Account Number Used]",
              "raw_data": {
                [Transaction Response Array]
              }
            }
          }
        }
      }
    

POST charge

Charge a electronic check with a specific Payment Method.

Resource Information

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

Method Parameters

N/A

Query Parameters

PHP Example Request: (json format)

      $data = array(
          'charge_type' =>  'ecdebit',
          'gateway_id'   =>  '[Gateway ID]',
          'payment_method_id' =>  '[Payment Method ID]',
          'level2'  =>  array( // Level 2 data to be sent to processor
            'invoice_number'  =>  '1090',
            'salestax'        =>  '0.00',
            'customer_code'   =>  '1111',
            'po_number'       =>  '3523'
          ),
          'echeck'  =>  array( // ECheck information
            'echeck_check_number'   =>  '2020',
            'echeck_seccode'        =>  'PPD',
            'echeck_agree'          =>  '1'
          ),
          'amount'  =>  '1.00' // Total amount to charge
        );

        $data_string = json_encode($data);

        $ch = curl_init('https://demo.goodfundsgateway.com/api/charge.json');
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
        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": 1,
          "message": {
            "charge": {
              "success": true,
              "charge_id": [Charge ID],
              "trans_id": "[Transaction ID]",
              "approval_code": "NACREN",
              "bank_account_number": "[Masked Bank Account Used]",
              "raw_data": {
                [Transaction Full Response Array]
              }
            }
          }
        }
      }
    

GET charge/{chargeId}

Get details of a specific charge by ID.

Resource Information

• Method: GET
• URL: https://demo.goodfundsgateway.com/api/charge.json/{chargeId}
• Requires authentication? Yes

Method Parameters

Query Parameters

N/A

PHP Example Request:

        $data = '25';

        $url = 'https://demo.goodfundsgateway.com/api/charge.json/' . $data;

        $ch = curl_init($url);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HTTPHEADER, array(
            'Content-Type: application/json',
            '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: Credit Card Payment Method (json format)

        {
          "status": "success",
          "successMessage": {
            "response_code": 707,
            "message": {
              "charge": {
                "id": "[Client ID]",
                "user_id": "[User ID]",
                "gateway_id": "[Gateway Account ID]",
                "date": "[Transaction Timestamp]",
                "amount": "[Amount]",
                "card_holder_fullname": "[Card Holder Fullname]",
                "card_type": "[Credit Card Brand]",
                "card_last_four": "[Credit Card Last Four]",
                "customer_id": "[Customer ID]",
                "internal_id": "[Internal ID]",
                "billing": {
                  "first_name": "[Billing First Name]",
                  "last_name": "[Billing Last Name]",
                  "company": "[Billing Company Name]",
                  "address_1": "[Billing Street Address]",
                  "address_2": "[Billing Address Line 2]",
                  "city": "[Billing City]",
                  "state": "[Billing State]",
                  "country": "[Billing Country]",
                  "postal_code": "[Billing Postal Code]",
                  "email": "[Billing Email]",
                  "phone": "[Billing Phone]"
                },
                "internal_name": [Internal Name],
                "status": "[Status]",
                "refunded": "[Refunded]",
                "type": "[Transaction Type]",
                "authorization": {
                  "auth_id": "[Authorization ID]",
                  "charge_id": "[Charge ID]",
                  "tran_id": "[Transaction ID]",
                  "auth_code": "[Transaction Authorization Code]",
                  "raw_data": {
                    [Full Transaction Response Array]
                  }
                }
              }
            }
          }
        }
      

Response data: eCheck Payment Method (json format)

        {
          "status": "success",
          "successMessage": {
            "response_code": 707,
            "message": {
              "charge": {
                "id": "[Client ID]",
                "user_id": "[User ID]",
                "gateway_id": "[Gateway Account ID]",
                "date": "[Transaction Timestamp]",
                "amount": "[Amount]",
                "account_holder_fullname": "[Fullname Printed on Check]",
                "echeck_last_four": "[Bank Account Last Four]",
                "customer_id": "[Customer ID]",
                "internal_id": "[Internal ID]",
                "billing": {
                  "first_name": "[Billing First Name]",
                  "last_name": "[Billing Last Name]",
                  "company": "[Billing Company Name]",
                  "address_1": "[Billing Street Address]",
                  "address_2": "[Billing Address Line 2]",
                  "city": "[Billing City]",
                  "state": "[Billing State]",
                  "country": "[Billing Country]",
                  "postal_code": "[Billing Postal Code]",
                  "email": "[Billing Email]",
                  "phone": "[Billing Phone]"
                },
                "internal_name": [Internal Name],
                "status": "[Status]",
                "refunded": "[Refunded]",
                "type": "[Transaction Type]",
                "authorization": {
                  "auth_id": "[Authorization ID]",
                  "charge_id": "[Charge ID]",
                  "tran_id": "[Transaction ID]",
                  "auth_code": "[Transaction Authorization Code]",
                  "raw_data": {
                    [Full Transaction Response Array]
                  }
                }
              }
            }
          }
        }
      

POST charge

Refund a credit card charge.

Resource Information

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

Method Parameters

N/A

Query Parameters

PHP Example Request: (json format)

      $data = array(
          'charge_type' =>  'ccrefund',
          'gateway_id'   =>  '[Gateway ID]',
          'charge_id'   =>  '[Charge ID]',
          'amount'  =>  '1.00' // Total amount to charge
        );

        $data_string = json_encode($data);

        $ch = curl_init('https://demo.goodfundsgateway.com/api/charge.json');
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
        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": 1,
          "message": {
            "charge": {
              "success": true,
              "raw_data": {
                [Transaction Full Response Array]
              }
            }
          }
        }
      }
    

POST charge

Refund a eCheck charge. Note: Depending on the gateway account this may have limited functionality.

Resource Information

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

Method Parameters

N/A

Query Parameters

PHP Example Request: (json format)

      $data = array(
          'charge_type' =>  'ecrefund',
          'gateway_id'   =>  '[Gateway ID]',
          'charge_id'   =>  '[Charge ID]',
          'amount'  =>  '1.00' // Total amount to charge
        );

        $data_string = json_encode($data);

        $ch = curl_init('https://demo.goodfundsgateway.com/api/charge.json');
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
        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": 1,
          "message": {
            "charge": {
              "success": true,
              "raw_data": {
                [Transaction Full Response Array]
              }
            }
          }
        }
      }
    

POST setuprecurringcharge

Charge a recurring charge.

Resource Information

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

Method Parameters

N/A

Query Parameters

JSON Format Example

      {
        "charge_type":"ecrecurring",
        "gateway_id":"[Gateway ID]",
        "customer":
        {
          "internal_id":"174",
          "first_name":"John",
          "last_name":"Doe",
          "company":"John Doe's Bakery",
          "address_1":"321 Way St.",
          "address_2":"Suite 400",
          "city":"San Diego",
          "state":"CA",
          "postal_code":"92020",
          "country":"US",
          "phone":"619-444-5555",
          "email":"demo@gmail.com"
        },
        "billto":
        {
          "first_name":"John",
          "last_name":"Doe",
          "company":"John Doe's Bakery",
          "address_1":"321 Way St.",
          "address_2":"Suite 400",
          "city":"San Diego",
          "state":"CA",
          "postal_code":"92020",
          "country":"US",
          "phone":"619-444-5555",
          "email":"demo@gmail.com"
        },
        "schedule": {
            "frequency":"monthly",
            "payment_day":"18",
            "start_date":"2025-06-18",
            "num_payments":"indefinite",
            "enabled":"1",
            "description":"Product Services"
        },
        "echeck":
        {
          "echeck_name":"John Doe",
          "echeck_account_number":"9900000003",
          "echeck_routing_number":"321174851",
          "echeck_check_number":"2020",
          "echeck_account_type":"1",
          "echeck_holder_type":"0",
          "echeck_seccode":"PPD",
          "echeck_agree":"1"
        },
        "amount":"1.00"
      }
    

PHP Example Request: (json format)

      $data = array(
          'charge_type' =>  'ecdebit', //eccredit for credit transactions
          'gateway_id'   =>  '[Gateway ID]',
          'customer'    =>  array( // Customer Job From QB's
            'internal_id'   =>  '1375894109',
            'first_name'    =>  'John',
            'last_name'     =>  'Doe',
            'company'       =>  'John Doe\'s Bakery',
            'address_1'     =>  '321 Way St.',
            'address_2'     =>  'Suite 400',
            'city'          =>  'San Diego',
            'state'         =>  'CA',
            'postal_code'   =>  '92020',
            'country'       =>  'US',
            'phone'         =>  '619-444-5555',
            'email'         =>  'example@domain.com'
          ),
          'billto'  =>  array( // AVS billing information
            'first_name'      =>  'John',
            'last_name'       =>  'Doe',
            'company'         =>  'John Doe\'s Bakery',
            'address_1'       =>  '321 Way St.',
            'address_2'       =>  'Suite 400',
            'city'            =>  'San Diego',
            'state'           =>  'CA',
            'postal_code'     =>  '92020',
            'country'         =>  'US',
            'phone'           =>  '619-444-5555',
            'email'           =>  'example@domain.com'
          ),
          'echeck'  =>  array( // ECheck information
            'echeck_name'           =>  'John Doe',
            'echeck_account_number' =>  '9900000003',
            'echeck_routing_number' =>  '321174851',
            'echeck_check_number'   =>  '2020',
            'echeck_account_type'   =>  '1',
            'echeck_holder_type'    =>  '0',
            'echeck_seccode'        =>  'PPD',
            'echeck_agree'          =>  '1'
          ),
          'schedule'  =>  array( // Recurring schedule information
            'frequency'      =>  'monthly',
            'payment_day'    =>  '18',
            'start_date'     =>  '2025-06-18',
            'num_payments'   =>  'indefinite',
            'enabled'        =>  '1',
            'description'    =>  'Product Services'
          ),
          'amount'  =>  '1.00' // Total amount to charge
        );

        $data_string = json_encode($data);

        $ch = curl_init('https://demo.goodfundsgateway.com/api/setuprecurringcharge.json');
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
        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": 1,
          "message": {
            "charge": {
              "response_code": 100,
              "response_text": "Recurring Payment created.",
              "success": true,
              "recur_id": [Recurring Id],
              "raw_data": {
                [Transaction Response Array]
              },
              "amount": "1.00"
            }
          }
        }
      }