Customers (Deprecated)

WARNING

This section has been deprecated and is no longer under active development. Please see the Customer Vault section for the most up to date methods for managing customers.

Create Customer (Deprecated)

Create a new customer.

Request Method: POST

URL Endpoint: /api/customer

Query Params

Name	Default	Description
validate	"false"	passing "true" will cause credit cards to have a $0 verification processed

Name	Type	Default	Description	Required
description	string	""	Text field, max 255 characters
payment_method	object	null
payment_method .processor_id	string	""	Specify which processor to validate on
payment_method .card	object	null	Object containing details for processing a transaction against a debit or credit card
payment_method .card .card_number	string		"4111111111111111"	required if `payment_method.card` is present
payment_method .card .expiration_date	string		"MMYY" or "MM/YY"	required if `payment_method.card` is present
payment_method .ach	object	null	Object containing details for processing a transaction via ACH
payment_method .ach .account_number	string		"111111111"
payment_method .ach .routing_number	string		"111111111"
payment_method .ach .account_type	string literal		"checking" or "savings"	required if `payment_method.ach` is present
payment_method .ach .sec_code	string literal		"web", "ppd", or "ccd"	required if `payment_method.ach` is present
payment_method .apple_pay_token	string
billing_address	object	null	Object containing billing address details
billing_address .first_name	string	""	Addressee first name
billing_address .last_name	string	""	Addressee last name
billing_address .company	string	""	Company name
billing_address .address_line_1	string	""	Street address
billing_address .address_line_2	string	""	Additional delivery details
billing_address .city	string	""	City name
billing_address .state	string	""	State code ("CA")
billing_address .postal_code	string	""	Postal code ("12345")
billing_address .country	string	""	Country code ("US")
billing_address .email	string	""	Email address (must be valid email format, "example@mail.com")
billing_address .phone	string	""	Phone number ("3216540987")
billing_address .fax	string	""	("3216540987")
shipping_address	object	null	Object containing shipping address details
shipping_address .first_name	string	""	Addressee first name
shipping_address .last_name	string	""	Addressee last name
shipping_address .company	string	""	Company name
shipping_address .address_line_1	string	""	Street address
shipping_address .address_line_2	string	""	Additional delivery details
shipping_address .city	string	""	City name
shipping_address .state	string	""	State code ("CA")
shipping_address .postal_code	string	""	Postal code ("12345")
shipping_address .country	string	""	Country code ("US")
shipping_address .email	string	""	Email address (must be valid email format, "example@mail.com")
shipping_address .phone	string	""	Phone number ("3216540987")
shipping_address .fax	string	""	("3216540987")

Get Customer By ID (Deprecated)

Retrieve details for the specified customer.

Request Method: GET

URL Endpoint: /api/customer/{ customer id }

json

{
  "status": "success",
  "msg": "success",
  "data": {
    "id": "b798ls2q9qq646ksu070",
    "description": "test description",
    "payment_method": {
      "card": {
        "id": "b798ls2q9qq646ksu080",
        "card_type": "visa",
        "first_six": "411111",
        "last_four": "1111",
        "masked_card": "411111******1111",
        "expiration_date": "12/20",
        "created_at": "2017-10-02T18:52:32Z",
        "updated_at": "2017-10-02T18:52:32Z"
      }
    },
    "billing_address": {
      "id": "b798ls2q9qq646ksu07g",
      "customer_id": "b798ls2q9qq646ksu070",
      "first_name": "John",
      "last_name": "Smith",
      "company": "Some Business",
      "address_line_1": "123 Some St",
      "address_line_2": "STE 1",
      "city": "Some Town",
      "state": "IL",
      "postal_code": "60187",
      "country": "US",
      "email": "user@somesite.com",
      "phone": "5555555555",
      "fax": "555555555",
      "created_at": "2017-10-02T18:52:32Z",
      "updated_at": "2017-10-02T18:52:32Z"
    },
    "shipping_address": {
      "id": "b798ls2q9qq646ksu07g",
      "customer_id": "b798ls2q9qq646ksu070",
      "first_name": "John",
      "last_name": "Smith",
      "company": "Some Business",
      "address_line_1": "123 Some St",
      "address_line_2": "STE 1",
      "city": "Some Town",
      "state": "IL",
      "postal_code": "60187",
      "country": "US",
      "email": "user@somesite.com",
      "phone": "5555555555",
      "fax": "555555555",
      "created_at": "2017-10-02T18:52:32Z",
      "updated_at": "2017-10-02T18:52:32Z"
    },
    "created_at": "2017-10-02T18:52:32Z",
    "updated_at": "2017-10-02T18:52:32Z"
  }
}

