Sign in

v1

latestOpenAPI 3.0.32026-07-248079274.0 KB
Customers

Retrieve a customer

Retrieves a customer using the unique customer_id. This identifier can be found in the response after creating a new customer.

get/customers/{customer_id}

Path parameters

customer_idstring uuid required

Unique ID assigned by Acquired.com for the customer.

Query parameters

filterstring

Filter the parameters that you want to return within the response.

Response

OK

company_idstring uuid

Unique ID assigned by Acquired.com to the company the customer belongs token.

referencestring

Unique reference assigned by you for the customer when it is created.

first_namestring

The customer's first name.

last_namestring

The customer's last name. Required for MCC 6012 merchants.

dobstring date

The customer's date of birth. Required for MCC 6012 merchants.

custom_datastring

Base64 encoded string detailing custom data passed in the request.

createdstring date-time

The date and time at which the customer was created.

last_updatedstring date-time

The date and time the customer record was last updated.

Example response

{
  "reference": "customer_number_00001",
  "first_name": "Edward",
  "last_name": "Johnson",
  "dob": "1988-10-03",
  "custom_data": "L3BheW1lbnQtbGlua3MgcGF5IGN1c3RvbV9kYXRh",
  "billing": {
    "address": {
      "line_1": "152 Aldgate Drive",
      "city": "London",
      "postcode": "E1 7RT",
      "country_code": "GB"
    },
    "email": "ejohnson@acquired.com",
    "phone": {
      "country_code": "44",
      "number": "2039826580"
    }
  },
  "shipping": {
    "address": {
      "line_1": "152 Aldgate Drive",
      "city": "London",
      "postcode": "E1 7RT",
      "country_code": "GB"
    },
    "email": "ejohnson@acquired.com",
    "phone": {
      "country_code": "44",
      "number": "2039826580"
    }
  }
}