Customers

Related to people who participate in a transaction

List all records

Learn more from the JSON:API Specification
SecuritybearerAuth
Request
query Parameters
filter
string

filter[NAME]=value(s)

fields
string

sparse fieldsets: fields[TYPE]=field1,field2,...

include
sort
page[size]
integer <int32>

size of page for paginated results

page[number]
integer <int32>

page number of results

page[limit]
integer <int32>

limit for this page of paginated results

page[offset]
integer <int32>

collection items offset for paginated results

header Parameters
User-Agent
required
string

The name and version of the client making the request

Example: CHOAM EPT Client v10191 (Ruby Client v3)
Responses
200

OK

400

Some or all of the pieces of your request are invalid and this response details those issues.

401

The request was not authorized

403

Forbidden

406

TODO

422

Some or all of the pieces of your request are invalid and this response details those issues.

get/v2/customers
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "links": { },
  • "meta": {
    }
}
Create a new record
Learn more from the JSON:API Specification
SecuritybearerAuth 
Request 
query Parameters
fields
string
sparse fieldsets: fields[TYPE]=field1,field2,...


 
include
header Parameters
User-Agent
required
string
The name and version of the client making the request


 
 Example:  CHOAM EPT Client v10191 (Ruby Client v3)
Responses 
201
Created. Assigned id and/or any other changes are in this response.


400
Some or all of the pieces of your request are invalid and this response details those issues.


401
The request was not authorized


403
Forbidden


404
Not found


406
TODO


409
Conflict


415
TODO


422
Some or all of the pieces of your request are invalid and this response details those issues.


post/v2/customers
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "links": { },
  • "meta": {
    }
}
A list of related payment_demands
Learn more from the JSON:API Specification
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid>  (id) 
the identifier of the record


 
query Parameters
filter
string
filter[NAME]=value(s)


 
fields
string
sparse fieldsets: fields[TYPE]=field1,field2,...


 
include
sort
page[size]
integer <int32> 
size of page for paginated results


 
page[number]
integer <int32> 
page number of results


 
page[limit]
integer <int32> 
limit for this page of paginated results


 
page[offset]
integer <int32> 
collection items offset for paginated results


 
header Parameters
User-Agent
required
string
The name and version of the client making the request


 
 Example:  CHOAM EPT Client v10191 (Ruby Client v3)
Responses 
200
OK


400
Some or all of the pieces of your request are invalid and this response details those issues.


401
The request was not authorized


403
Forbidden


406
TODO


422
Some or all of the pieces of your request are invalid and this response details those issues.


get/v2/customers/{id}/relationships/payment_demands
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "links": { },
  • "meta": {
    }
}
Delete by unique id
Learn more from the JSON:API Specification
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid>  (id) 
the identifier of the record


 
query Parameters
fields
string
sparse fieldsets: fields[TYPE]=field1,field2,...


 
include
header Parameters
User-Agent
required
string
The name and version of the client making the request


 
 Example:  CHOAM EPT Client v10191 (Ruby Client v3)
Responses 
200
OK


204
Deleted.


400
Some or all of the pieces of your request are invalid and this response details those issues.


401
The request was not authorized


403
Forbidden


404
Not found


406
TODO


409
Conflict


415
TODO


422
Some or all of the pieces of your request are invalid and this response details those issues.


delete/v2/customers/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "links": { },
  • "meta": {
    }
}
Fetch by unique id
Learn more from the JSON:API Specification
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid>  (id) 
the identifier of the record


 
query Parameters
fields
string
sparse fieldsets: fields[TYPE]=field1,field2,...


 
include
header Parameters
User-Agent
required
string
The name and version of the client making the request


 
 Example:  CHOAM EPT Client v10191 (Ruby Client v3)
Responses 
200
OK


400
Some or all of the pieces of your request are invalid and this response details those issues.


401
The request was not authorized


403
Forbidden


404
Not found


406
TODO


422
Some or all of the pieces of your request are invalid and this response details those issues.


get/v2/customers/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "links": { },
  • "meta": {
    }
}
Update by unique id
Learn more from the JSON:API Specification
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid>  (id) 
the identifier of the record


 
query Parameters
fields
string
sparse fieldsets: fields[TYPE]=field1,field2,...


 
include
header Parameters
User-Agent
required
string
The name and version of the client making the request


 
 Example:  CHOAM EPT Client v10191 (Ruby Client v3)
Responses 
200
OK


400
Some or all of the pieces of your request are invalid and this response details those issues.


401
The request was not authorized


403
Forbidden


404
Not found


406
TODO


409
Conflict


415
TODO


422
Some or all of the pieces of your request are invalid and this response details those issues.


patch/v2/customers/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "links": { },
  • "meta": {
    }
}
Fetch related address
Learn more from the JSON:API Specification
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid>  (id) 
the identifier of the record


 
query Parameters
fields
string
sparse fieldsets: fields[TYPE]=field1,field2,...


 
include
header Parameters
User-Agent
required
string
The name and version of the client making the request


 
 Example:  CHOAM EPT Client v10191 (Ruby Client v3)
Responses 
200
OK


400
Some or all of the pieces of your request are invalid and this response details those issues.


401
The request was not authorized


403
Forbidden


404
Related resource does not exist.


406
TODO


422
Some or all of the pieces of your request are invalid and this response details those issues.


get/v2/customers/{id}/relationships/address
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "links": { },
  • "meta": {
    }
}
Fetch related merchant
Learn more from the JSON:API Specification
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid>  (id) 
the identifier of the record


 
query Parameters
fields
string
sparse fieldsets: fields[TYPE]=field1,field2,...


 
include
header Parameters
User-Agent
required
string
The name and version of the client making the request


 
 Example:  CHOAM EPT Client v10191 (Ruby Client v3)
Responses 
200
OK


400
Some or all of the pieces of your request are invalid and this response details those issues.


401
The request was not authorized


403
Forbidden


404
Related resource does not exist.


406
TODO


422
Some or all of the pieces of your request are invalid and this response details those issues.


get/v2/customers/{id}/relationships/merchant
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "links": { },
  • "meta": {
    }
}
➔ Next to Payment Methods