Search Customers (Deprecated)

Retrieve details for all customers that match provided search criteria.

Request Method: POST

URL Endpoint: /api/customer/search

Name	Type	Default	Description	Required
id	object	null	Object containing details for searching by customer id
id .operator	string literal		Search operator "=" or "!="	required if `id` is present
id .value	string	""	Customer ID to match or exclude
payment_method_id	object	null	Object containing details for searching by `payment_method_id`
payment_method_id .id	string	""	Search customers with the provided value set as the default `payment_method_id`
payment_method_id .operator	string literal		"=" or "!="	required if `payment_method_id` is present
payment_method_id .value	string	""	Value to match or exclude
billing_address_id	object	null	Object containing details for searching by `billing_address_id`
billing_address_id .id	string	""	Search customers with the provided value set as the default `billing_address_id`
billing_address_id .operator	string literal		"=" or "!="	required if `billing_address_id` is present
billing_address_id .value	string	""	Value to match or exclude
shipping_address_id	object	null	Object containing details for searching by `shipping_address_id`
shipping_address_id .id	string	""	Search customers with the provided value set as the default `shipping_address_id`
shipping_address_id .operator	string literal		"=" or "!="	required if `shipping_address_id` is present
shipping_address_id .value	string	""	Value to match or exclude
created_at	object	null	Object containing details defining a date range to match
created_at .start_date	string	""	Beginning of date range
created_at .end_date	string	""	End of date range
limit	integer	10	The number of results to return (1-100)
offset	integer	0	The number of results to skip (1-1000)

Update Customer (Deprecated)

Edit details for the specified customer. If you have used the Create Customer Payment Method Token (Deprecated) endpoint to create a payment method token, or the Create Customer Address Token (Deprecated) endpoint to create an address token, the id's of those stored items can be supplied here to be set as the default payment method and billing/shipping addresses when a transaction is processed against the customer.

Request Method: POST

URL Endpoint: /api/customer/{ customer id }

Name	Type	Default	Description
description	string	""	Text field, max 255 characters
payment_method	string literal		"card" or "ach"
payment_method_id	string	""	Id of the payment method token to use as the default for transactions processed on this customer
billing_address_id	string	""	Id of the address token to use as the default billing address for transactions processed on this customer
shipping_address_id	string	""	Id of the address token to use as the default shipping address for transactions processed on this customer

Delete Customer (Deprecated)

Delete the specified customer.

Request Method: DELETE

URL Endpoint: /api/customer/{ customer id }

json

{
  "status": "success",
  "msg": "success",
  "data": null
}

Create Address Token (Deprecated)

Create a new stored address token.

Request Method: POST

URL Endpoint: /api/customer/{ customer id }/address

Name	Type	Default	Description
first_name	string	""	Addressee first name
last_name	string	""	Addressee last name
company	string	""	Company name
line_1	string	""	Street address
line_2	string	""	Additional delivery details
city	string	""	City name
state	string	""	State code ("CA")
postal_code	string	""	Postal code ("12345")
country	string	""	Country code ("US")
email	string	""	Email address (must be valid email format, "example@mail.com")
phone	string	""	Phone number ("3216540987")
fax	string	""	Fax number ("3216540987")

Get Address Token By ID (Deprecated)

Retrieve details for the specified address token.

Request Method: GET

URL Endpoint: /api/customer/{ customer id }/address/{ address id }

json

{
  "status": "success",
  "msg": "success",
  "data": [
    {
      "id": "b798ls2q9qq646ksu07g",
      "customer_id": "b798ls2q9qq646ksu070",
      "first_name": "John",
      "last_name": "Smith",
      "company": "Some Business",
      "address_line_1": "123 Some St",
      "address_line_2": "STE 1",
      "city": "Some Town",
      "state": "IL",
      "postal_code": "60187",
      "country": "US",
      "email": "user@somesite.com",
      "phone": "5555555555",
      "fax": "555555555",
      "created_at": "2017-10-02T18:52:32Z",
      "updated_at": "2017-10-02T18:52:32Z"
    }
  ],
  "count": 1
}

