Merchants

Relating to merchant businesses

A list of related corporate_officials

SecuritybearerAuth

Request

path Parameters

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	string list of included related resources
sort	string fields to sort by
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

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/merchants/{id}/relationships/corporate_officials

Request samples

curl
Ruby
Python
Node.js
PHP

Response samples

application/vnd.api+json

{"data": {"attributes": {"inserted_at": "2024-06-06T21:48:33.382755Z",
"updated_at": "2024-06-06T21:48:33.382755Z"
},
"id": "ab8919ff-84d7-4385-a1a5-1a5df7d9ad64",
"links": { },
"relationships": { },
"type": "corporate_officials"
},
"links": { },
"meta": {"authors": ["Ziyan Judaideen",
"James Stuessy",
"Amadeus Folego",
"Kurtis Rainbolt-Greene"
],
"copyright": "2024 Edge Payment Technologies, Inc."
}
}

A list of related beneficial_owners

SecuritybearerAuth

Request

path Parameters

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	string list of included related resources
sort	string fields to sort by
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

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/merchants/{id}/relationships/beneficial_owners

Request samples

curl
Ruby
Python
Node.js
PHP

Response samples

application/vnd.api+json

{"data": {"attributes": {"inserted_at": "2024-06-06T21:48:33.382755Z",
"updated_at": "2024-06-06T21:48:33.382755Z"
},
"id": "73c159b1-666f-403c-8849-db4d3b772c33",
"links": { },
"relationships": { },
"type": "beneficial_owners"
},
"links": { },
"meta": {"authors": ["Ziyan Judaideen",
"James Stuessy",
"Amadeus Folego",
"Kurtis Rainbolt-Greene"
],
"copyright": "2024 Edge Payment Technologies, Inc."
}
}

A list of related payment_demands

SecuritybearerAuth

Request

path Parameters

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	string list of included related resources
sort	string fields to sort by
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

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/merchants/{id}/relationships/payment_demands

Request samples

curl
Ruby
Python
Node.js
PHP

Response samples

application/vnd.api+json

{"data": {"attributes": {"inserted_at": "2024-06-06T21:48:33.382755Z",
"updated_at": "2024-06-06T21:48:33.382755Z"
},
"id": "d6960724-7a15-492e-8d2d-a6b63ec852d0",
"links": { },
"relationships": { },
"type": "payment_demands"
},
"links": { },
"meta": {"authors": ["Ziyan Judaideen",
"James Stuessy",
"Amadeus Folego",
"Kurtis Rainbolt-Greene"
],
"copyright": "2024 Edge Payment Technologies, Inc."
}
}

List all records

SecuritybearerAuth

Request

query Parameters

filter	string filter[NAME]=value(s)
fields	string sparse fieldsets: `fields[TYPE]=field1,field2,...`
include	string list of included related resources
sort	string fields to sort by
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

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/merchants

Request samples

curl
Ruby
Python
Node.js
PHP

Response samples

application/vnd.api+json

{"data": {"attributes": {"inserted_at": "2024-06-06T21:48:33.382755Z",
"updated_at": "2024-06-06T21:48:33.382755Z"
},
"id": "b4142f90-3277-478b-b96b-ad18800376b0",
"links": { },
"relationships": { },
"type": "merchants"
},
"links": { },
"meta": {"authors": ["Ziyan Judaideen",
"James Stuessy",
"Amadeus Folego",
"Kurtis Rainbolt-Greene"
],
"copyright": "2024 Edge Payment Technologies, Inc."
}
}

A list of related customers

SecuritybearerAuth

Request

path Parameters

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	string list of included related resources
sort	string fields to sort by
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

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/merchants/{id}/relationships/customers

Request samples

curl
Ruby
Python
Node.js
PHP

Response samples

application/vnd.api+json

{"data": {"attributes": {"inserted_at": "2024-06-06T21:48:33.382755Z",
"updated_at": "2024-06-06T21:48:33.382755Z"
},
"id": "5f3621b1-2399-477b-b6d0-ec02f6e4a920",
"links": { },
"relationships": { },
"type": "customers"
},
"links": { },
"meta": {"authors": ["Ziyan Judaideen",
"James Stuessy",
"Amadeus Folego",
"Kurtis Rainbolt-Greene"
],
"copyright": "2024 Edge Payment Technologies, Inc."
}
}

Fetch by unique id

SecuritybearerAuth

Request

path Parameters

required

string <uuid> (id)

the identifier of the record

query Parameters

fields	string sparse fieldsets: `fields[TYPE]=field1,field2,...`
include	string list of included related resources

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

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/merchants/{id}

Request samples

curl
Ruby
Python
Node.js
PHP

Response samples

application/vnd.api+json

{"data": {"attributes": {"inserted_at": "2024-06-06T21:48:33.382755Z",
"updated_at": "2024-06-06T21:48:33.382755Z"
},
"id": "2f1669fc-79a3-4eb5-84cb-20649396b239",
"links": { },
"relationships": { },
"type": "merchants"
},
"links": { },
"meta": {"authors": ["Ziyan Judaideen",
"James Stuessy",
"Amadeus Folego",
"Kurtis Rainbolt-Greene"
],
"copyright": "2024 Edge Payment Technologies, Inc."
}
}

A list of related payment_methods

SecuritybearerAuth

Request

path Parameters

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	string list of included related resources
sort	string fields to sort by
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

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/merchants/{id}/relationships/payment_methods

Request samples

curl
Ruby
Python
Node.js
PHP

Response samples

application/vnd.api+json

{"data": {"attributes": {"inserted_at": "2024-06-06T21:48:33.382755Z",
"updated_at": "2024-06-06T21:48:33.382755Z"
},
"id": "3c19668a-9ad1-427b-a9e8-d35afb1d4ae0",
"links": { },
"relationships": { },
"type": "payment_methods"
},
"links": { },
"meta": {"authors": ["Ziyan Judaideen",
"James Stuessy",
"Amadeus Folego",
"Kurtis Rainbolt-Greene"
],
"copyright": "2024 Edge Payment Technologies, Inc."
}
}

➔ Next to Permissions