Payment Type

The payment type for future charges can either be a credit card or echeck stored in the Vault Billing System.

With the leading edge of technology these days we have changed our solutions for this matter to be only for tokenization supported gateways. This means when setting up the merchant account, the tokenization will need to be added to their account. Below are the different methods that are linked to the payment types.

Method: SavePaymentType

Create an payment type through this method to be used right away or in the future.

Request data: ( Credit Card )

Variable Type Required Format/Example
id automatic 123456789
gateway_id int The system ID for the payment gateway used for the charge. If left empty, the default/only gateway will be used.
customer node Include sub-nodes with any/all available customer data. For more information, see the "Embedding customer data in Charge/Recur requests" on the customers page. Only include this parameter if you are not including a customer_id. Charges do not need to be linked to a customer.
internal_id string A username or user ID in your own records, e.g. "Simulatedusername", "98765432".
first_name string yes Joe
last_name string yes Smith
address_1 string 12345 Simulated St.
address_2 string For apartment/unit/suite #'s, eg. "Unit 2".
city string Toronto
state string The state/province/region of the customer. For the US and Canada, this must be supplied as the two letter abbreviation, eg. "ON"
country country The ISO 3166-1 alpha-2 code of the customer's country, e.g. "CA", "US".
postal_code string The zip or postal code of the user, e.g. "A1B2C3", "90210".
emails node Added support for more than one email to be passed through with the charge.
email email A valid email address for the customer.
phone string 1-555-555-0000
credit_card node yes All credit card sub-nodes must be included with accurate credit card information regarding the purchaser.
name string yes The purchaser's name. This must match the name on the credit card.
card_num int yes The purchaser's credit card number, e.g. "1234567809876543".
cctype string The credit card brand used, e.g. "VISA"
exp_month int yes The purchaser's credit card expiry month with 2-digit representation, e.g. "10".
exp_year int yes The purchaser's credit card expiry year with 2-digit representation, e.g. "14".
level3 node Include sub-nodes with any/all available level 3 data. For more information, see the "Embedding payment information data in Charge/Recur requests" on the level3 page.

Response data:

  • response_code - "700" upon success, "2" upon failure.
  • response_text - A verbose description of the response_code.
  • payment_id - The ID of the payment type.

Request data: ( E-Check )

Variable Type Required Format/Example
id automatic 123456789
gateway_id int The system ID for the payment gateway used for the charge. If left empty, the default/only gateway will be used.
customer node Include sub-nodes with any/all available customer data. For more information, see the "Embedding customer data in Charge/Recur requests" on the customers page. Only include this parameter if you are not including a customer_id. Charges do not need to be linked to a customer.
internal_id string A username or user ID in your own records, e.g. "Simulatedusername", "98765432".
first_name string yes Joe
last_name string yes Smith
address_1 string 12345 Simulated St.
address_2 string For apartment/unit/suite #'s, eg. "Unit 2".
city string Toronto
state string The state/province/region of the customer. For the US and Canada, this must be supplied as the two letter abbreviation, eg. "ON"
country country The ISO 3166-1 alpha-2 code of the customer's country, e.g. "CA", "US".
postal_code string The zip or postal code of the user, e.g. "A1B2C3", "90210".
emails node Added support for more than one email to be passed through with the charge.
email email A valid email address for the customer.
phone string 1-555-555-0000
echeck node yes All echeck sub-nodes must be included with accurate echeck / ach information regarding the purchaser.
nameoncheck string yes The purchaser's name. This must match the name printed on the check.
account_num int yes The purchaser's bank account number, e.g. "123456".
routing_num int yes The purchaser's routing number, e.g. "123456789".
bankaccounttype int yes The purchaser's account holder type, e.g. pass a value of 0 for Business and 1 for Personal
first_name string yes The purchaser's first name, if Personal bank account type first name is required data.
last_name string yes The purchaser's last name, if Personal bank account type last name is required data.
company string yes The purchaser's company name, if Business bank account type company is required data.
seccode string yes SEC CODE for processing type, for more detailed information on sec codes visit the seccode page.
level3 node Include sub-nodes with any/all available level 3 data. For more information, see the "Embedding payment information data in Charge/Recur requests" on the level3 page.

Response data:

  • response_code - "700" upon success, "2" upon failure.
  • response_text - A verbose description of the response_code.
  • payment_id - The ID of the payment type.