Get All Address Tokens (Deprecated)

Retrieve details for all address tokens stored on the customer record.

Request Method: GET

URL Endpoint: /api/customer/{ customer id }/addresses

json

{
  "status": "success",
  "msg": "success",
  "data": [
    {
      "id": "b798ls2q9qq646ksu07g",
      "customer_id": "b798ls2q9qq646ksu070",
      "first_name": "John",
      "last_name": "Smith",
      "company": "Some Business",
      "address_line_1": "123 Some St",
      "address_line_2": "STE 1",
      "city": "Some Town",
      "state": "IL",
      "postal_code": "60187",
      "country": "US",
      "email": "user@somesite.com",
      "phone": "5555555555",
      "fax": "555555555",
      "created_at": "2017-10-02T18:52:32Z",
      "updated_at": "2017-10-02T18:52:32Z"
    },
    {
      "id": "b7994biq9qq646ksu08g",
      "customer_id": "b798ls2q9qq646ksu070",
      "first_name": "John",
      "last_name": "Smith",
      "company": "Some Business",
      "address_line_1": "123 Some St",
      "address_line_2": "STE 1 ",
      "city": "Some Town",
      "state": "IL",
      "postal_code": "60187",
      "country": "US",
      "email": "user@somesite.com",
      "phone": "5555555555",
      "fax": "555555555",
      "created_at": "2017-10-02T19:23:27Z",
      "updated_at": "2017-10-02T19:23:27Z"
    }
  ],
  "count": 2
}

Update Address Token (Deprecated)

Edit details for the specified address token.

Request Method: POST

URL Endpoint: /api/customer/{ customer id }/address/{ address id }

Name	Type	Default	Description
first_name	string	""	Addressee first name
last_name	string	""	Addressee last name
company	string	""	Company name
line_1	string	""	Street address
line_2	string	""	Additional delivery details
city	string	""	City name
state	string	""	State code ("CA")
postal_code	string	""	Postal code ("12345")
country	string	""	Country code ("US")
email	string	""	Email address (must be valid email format, "example@mail.com")
phone	string	""	Phone number ("3216540987")
fax	string	""	Fax number ("3216540987")

Delete Address Token (Deprecated)

Delete the specified address token.

Request Method: DELETE

URL Endpoint: /api/customer/{ customer id }/address/{ address id }

json

{
  "status": "success",
  "msg": "success",
  "data": null
}

Create Payment Method Token (Deprecated)

Create a new stored payment method token on the specified customer. The url endpoint and request body properties vary depending on the type of payment method being created. When creating a new payment method using a token generated by the Tokenizer form, the resulting payment method will be stored as card or ach.

Request Method: POST

Create Card - URL Endpoint: /api/customer/{ customer id }/paymentmethod/card

Create ACH - URL Endpoint: /api/customer/{ customer id }/paymentmethod/ach

Create with Token - URL Endpoint: /api/customer/{ customer id }/paymentmethod/token

Query Params

Name	Default	Description
validate	"false"	passing "true" will cause credit cards to have a $0 verification processed

Name	Type	Default	Description	Required
number	string	""	Card number
expiration_date	string	""	Card expiration date ("MMYY" or "MM/YY")	*

Create Payment Method Token - Code Samples

json

{
  "status": "success",
  "msg": "success",
  "data": {
    "card": {
      "id": "b799g1iq9qq6dk5l39i0",
      "card_type": "visa",
      "first_six": "411111",
      "last_four": "1112",
      "masked_card": "411111******1112",
      "expiration_date": "12/20",
      "created_at": "2017-10-02T19:48:22.468483Z",
      "updated_at": "2017-10-02T19:48:22.468483Z"
    }
  }
}

Get Payment Method Token By ID (Deprecated)

Retrieve details for the specified payment method token.

Request Method: GET

Get Card Token - URL Endpoint: /api/customer/{ customer id }/paymentmethod/card/{ card id }

Get ACH Token - URL Endpoint: /api/customer/{ customer id }/paymentmethod/ach/{ ach id }

