Payment Methods

Related to payment methods

Delete 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.

delete/v2/payment_methods/{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": "1603a479-f172-44c9-9c57-8fe0bbade7ea",
"links": { },
"relationships": { },
"type": "payment_methods"
},
"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/payment_methods/{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": "1603a479-f172-44c9-9c57-8fe0bbade7ea",
"links": { },
"relationships": { },
"type": "payment_methods"
},
"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/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": "8f47f725-c7a8-4352-82df-6f8fc663f18d",
"links": { },
"relationships": { },
"type": "payment_methods"
},
"links": { },
"meta": {"authors": ["Ziyan Judaideen",
"James Stuessy",
"Amadeus Folego",
"Kurtis Rainbolt-Greene"
],
"copyright": "2024 Edge Payment Technologies, Inc."
}
}

Fetch related customer

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

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

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": "24725613-da19-4d1f-ad60-72383454e221",
"links": { },
"relationships": { },
"type": "customers"
},
"links": { },
"meta": {"authors": ["Ziyan Judaideen",
"James Stuessy",
"Amadeus Folego",
"Kurtis Rainbolt-Greene"
],
"copyright": "2024 Edge Payment Technologies, Inc."
}
}

Fetch related merchant

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

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

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": "293574f9-6a60-417e-9732-a3215ab0e56e",
"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_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/payment_methods/{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": "e1f9fbee-740a-4f91-a280-050ce67591cc",
"links": { },
"relationships": { },
"type": "payment_demands"
},
"links": { },
"meta": {"authors": ["Ziyan Judaideen",
"James Stuessy",
"Amadeus Folego",
"Kurtis Rainbolt-Greene"
],
"copyright": "2024 Edge Payment Technologies, Inc."
}
}

Fetch related address

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

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

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": "86d1be3b-29d8-4ae6-8c7d-531f610359e7",
"links": { },
"relationships": { },
"type": "consumer_addresses"
},
"links": { },
"meta": {"authors": ["Ziyan Judaideen",
"James Stuessy",
"Amadeus Folego",
"Kurtis Rainbolt-Greene"
],
"copyright": "2024 Edge Payment Technologies, Inc."
}
}

➔ Next to Beneficial Owners