Method: UpdatePaymentType

Update the specific payment type through this method.

Required data:

  • payment_id
  • gateway_id

Optional data:

  • Any/all of the object data above, except payment_id. Referrence ( Credit Card ) for credit card payment types or referrence ( E-Check ) for echeck payment types list above.

Response data:

  • response_code - "701" upon success, "2" upon failure.
  • response_text - A verbose description of the response_code.
  • payment_id - The ID of the payment type.

Method: DeletePaymentType

Delete an existing payment type.

Required data:

  • payment_id

Response data:

  • response_code - "702" upon success, "2" upon failure.
  • response_text - A verbose description of the response_code.
  • payment_id - The ID of the payment type.

Method: GetPaymentType

Gets a record for an individual payment type.

Required data:

  • payment_id - The ID of the payment type

Response data:

  • payment_type
    • All available payment type data.

Example response:

<?xml version="1.0" encoding="utf-8"?>
<response>
	<payment_type>
		<customer>32</customer>
			<payment_id>32</payment_id>
			<client_id>1546</client_id>
			<id>Joe</id>
			<internal_id/>
			<first_name>Test</first_name>
			<last_name>Testerson</last_name>
			<company/>
			<address_1>123 Broadway</address_1>
			<address_2/>
			<city>San Diego</city>
			<state>CA</state>
			<postal_code>92101</postal_code>
			<country>USA</country>
			<email>susandoe@gmail.com</email>
			<phone/>
		</customer>
		<credit_card>
			<name>Test Testerson</name>
			<token>[token]</token>
			<cctype>VISA</cctype>
			<exp_month>05</exp_month>
			<exp_year>2016</exp_year>
		</credit_card>
		<level3>
			<first_name>Test</first_name>
			<last_name>Testerson</last_name>
			<company/>
			<address_1>123 Broadway</address_1>
			<address_2/>
			<city>San Diego</city>
			<state>CA</state>
			<postal_code>92101</postal_code>
			<country>USA</country>
			<email>joe@example.com</email>
			<phone/>
		</level3>
	</payment_type>
</response>

Method: GetPaymentTypes

Searches all Payment Types. If a request is made without any filters, the first 100 payment type records, ordered by "payment_type", are returned.

Optional filters:

  • Any of the variables listed under Object Data, except id.
  • payment_type - User credit_cards for search for credit cards in the system or use echecks to search for only echecks listed.
  • internal_id - Only retrieve by the internal id customer:job or job number with payment types.
  • offset - Retrieval will begin after offset # of records. Useful for pagination. Default: 0.
  • limit - The total number of records to retrieve, beginning at the offset. Maximum: 100. Default: 100.
  • sort - The field on which to sort retrieved records. Default: "payment_type". Available values:
    • payment_type
  • sort_dir - The direction in which to sort retrieved records. Default: "asc". Can also be "desc".

Response data:

  • payment_types
    • All available payment type data.

Example response:

<?xml version="1.0" encoding="utf-8"?>
<response>
  <results>2</results>
  <total_results>2</total_results>
  <payment_types>
	  <payment_type>
			<customer>32</customer>
				<payment_id>32</payment_id>
				<client_id>1546</client_id>
				<id>Joe</id>
				<internal_id/>
				<first_name>Test</first_name>
				<last_name>Testerson</last_name>
				<company/>
				<address_1>123 Broadway</address_1>
				<address_2/>
				<city>San Diego</city>
				<state>CA</state>
				<postal_code>92101</postal_code>
				<country>USA</country>
				<email>joe@example.com</email>
				<phone/>
			</customer>
			<credit_card>
				<name>Test Testerson</name>
				<token>[token]</token>
				<cctype>VISA</cctype>
				<exp_month>05</exp_month>
				<exp_year>2016</exp_year>
			</credit_card>
			<level3>
				<first_name>Test</first_name>
				<last_name>Testerson</last_name>
				<company/>
				<address_1>123 Broadway</address_1>
				<address_2/>
				<city>San Diego</city>
				<state>CA</state>
				<postal_code>92101</postal_code>
				<country>USA</country>
				<email>joe@example.com</email>
				<phone/>
			</level3>
		</payment_type>
    </payment_types>
</response>

Compare our service and prices to our competitors and
Give Us A Call

(866) 927-7180


All rights reserved. Built on the CodeIgniter framework.