json

{
  "status": "success",
  "msg": "success",
  "data": [
    {
      "id": "b798ls2q9qq646ksu080",
      "card_type": "visa",
      "first_six": "411111",
      "last_four": "1111",
      "masked_card": "411111******1111",
      "expiration_date": "12/20",
      "created_at": "2017-10-02T18:52:32Z",
      "updated_at": "2017-10-02T18:52:32Z"
    }
  ],
  "count": 1
}

Get All Payment Method Tokens (Deprecated)

Retrieve details for all card or ach payment method tokens stored on the customer.

Request Method: GET

Get Card Tokens - URL Endpoint: /api/customer/{ customer id }/paymentmethod/card

Get ACH Tokens - URL Endpoint: /api/customer/{ customer id }/paymentmethod/ach

json

{
  "status": "success",
  "msg": "success",
  "data": [
    {
      "id": "b798ls2q9qq646ksu080",
      "card_type": "visa",
      "first_six": "411111",
      "last_four": "1111",
      "masked_card": "411111******1111",
      "expiration_date": "12/20",
      "created_at": "2017-10-02T18:52:32Z",
      "updated_at": "2017-10-02T18:52:32Z"
    },
    {
      "id": "b799g1iq9qq6dk5l39i0",
      "card_type": "visa",
      "first_six": "411111",
      "last_four": "1112",
      "masked_card": "411111******1112",
      "expiration_date": "12/20",
      "created_at": "2017-10-02T19:48:22Z",
      "updated_at": "2017-10-02T19:48:22Z"
    }
  ],
  "count": 2
}

Update Payment Method Token (Deprecated)

Edit details for the specified payment method token.

Request Method: POST

Update Card - URL Endpoint: /api/customer/{ customer id }/paymentmethod/card/{ card id }

Update ACH - URL Endpoint: /api/customer/{ customer id }/paymentmethod/ach/{ ach id }

Update with Token - URL Endpoint: /api/customer/{ customer id }/paymentmethod/{ card or ach }/{ payment method id }

Name	Type	Description	Required
card	object	Object containing details for updating a stored card payment method	*
card .card_number	string	Card number	*
card .expiration_date	string	Card expiration date ("MMYY" or "MM/YY")	*

Update Payment Method Token - Code Samples

json

{
  "status": "success",
  "msg": "success",
  "data": null
}

Delete Payment Method Token (Deprecated)

Edit details for the specified add-on.

Request Method: DELETE

Delete Card Token - URL Endpoint: /api/customer/{ customer id }/paymentmethod/card/{ card id }

Delete ACH Token - URL Endpoint: /api/customer/{ customer id }/paymentmethod/ach/{ ach id }

json

{
  "status": "success",
  "msg": "success",
  "data": null
}

Customers (Deprecated) ​

Create Customer (Deprecated) ​

Get Customer By ID (Deprecated) ​

Search Customers (Deprecated) ​

Update Customer (Deprecated) ​

Delete Customer (Deprecated) ​

Create Address Token (Deprecated) ​

Get Address Token By ID (Deprecated) ​

Get All Address Tokens (Deprecated) ​

Update Address Token (Deprecated) ​

Delete Address Token (Deprecated) ​

Create Payment Method Token (Deprecated) ​

Create Payment Method Token - Code Samples ​

Get Payment Method Token By ID (Deprecated) ​

Get All Payment Method Tokens (Deprecated) ​

Update Payment Method Token (Deprecated) ​

Update Payment Method Token - Code Samples ​

Delete Payment Method Token (Deprecated) ​

Customers (Deprecated)

Create Customer (Deprecated)

Get Customer By ID (Deprecated)

Search Customers (Deprecated)

Update Customer (Deprecated)

Delete Customer (Deprecated)

Create Address Token (Deprecated)

Get Address Token By ID (Deprecated)

Get All Address Tokens (Deprecated)

Update Address Token (Deprecated)

Delete Address Token (Deprecated)

Create Payment Method Token (Deprecated)

Create Payment Method Token - Code Samples

Get Payment Method Token By ID (Deprecated)

Get All Payment Method Tokens (Deprecated)

Update Payment Method Token (Deprecated)

Update Payment Method Token - Code Samples

Delete Payment Method Token (Deprecated)