Customers

Create a customer

post

---

Overview

Add new customers in the 2Checkout platform. By default, customer status is Inactive until you assign a specific subscription to the customer. Following that action, customer status reflects the status of the attached subscription(s).

Header parameters

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Acceptstring · enumRequiredExample: application/jsonPossible values:

Body

application/json

ExternalCustomerReferencestringOptional

FirstNamestringOptional

LastNamestringOptional

CompanystringOptional

FiscalCodestringOptional

Address1stringOptional

Address2stringOptional

CitystringOptional

StatestringOptional

ZipstringOptional

CountryCodestringOptional

PhonestringOptional

FaxstringOptional

EmailstringOptional

ExistingCardsstring[]Optional

EnabledbooleanOptional

TrialbooleanOptional

LanguagestringOptional

CustomerReferencestringOptional

Responses

200

OK

post

/customers/

HTTPcURLJavaScriptPython

POST /rest/6.0/customers/ HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: application/json
Content-Type: application/json
Content-Length: 438

{
  "ExternalCustomerReference": "HotTalks1Customer127",
  "FirstName": "John",
  "LastName": "Doe",
  "Company": "test company",
  "FiscalCode": "",
  "Address1": "Address details",
  "Address2": "55",
  "City": "London",
  "State": "London",
  "Zip": "WC1A1AH",
  "CountryCode": "gb",
  "Phone": "265897456",
  "Fax": "",
  "Email": "[e-mail]",
  "ExistingCards": [],
  "Enabled": false,
  "Trial": false,
  "CustomerReference": "423577932",
  "Credit": {
    "Limit": 120,
    "Remaining": 17,
    "Currency": "USD"
  }
}

200

OK

No content

Retrieve a customer

get

---

Overview Retrieve customer information from the 2Checkout platform using either the 2Checkout Customer Reference or the External Customer Reference.

Path parameters

CReferencestringRequired

Internal 2Checkout customer reference or your customer identifier

Example: HotTalks1Customer123

includePaymentDatabooleanRequired

Flag used to indicate if customer payment information should be returned or not

Example: true

Header parameters

Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Responses

200

OK

application/json

get

/customers/{CReference}/

HTTPcURLJavaScriptPython

GET /rest/6.0/customers/{CReference}/ HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

200

OK

{
  "ExternalCustomerReference": "HotTalks1Customer127",
  "FirstName": "John",
  "LastName": "Doe",
  "Company": "test company",
  "FiscalCode": "",
  "Address1": "Address details",
  "Address2": "55",
  "City": "London",
  "State": "London",
  "Zip": "WC1A1AH",
  "CountryCode": "gb",
  "Phone": "265897456",
  "Fax": "",
  "Email": "[e-mail]",
  "ExistingCards": [],
  "Enabled": false,
  "Trial": false,
  "CustomerReference": "423577932",
  "Credit": {
    "Limit": 120,
    "Remaining": 17,
    "Currency": "USD"
  }
}

Update a customer

put

---

Overview

Update customer information from the 2Checkout platform using the 2Checkout Customer Reference.

---

Method and URL

PUT https://api.2checkout.com/rest/5.0/customers/CReference/

---

Example URL

To update a customer in the 2Checkout system, use this URL:

• https://api.2checkout.com/rest/5.0/customers/{CReference}/

---

Response

200 JSON

Path parameters

CReferencestringRequired

Internal 2Checkout customer reference

Example: 258113240

Query parameters

endUserUpdatebooleanOptional

Set true to have the changes reflected on the end-user details for all subscriptions.

Example: false

Header parameters

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Acceptstring · enumRequiredExample: application/jsonPossible values:

Body

application/json

ExternalCustomerReferencestringOptional

FirstNamestringOptional

LastNamestringOptional

CompanystringOptional

FiscalCodestringOptional

Address1stringOptional

Address2stringOptional

CitystringOptional

StatestringOptional

ZipstringOptional

CountryCodestringOptional

PhonestringOptional

FaxstringOptional

EmailstringOptional

ExistingCardsstring[]Optional

EnabledbooleanOptional

TrialbooleanOptional

LanguagestringOptional

CustomerReferencestringOptional

Responses

200

OK

application/json

put

/customers/{CReference}/

HTTPcURLJavaScriptPython

PUT /rest/6.0/customers/{CReference}/ HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: application/json
Content-Type: application/json
Content-Length: 470

{
  "ExternalCustomerReference": "HotTalks1Customer127",
  "FirstName": "FirstName",
  "LastName": "LastName",
  "Company": "Test Company",
  "FiscalCode": "",
  "Address1": "Address example",
  "Address2": "no 55",
  "City": "Los Angeles",
  "State": "AC",
  "Zip": 90210,
  "CountryCode": "us",
  "Phone": 265897456,
  "Fax": 265897456,
  "Email": "[e-mail]",
  "ExistingCards": [],
  "Enabled": false,
  "Trial": false,
  "Language": "",
  "CustomerReference": 449705361,
  "Credit": {
    "Limit": 120,
    "Remaining": 17,
    "Currency": "USD"
  }
}

200

OK

true

Delete customer credit card

delete

Delete customer credit card

Path parameters

CReferencestringRequired

Internal 2Checkout customer reference or your customer identifier string

Example: 260015052

TransientTokenstringRequired

Transient Token for card, can be fount in getCustomerInfoBySSOToken string

Example: 2hih36ssdf96i8cx4y7868brh5fyi0frmrpvtjgf

Header parameters

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Responses

200

OK

application/json

400

Not deleted

application/json

delete

/customers/{CReference}/credit-card/{TransientToken}

HTTPcURLJavaScriptPython

DELETE /rest/6.0/customers/{CReference}/credit-card/{TransientToken} HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: */*

{
  "Deleted": true
}