Get all API keys for the current user
Authorizations:
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 100 ] Default: 100 PaginationLimit |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "expiration": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_used": null,
- "name": "string",
- "permissions": [
- "string"
]
}
], - "total_results": 0
}
Create a new API key
Authorizations:
Request Body schema: application/json
name required | string SafeString |
Responses
Request samples
- Payload
{- "name": "string"
}
Response samples
- 201
{- "expiration": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "key": null,
- "last_used": null,
- "name": "string",
- "permissions": [
- "string"
]
}
Verify user
This verifies the ownership of an email by sending the token received, along with the password to set for the account.
Request Body schema: application/json
email required | string |
password required | string SafeString |
token required | string SafeString |
Responses
Request samples
- Payload
{- "email": "string",
- "password": "string",
- "token": "string"
}
Response samples
- 200
{- "access_token": "string",
- "user": {
- "active": true,
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_seen": null,
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9"
}
}
Forgot user password
For a registered user, this sends a token to the email address which can be used to reset the password. This endpoint is only applicable to users whose account currently contains a password, and cannot be used for web3 accounts.
Request Body schema: application/json
email required | string |
Responses
Request samples
- Payload
{- "email": "string"
}
Change user password
Authorizations:
Request Body schema: application/json
new_password required | string SafeString |
old_password required | string SafeString |
Responses
Request samples
- Payload
{- "new_password": "string",
- "old_password": "string"
}
Response samples
- 200
{- "access_token": "string",
- "user": {
- "active": true,
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_seen": null,
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9"
}
}
Reset user password
This resets the user's password from a token received in an email.
Request Body schema: application/json
password required | string SafeString |
token required | string SafeString |
Responses
Request samples
- Payload
{- "password": "string",
- "token": "string"
}
Response samples
- 200
{- "access_token": "string",
- "user": {
- "active": true,
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_seen": null,
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9"
}
}
Log in user
Request Body schema: application/json
email required | string |
password required | string SafeString |
Responses
Request samples
- Payload
{- "email": "string",
- "password": "string"
}
Response samples
- 200
{- "access_token": "string",
- "user": {
- "active": true,
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_seen": null,
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9"
}
}
Response samples
- 200
{- "organization": {
- "auth0_id": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_enabled": true,
- "mfa_required": true,
- "name": "string",
- "network_ids": [
- 0
], - "stripe_connect_types": [
- "string"
]
}, - "permissions": [
- "string"
], - "user": {
- "active": true,
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "last_seen": null,
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9"
}
}
Get all collections
Authorizations:
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 100 ] Default: 100 PaginationLimit |
name | string Default: null SafeString |
contract_address | string Default: null ChecksumAddress |
token_type | string Default: null Enum: "ERC721" "ERC1155" null |
network_id | integer <int32> Default: null |
order_by | string Default: "NAME" Enum: "NAME" null |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "default_item_type_id": null,
- "deployment": null,
- "functions_enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image_url": null,
- "name": "string",
- "preview_metadata": null,
- "reveal_hidden": true,
- "reveal_strategy": null,
- "royalty_info": null
}
], - "total_results": 0
}
Create a new collection
Authorizations:
Request Body schema: application/json
default_item_type_id | string or null <uuid> Default: null |
object or null Default: null | |
image_url | string or null Default: null SafeString |
name required | string SafeString |
preview_metadata | object or null Default: null |
reveal_strategy | string or null Default: null |
Responses
Request samples
- Payload
{- "default_item_type_id": null,
- "deployment_request": null,
- "image_url": null,
- "name": "string",
- "preview_metadata": null,
- "reveal_strategy": null
}
Response samples
- 201
{- "default_item_type_id": null,
- "deployment": null,
- "functions_enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image_url": null,
- "name": "string",
- "preview_metadata": null,
- "reveal_hidden": true,
- "reveal_strategy": null,
- "royalty_info": null
}
Get a collection by id
Authorizations:
path Parameters
collection_id required | string <uuid> |
Responses
Response samples
- 200
{- "default_item_type_id": null,
- "deployment": null,
- "functions_enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image_url": null,
- "name": "string",
- "preview_metadata": null,
- "reveal_hidden": true,
- "reveal_strategy": null,
- "royalty_info": null
}
Edit a collection
This is a partial update, only attributes present will be updated.
Authorizations:
path Parameters
collection_id required | string <uuid> |
Request Body schema: application/json
default_item_type_id | string or null <uuid> Default: null |
functions_enabled | boolean or null Default: false |
image_url | string or null Default: null SafeString |
name | string or null Default: null SafeString |
preview_metadata | object or null Default: null |
reveal_hidden | boolean or null Default: false |
object or null Default: null |
Responses
Request samples
- Payload
{- "default_item_type_id": null,
- "functions_enabled": false,
- "image_url": null,
- "name": null,
- "preview_metadata": null,
- "reveal_hidden": false,
- "royalty_info": null
}
Response samples
- 200
{- "default_item_type_id": null,
- "deployment": null,
- "functions_enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image_url": null,
- "name": "string",
- "preview_metadata": null,
- "reveal_hidden": true,
- "reveal_strategy": null,
- "royalty_info": null
}
Submit a request to deploy a contract for the collection.
Authorizations:
path Parameters
collection_id required | string <uuid> |
Request Body schema: application/json
object or null Default: null | |
object or null Default: null | |
network_id required | integer <int32> |
object or null Default: null | |
token_id_assignment_strategy | string or null Default: null |
type required | string |
Responses
Request samples
- Payload
{- "custom": null,
- "external": null,
- "network_id": 0,
- "platform": null,
- "token_id_assignment_strategy": null,
- "type": "string"
}
Response samples
- 200
{- "status": "PENDING",
- "transaction_id": null
}
Get contract functions defined on a collection contract
Authorizations:
path Parameters
collection_id required | string <uuid> |
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 100 ] Default: 100 PaginationLimit |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "abi": {
- "property1": null,
- "property2": null
}, - "enabled": true,
- "id": "string"
}
], - "total_results": 0
}
Get a contract function by collection and function id
Authorizations:
path Parameters
collection_id required | string <uuid> |
function_id required | string |
Responses
Response samples
- 200
{- "abi": {
- "property1": null,
- "property2": null
}, - "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Enable a collection contract function to be callable
Authorizations:
path Parameters
collection_id required | string <uuid> |
function_id required | string |
Request Body schema: application/json
enabled required | boolean |
Responses
Request samples
- Payload
{- "enabled": true
}
Response samples
- 200
{- "contract_func": {
- "abi": {
- "property1": null,
- "property2": null
}, - "enabled": true,
- "id": "string"
}
}
Read from a contract function by collection and function id
Authorizations:
path Parameters
collection_id required | string <uuid> |
function_id required | string |
Request Body schema: application/json
arguments required | Array of any or null |
Responses
Request samples
- Payload
{- "arguments": [
- null
]
}
Response samples
- 201
{- "result": null
}
Execute a contract function by collection and function id
Authorizations:
path Parameters
collection_id required | string <uuid> |
function_id required | string |
Request Body schema: application/json
arguments required | Array of any or null |
Responses
Request samples
- Payload
{- "arguments": [
- null
]
}
Response samples
- 201
{- "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482"
}
Verify capabilities for a token contract
The contract must have one of the following capabilities:
ERC721
ERC1155
Otherwise, the contract will be rejected.
In order to be able to mint items through the platform, the contract should have one of the following capabilities:
ADMIN_MINT_SINGLE
(for ERC721)MINT_VOUCHER
(for ERC721)ADMIN_MINT_SINGLE_URI
(for ERC721)ADMIN_MINT_MULTIPLE_NO_ID
(for ERC721)ADMIN_MINT_MULTIPLE
(for ERC1155)
Capabilities are determined by the contract's ABI. You can get the known capabilities ABIs from the public capabilities
endpoint.
Authorizations:
Request Body schema: application/json
abi required | Array of any or null |
bytecode required | string HexString |
constructor_args required | Array of any or null |
token_type | string or null Default: null |
Responses
Request samples
- Payload
{- "abi": [
- null
], - "bytecode": "string",
- "constructor_args": [
- null
], - "token_type": null
}
Response samples
- 200
{- "capabilities": [
- "string"
]
}
Get all email claims
Authorizations:
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 1000 ] Default: 100 MediumPaginationLimit |
collection_ids | Array of strings <uuid> Default: null |
item_ids | Array of strings <uuid> Default: null |
token_ids | Array of strings Default: null |
string Default: null | |
claimed | boolean Default: null |
active | boolean Default: null |
order_by | string Default: null Enum: "CREATED_AT" "EXPIRATION" "CLAIMED_AT" null |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "active": true,
- "claimed": true,
- "claimed_at": null,
- "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "expiration": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
- "last_pin_code_email_sent_at": null,
- "quantity": 0,
- "token_id": "string",
- "tx_hash": null,
- "tx_payer": "string",
- "voucher_id": "1b5a607b-e5eb-4b17-80b0-5739c041e81b"
}
], - "total_results": 0
}
Create a new email claim
Authorizations:
Request Body schema: application/json
email required | string |
item_id required | string <uuid> |
quantity required | integer <int32> |
tx_payer | string or null Default: "SELLER" |
type | string or null Default: null |
Responses
Request samples
- Payload
{- "email": "string",
- "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
- "quantity": 0,
- "tx_payer": "SELLER",
- "type": null
}
Response samples
- 201
{- "active": true,
- "claimed": true,
- "claimed_at": null,
- "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "expiration": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
- "last_pin_code_email_sent_at": null,
- "quantity": 0,
- "token_id": "string",
- "tx_hash": null,
- "tx_payer": "string",
- "voucher_id": "1b5a607b-e5eb-4b17-80b0-5739c041e81b"
}
Get email claim by id
Authorizations:
path Parameters
claim_id required | string <uuid> |
Responses
Response samples
- 200
{- "active": true,
- "claimed": true,
- "claimed_at": null,
- "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "expiration": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
- "last_pin_code_email_sent_at": null,
- "quantity": 0,
- "token_id": "string",
- "tx_hash": null,
- "tx_payer": "string",
- "voucher_id": "1b5a607b-e5eb-4b17-80b0-5739c041e81b"
}
Resends an email claim with the given id.
Authorizations:
path Parameters
claim_id required | string <uuid> |
Request Body schema: application/json
string or null Default: null |
Responses
Request samples
- Payload
{- "email": null
}
Response samples
- 200
{- "active": true,
- "claimed": true,
- "claimed_at": null,
- "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "expiration": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
- "last_pin_code_email_sent_at": null,
- "quantity": 0,
- "token_id": "string",
- "tx_hash": null,
- "tx_payer": "string",
- "voucher_id": "1b5a607b-e5eb-4b17-80b0-5739c041e81b"
}
Get all email integration configs for an organization
Authorizations:
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 100 ] Default: 100 PaginationLimit |
provider | string Default: null SafeString |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "config": {
- "property1": null,
- "property2": null
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "provider": "string"
}
], - "total_results": 0
}
Create a new organization email config
Authorizations:
Request Body schema: application/json
required | object |
provider required | string |
Responses
Request samples
- Payload
{- "config": {
- "property1": null,
- "property2": null
}, - "provider": "string"
}
Response samples
- 201
{- "config": {
- "property1": null,
- "property2": null
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "provider": "string"
}
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "html": "string",
- "origin_type": "string",
- "subject": "string",
- "template_type": "string",
- "unlayer_embed_design_json": null
}
], - "total_results": 0
}
Gets a specific customizable email template.
Authorizations:
path Parameters
template_type required | string Enum: "USER_INVITE" "FORGOT_PASSWORD_RESET" "REDEEM_NFT" "CLAIM_PINCODE" "CLAIMED_NFT" "USER_TEST" |
Responses
Response samples
- 200
{- "html": "string",
- "origin_type": "string",
- "subject": "string",
- "template_type": "string",
- "unlayer_embed_design_json": null
}
Update a specific email template.
Authorizations:
path Parameters
template_type required | string Enum: "USER_INVITE" "FORGOT_PASSWORD_RESET" "REDEEM_NFT" "CLAIM_PINCODE" "CLAIMED_NFT" "USER_TEST" |
Request Body schema: application/json
html required | string SafeString |
subject required | string SafeString |
object or null Default: null |
Responses
Request samples
- Payload
{- "html": "string",
- "subject": "string",
- "unlayer_embed_design_json": null
}
Response samples
- 200
{- "html": "string",
- "origin_type": "string",
- "subject": "string",
- "template_type": "string",
- "unlayer_embed_design_json": null
}
Create a new email template.
Authorizations:
path Parameters
template_type required | string Enum: "USER_INVITE" "FORGOT_PASSWORD_RESET" "REDEEM_NFT" "CLAIM_PINCODE" "CLAIMED_NFT" "USER_TEST" |
Request Body schema: application/json
html required | string SafeString |
subject required | string SafeString |
object or null Default: null |
Responses
Request samples
- Payload
{- "html": "string",
- "subject": "string",
- "unlayer_embed_design_json": null
}
Response samples
- 201
{- "html": "string",
- "origin_type": "string",
- "subject": "string",
- "template_type": "string",
- "unlayer_embed_design_json": null
}
Creates and sends a new test mail.
Authorizations:
path Parameters
template_type required | string Enum: "USER_INVITE" "FORGOT_PASSWORD_RESET" "REDEEM_NFT" "CLAIM_PINCODE" "CLAIMED_NFT" "USER_TEST" |
Request Body schema: application/json
html required | string SafeString |
subject required | string SafeString |
required | Array of objects |
Responses
Request samples
- Payload
{- "html": "string",
- "subject": "string",
- "variables": [
- {
- "default_value": null,
- "name": "string",
- "template_type": "string",
- "value": null
}
]
}
Get variables for a specific template.
Authorizations:
path Parameters
template_type required | string Enum: "USER_INVITE" "FORGOT_PASSWORD_RESET" "REDEEM_NFT" "CLAIM_PINCODE" "CLAIMED_NFT" "USER_TEST" |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "default_value": null,
- "name": "string",
- "template_type": "string",
- "value": null
}
], - "total_results": 0
}
Gets all item types for the organization of a specific organization ID (if supplied), or the calling user.
Only organization or platform admins have access to this data. If no organization ID is supplied, platform admins will get all item types. If no organization ID is supplied, an org admin will get the item types of his organization.
Authorizations:
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 100 ] Default: 100 PaginationLimit |
organization_id | string <uuid> Default: null |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "json_schema": {
- "property1": null,
- "property2": null
}, - "name": "string",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}
], - "total_results": 0
}
Create a new item type for an organization.
If not supplied, the organization of the requesting user is used.
Authorizations:
Request Body schema: application/json
required | object |
name required | string SafeString |
organization_id | string or null <uuid> Default: null |
Responses
Request samples
- Payload
{- "json_schema": {
- "property1": null,
- "property2": null
}, - "name": "string",
- "organization_id": null
}
Response samples
- 201
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "json_schema": {
- "property1": null,
- "property2": null
}, - "name": "string",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}
Get the meta schema (+example) which is used to validate an item type schema.
Only organization or platform admins have access to this data.
Authorizations:
Responses
Response samples
- 200
{- "example_json_schema": {
- "property1": null,
- "property2": null
}, - "meta_json_schema": {
- "property1": null,
- "property2": null
}
}
Get a specific item type for an organization.
Authorizations:
path Parameters
item_type_id required | string <uuid> |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "json_schema": {
- "property1": null,
- "property2": null
}, - "name": "string",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}
Edits an existing item type for an organization.
Authorizations:
path Parameters
item_type_id required | string <uuid> |
Request Body schema: application/json
required | object |
name required | string SafeString |
Responses
Request samples
- Payload
{- "json_schema": {
- "property1": null,
- "property2": null
}, - "name": "string"
}
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "json_schema": {
- "property1": null,
- "property2": null
}, - "name": "string",
- "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}
Get all items associated with this collection
Authorizations:
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 1000 ] Default: 100 MediumPaginationLimit |
collection_id required | string <uuid> |
token_id | string Default: null Uint256 |
attributes | Array of strings Default: null |
locked | boolean Default: null |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "attributes": {
- "property1": null,
- "property2": null
}, - "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_type_id": null,
- "locked": true,
- "max_supply": null,
- "media": {
- "image": null
}, - "royalty_info": null,
- "token_id": null,
- "token_status": "string"
}
], - "total_results": 0
}
Create a new item associated with the given collection
Authorizations:
Request Body schema: application/json
required | object |
collection_id required | string <uuid> |
item_type_id | string or null <uuid> Default: null |
Responses
Request samples
- Payload
{- "attributes": {
- "property1": null,
- "property2": null
}, - "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
- "item_type_id": null
}
Response samples
- 201
{- "attributes": {
- "property1": null,
- "property2": null
}, - "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_type_id": null,
- "locked": true,
- "max_supply": null,
- "media": {
- "image": null
}, - "royalty_info": null,
- "token_id": null,
- "token_status": "string"
}
Create a bulk set of items associated with the given collection
Authorizations:
Request Body schema: application/json
required | Array of objects | ||||||
Array
|
Responses
Request samples
- Payload
{- "items": [
- {
- "attributes": {
- "property1": null,
- "property2": null
}, - "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
- "item_type_id": null
}
]
}
Response samples
- 201
{- "item_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Request the lock of one or more items.
There are three ways to specify the items to lock. When specifying individual items, they should all be unlocked, else the request will fail.
item_id
- Locks a single itemitem_ids
- Locks a list of items by their ids.collection_id
- Locks all remaining unlocked items in a collection.
For the max_supply
parameter:
- (for
ERC721's
) it should always be 1. If not specified, then it will be coerced to 1. - (for
ERC1155's
) it should be greater than 0. If not specified, then it will be coerced to the max value of a web3 uint256.
For the token_id
parameter:
- This can only be done for a single item and if the token assignment strategy of the collection is set to
MANUAL
. - If left out, the token assignment strategy of the collection should be set to either
AUTOMATIC
orEXTERNAL
.
Once an item has been locked the following actions will be available:
- Listing
- Minting
- Transferring
- Sending via an email claim
Authorizations:
Request Body schema: application/json
collection_id | string or null <uuid> Default: null |
item_id | string or null <uuid> Default: null |
item_ids | Array of strings or null <uuid> Default: null |
max_supply | string or null Default: null Uint256 |
token_id | string or null Default: null Uint256 |
Responses
Request samples
- Payload
{- "collection_id": null,
- "item_id": null,
- "item_ids": null,
- "max_supply": null,
- "token_id": null
}
Response samples
- 201
{- "lock_outputs": [
- {
- "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
- "max_supply": null,
- "token_id": "string"
}
]
}
Response samples
- 200
{- "attributes": {
- "property1": null,
- "property2": null
}, - "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_type_id": null,
- "locked": true,
- "max_supply": null,
- "media": {
- "image": null
}, - "royalty_info": null,
- "token_id": null,
- "token_status": "string"
}
Update an item
This is a full update -- all attributes specified will overwrite ALL existing attributes and item-type specific attributes must be valid against the item type schema. (if any) Attributes cannot be updated once an item has been minted.
Authorizations:
path Parameters
item_id required | string <uuid> |
Request Body schema: application/json
object or null Default: null | |
item_type_id | string or null <uuid> Default: null |
object or null Default: null |
Responses
Request samples
- Payload
{- "attributes": null,
- "item_type_id": null,
- "royalty_info": null
}
Response samples
- 200
{- "attributes": {
- "property1": null,
- "property2": null
}, - "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_type_id": null,
- "locked": true,
- "max_supply": null,
- "media": {
- "image": null
}, - "royalty_info": null,
- "token_id": null,
- "token_status": "string"
}
Get an item's status by id
Authorizations:
path Parameters
item_id required | string <uuid> |
Responses
Response samples
- 200
{- "email_claim_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "listing_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "mint_request_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "reservations": {
- "mint": 0,
- "transfer": 0
}, - "supply": {
- "current": "string",
- "total": "string"
}, - "transfer_request_ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Get paginated item mint request details.
Authorizations:
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 1000 ] Default: 100 MediumPaginationLimit |
item_id | string <uuid> Default: null |
collection_id | string <uuid> Default: null |
to_address | string Default: null ChecksumAddress |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
- "quantity": "string",
- "state": "string",
- "to_address": "string",
- "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
- "tx_hash": null
}
], - "total_results": 0
}
Request the mint of one or more items.
This submits a request to mint one or more items and returns the transaction details on the newly created requests. There are five ways to specify the items to mint:
item_id
- Mint a single itemitem_ids
- Mint a list of items by their ids.collection_id
- Mint all locked and un-minted items in a collection. Reserved items (email claims, listings) will not be considered when minting.collection_id
&token_ids
- Mint a list of items by their token ids.collection_id
&token_ranges
- Mint a list of items by token ranges.
All items must be locked and not currently minted, else the request will fail.
When minting, a to_address
must be specified. This is the address that will receive the newly minted items.
There is currently a limit of 100 items that can be minted at once. When passing a set of individual item identifiers, the request will fail if you attempt to submit more than 100 items. When passing collection_id
, only the first 100 will be considered. If you need to mint more than 100 items, you will need to make multiple requests.
Authorizations:
Request Body schema: application/json
collection_id | string or null <uuid> Default: null |
item_id | string or null <uuid> Default: null |
item_ids | Array of strings or null <uuid> Default: null |
quantity | string or null Default: null Uint256 |
to_address required | string ChecksumAddress |
token_ids | Array of strings or null Default: null |
Array of objects or null Default: null |
Responses
Request samples
- Payload
{- "collection_id": null,
- "item_id": null,
- "item_ids": null,
- "quantity": null,
- "to_address": "string",
- "token_ids": null,
- "token_ranges": null
}
Response samples
- 201
{- "mint_requests": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
- "quantity": "string",
- "state": "string",
- "to_address": "string",
- "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
- "tx_hash": null
}
]
}
Get the item mint request details.
Authorizations:
path Parameters
id required | string <uuid> |
Responses
Response samples
- 200
{- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
- "quantity": "string",
- "state": "string",
- "to_address": "string",
- "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
- "tx_hash": null
}
Get the item transfer request transaction details.
Authorizations:
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 1000 ] Default: 100 MediumPaginationLimit |
item_id | string <uuid> Default: null |
collection_id | string <uuid> Default: null |
to_address | string Default: null ChecksumAddress |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
- "quantity": 0,
- "state": "string",
- "to_address": "string",
- "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
- "tx_hash": null
}
], - "total_results": 0
}
Request the transfer of one or more items.
This submits a request to transfer one or more items and returns the transaction details on the newly created requests. There are five ways to specify the items to transfer:
item_id
- Transfers a single itemitem_ids
- Transfers a list of items by their ids.collection_id
- Transfers all locked and minted items in a collection. Reserved items (email claims, listings) will not be considered when transferring.collection_id
&token_ids
- Transfers a list of items by their token ids.collection_id
&token_ranges
- Transfers a list of items by token ranges.
All items must be locked and minted, else the request will fail.
When transferring, a to_address
must be specified. This is the address that will receive the items.
There is currently a limit of 100 items that can be transferred at once. When passing a set of individual item identifiers, the request will fail if you attempt to submit more than 100 items. When passing collection_id
, only the first 100 will be considered. If you need to transfer more than 100 items, you will need to make multiple requests.
Authorizations:
Request Body schema: application/json
collection_id | string or null <uuid> Default: null |
item_id | string or null <uuid> Default: null |
item_ids | Array of strings or null <uuid> Default: null |
quantity | string or null Default: null Uint256 |
to_address required | string ChecksumAddress |
token_ids | Array of strings or null Default: null |
Array of objects or null Default: null |
Responses
Request samples
- Payload
{- "collection_id": null,
- "item_id": null,
- "item_ids": null,
- "quantity": null,
- "to_address": "string",
- "token_ids": null,
- "token_ranges": null
}
Response samples
- 201
{- "transfer_requests": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
- "quantity": 0,
- "state": "string",
- "to_address": "string",
- "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
- "tx_hash": null
}
]
}
Get the item transfer request transaction details.
Authorizations:
path Parameters
id required | string <uuid> |
Responses
Response samples
- 200
{- "created_at": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
- "quantity": 0,
- "state": "string",
- "to_address": "string",
- "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
- "tx_hash": null
}
Get Listings
Authorizations:
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 1000 ] Default: 100 MediumPaginationLimit |
item_id | string <uuid> Default: null |
collection_id | string <uuid> Default: null |
status | string Default: null Enum: "ACTIVE" "CANCELLED" "COMPLETE" "PENDING_TX" null |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "collection_id": null,
- "currency": "string",
- "end_time": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_id": null,
- "max_quantity_per_tx": 0,
- "payment_providers": [
- "string"
], - "policy": null,
- "price": "string",
- "quantity_listed": 0,
- "quantity_remaining": 0,
- "sale_type": "string",
- "start_time": null,
- "status": "string"
}
], - "total_results": 0
}
Create new Listing
Authorizations:
Request Body schema: application/json
collection_id | string or null <uuid> Default: null |
currency required | string |
end_time | string or null <date-time> Default: null UtcDateTime |
item_id | string or null <uuid> Default: null |
item_ids | Array of strings or null <uuid> Default: null |
max_quantity_per_tx required | integer <int32> |
payment_providers required | Array of strings |
required | object |
price required | string Uint256 |
quantity_listed | integer or null <int32> Default: null |
start_time | string or null <date-time> Default: null UtcDateTime |
token_ids | Array of strings or null Default: null |
Array of objects or null Default: null |
Responses
Request samples
- Payload
{- "collection_id": null,
- "currency": "string",
- "end_time": null,
- "item_id": null,
- "item_ids": null,
- "max_quantity_per_tx": 0,
- "payment_providers": [
- "string"
], - "policy": {
- "email_addresses": null,
- "email_claim_duration": null,
- "eth_addresses": null,
- "item_assignment_strategy": null,
- "max_per_user": null,
- "payment_session_duration": null,
- "snapshot_id": null,
- "tx_payer": "SELLER",
- "type": "FCFS"
}, - "price": "string",
- "quantity_listed": null,
- "start_time": null,
- "token_ids": null,
- "token_ranges": null
}
Response samples
- 201
{- "collection_id": null,
- "currency": "string",
- "end_time": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_id": null,
- "max_quantity_per_tx": 0,
- "payment_providers": [
- "string"
], - "policy": null,
- "price": "string",
- "quantity_listed": 0,
- "quantity_remaining": 0,
- "sale_type": "string",
- "start_time": null,
- "status": "string"
}
Get Listing by id
Authorizations:
path Parameters
listing_id required | string <uuid> |
Responses
Response samples
- 200
{- "collection_id": null,
- "currency": "string",
- "end_time": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_id": null,
- "max_quantity_per_tx": 0,
- "payment_providers": [
- "string"
], - "policy": null,
- "price": "string",
- "quantity_listed": 0,
- "quantity_remaining": 0,
- "sale_type": "string",
- "start_time": null,
- "status": "string"
}
Edit Listing
Authorizations:
path Parameters
listing_id required | string <uuid> |
Request Body schema: application/json
end_time | string or null <date-time> Default: null UtcDateTime |
object or null Default: null | |
start_time | string or null <date-time> Default: null UtcDateTime |
Responses
Request samples
- Payload
{- "end_time": null,
- "policy": null,
- "start_time": null
}
Response samples
- 200
{- "collection_id": null,
- "currency": "string",
- "end_time": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_id": null,
- "max_quantity_per_tx": 0,
- "payment_providers": [
- "string"
], - "policy": null,
- "price": "string",
- "quantity_listed": 0,
- "quantity_remaining": 0,
- "sale_type": "string",
- "start_time": null,
- "status": "string"
}
Get all purchase intents for an organization
Authorizations:
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 1000 ] Default: 100 MediumPaginationLimit |
item_id | string <uuid> Default: null |
collection_id | string <uuid> Default: null |
listing_id | string <uuid> Default: null |
status | Array of strings Default: null Items Enum: "PENDING" "UNRESOLVED" "CANCELLED" "CONFIRMED" "EXPIRED" |
string Default: null | |
eth_address | string Default: null ChecksumAddress |
fulfillment_status | Array of strings Default: null Items Enum: "PENDING" "ASSIGNED" "COMPLETED" "EXCEPTION" |
fulfillment_method | Array of strings Default: null Items Enum: "EMAIL" "TRANSFER" "VOUCHER" |
payment_provider | Array of strings Default: null Items Enum: "STRIPE" "COINBASE" "MINT_VOUCHER" "EMAIL_CLAIM" |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "coinbase_charge_id": null,
- "created_at": "2019-08-24T14:15:22Z",
- "email": null,
- "eth_address": null,
- "expiration": "2019-08-24T14:15:22Z",
- "fulfillment_method": "string",
- "fulfillment_status": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_claim_ids": null,
- "listing_id": "5322d4a9-51d2-4408-82fb-01ffecfb8304",
- "payment_provider": "string",
- "provider_price": {
- "property1": null,
- "property2": null
}, - "status": "string",
- "stripe_payment_intent_id": null,
- "transaction_ids": null
}
], - "total_results": 0
}
Get purchase intent by id
Authorizations:
path Parameters
purchase_intent_id required | string <uuid> |
Responses
Response samples
- 200
{- "coinbase_charge_id": null,
- "created_at": "2019-08-24T14:15:22Z",
- "email": null,
- "eth_address": null,
- "expiration": "2019-08-24T14:15:22Z",
- "fulfillment_method": "string",
- "fulfillment_status": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item_claim_ids": null,
- "listing_id": "5322d4a9-51d2-4408-82fb-01ffecfb8304",
- "payment_provider": "string",
- "provider_price": {
- "property1": null,
- "property2": null
}, - "status": "string",
- "stripe_payment_intent_id": null,
- "transaction_ids": null
}
Get the available networks
Authorizations:
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 100 ] Default: 100 PaginationLimit |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "config": {
- "autoDeploy": true,
- "autoFundAmount": "string",
- "confirmations": 0,
- "eip155": true,
- "gasStrategy": {
- "property1": null,
- "property2": null
}, - "maxConcurrentTxs": 0,
- "poa": true,
- "txResubmitBlockCount": null,
- "url": "string"
}, - "enabled": true,
- "id": 0,
- "name": "string",
- "payment_tokens": null,
- "testnet": true
}
], - "total_results": 0
}
Create a new network
Authorizations:
Request Body schema: application/json
required | object |
enabled required | boolean |
id required | number >= 0 Uint |
name required | string SafeString |
Array of objects or null Default: null | |
testnet required | boolean |
Responses
Request samples
- Payload
{- "config": {
- "autoDeploy": true,
- "autoFundAmount": "string",
- "confirmations": 0,
- "eip155": true,
- "gasStrategy": {
- "property1": null,
- "property2": null
}, - "maxConcurrentTxs": 0,
- "poa": true,
- "txResubmitBlockCount": null,
- "url": "string"
}, - "enabled": true,
- "id": 0,
- "name": "string",
- "payment_tokens": null,
- "testnet": true
}
Response samples
- 201
{- "config": {
- "autoDeploy": true,
- "autoFundAmount": "string",
- "confirmations": 0,
- "eip155": true,
- "gasStrategy": {
- "property1": null,
- "property2": null
}, - "maxConcurrentTxs": 0,
- "poa": true,
- "txResubmitBlockCount": null,
- "url": "string"
}, - "enabled": true,
- "id": 0,
- "name": "string",
- "payment_tokens": null,
- "testnet": true
}
Get a specific network
Authorizations:
path Parameters
network_id required | integer <int32> |
Responses
Response samples
- 200
{- "config": {
- "autoDeploy": true,
- "autoFundAmount": "string",
- "confirmations": 0,
- "eip155": true,
- "gasStrategy": {
- "property1": null,
- "property2": null
}, - "maxConcurrentTxs": 0,
- "poa": true,
- "txResubmitBlockCount": null,
- "url": "string"
}, - "enabled": true,
- "id": 0,
- "name": "string",
- "payment_tokens": null,
- "testnet": true
}
Edit a specific network
Authorizations:
path Parameters
network_id required | integer <int32> |
Request Body schema: application/json
object or null Default: null | |
enabled | boolean or null Default: null |
name | string or null Default: null SafeString |
testnet | boolean or null Default: null |
Responses
Request samples
- Payload
{- "config": null,
- "enabled": null,
- "name": null,
- "testnet": null
}
Response samples
- 200
{- "config": {
- "autoDeploy": true,
- "autoFundAmount": "string",
- "confirmations": 0,
- "eip155": true,
- "gasStrategy": {
- "property1": null,
- "property2": null
}, - "maxConcurrentTxs": 0,
- "poa": true,
- "txResubmitBlockCount": null,
- "url": "string"
}, - "enabled": true,
- "id": 0,
- "name": "string",
- "payment_tokens": null,
- "testnet": true
}
Returns all tokens of specified network id
Authorizations:
path Parameters
network_id required | integer <int32> |
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 100 ] Default: 100 PaginationLimit |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- null
], - "total_results": 0
}
/v1/networks/{network_id}/payment-tokens
Authorizations:
path Parameters
network_id required | integer <int32> |
Request Body schema: application/json
address required | string ChecksumAddress |
eth | boolean or null Default: false |
eur_stablecoin | boolean or null Default: false |
usd_stablecoin | boolean or null Default: false |
Responses
Request samples
- Payload
{- "address": "string",
- "eth": false,
- "eur_stablecoin": false,
- "usd_stablecoin": false
}
Response samples
- 201
{- "address": "string",
- "decimals": 0,
- "eth": false,
- "eur_stablecoin": false,
- "network_id": 0,
- "symbol": "string",
- "usd_stablecoin": false
}
Get all organizations the current user has access to
This will be a list of 1 for everyone except platform admins.
Authorizations:
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 100 ] Default: 100 PaginationLimit |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "auth0_id": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_enabled": true,
- "mfa_required": true,
- "name": "string",
- "network_ids": [
- 0
], - "stripe_connect_types": [
- "string"
]
}
], - "total_results": 0
}
Create a new organization
Authorizations:
Request Body schema: application/json
auto_fund | boolean or null Default: false |
domain | string or null Default: null SafeString |
hardware_wallet | boolean or null Default: false |
mfa_required | boolean or null Default: false |
name required | string SafeString |
platform_sale_fee | integer or null <int32> Default: 0 |
Responses
Request samples
- Payload
{- "auto_fund": false,
- "domain": null,
- "hardware_wallet": false,
- "mfa_required": false,
- "name": "string",
- "platform_sale_fee": 0
}
Response samples
- 201
{- "auth0_id": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_enabled": true,
- "mfa_required": true,
- "name": "string",
- "network_ids": [
- 0
], - "stripe_connect_types": [
- "string"
]
}
Get organization by id
The user must have access to the desired org.
Authorizations:
path Parameters
organization_id required | string <uuid> |
Responses
Response samples
- 200
{- "auth0_id": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_enabled": true,
- "mfa_required": true,
- "name": "string",
- "network_ids": [
- 0
], - "stripe_connect_types": [
- "string"
]
}
Edit an organization
Most fields are only editable by a platform admin.
Authorizations:
path Parameters
organization_id required | string <uuid> |
Request Body schema: application/json
is_enabled | boolean or null Default: null |
mfa_required | boolean or null Default: null |
network_ids | Array of numbers or null Default: null |
stripe_connect_types | Array of strings or null Default: null |
Responses
Request samples
- Payload
{- "is_enabled": null,
- "mfa_required": null,
- "network_ids": null,
- "stripe_connect_types": null
}
Response samples
- 200
{- "auth0_id": null,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_enabled": true,
- "mfa_required": true,
- "name": "string",
- "network_ids": [
- 0
], - "stripe_connect_types": [
- "string"
]
}
Edit an organization payout configuration
Authorizations:
path Parameters
organization_id required | string <uuid> |
Request Body schema: application/json
payout_address | string or null Default: null ChecksumAddress |
platform_sale_fee | number or null [ 0 .. 10000 ] Default: null BasisPoints |
Responses
Request samples
- Payload
{- "payout_address": null,
- "platform_sale_fee": null
}
Response samples
- 200
{- "payout_address": "string",
- "platform_sale_fee": 0
}
Get platform Stripe accounts by org
Authorizations:
path Parameters
organization_id required | string <uuid> |
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 100 ] Default: 100 PaginationLimit |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "enabled": true,
- "id": "string",
- "mode": "string",
- "name": "string",
- "publishable_key": "string"
}
], - "total_results": 0
}
Associate or dissociate platform Stripe accounts by organization
Authorizations:
path Parameters
organization_id required | string <uuid> |
platform_stripe_account_id required | string <uuid> |
Request Body schema: application/json
enabled required | boolean |
Responses
Request samples
- Payload
{- "enabled": true
}
Response samples
- 200
{- "enabled": true,
- "id": "string",
- "mode": "string",
- "name": "string",
- "publishable_key": "string"
}
Response samples
- 200
{- "account_id": "string",
- "connect_type": "string",
- "platform_stripe_account": {
- "enabled": true,
- "id": "string",
- "mode": "string",
- "name": "string",
- "publishable_key": "string"
}, - "setup_complete": true
}
Set up Stripe account
Authorizations:
Request Body schema: application/json
connect_type required | string |
platform_stripe_account_id required | string <uuid> |
return_url | string or null Default: null |
Responses
Request samples
- Payload
{- "connect_type": "string",
- "platform_stripe_account_id": "30f8e4cf-f6a0-4f62-b01b-b4cc54f0038e",
- "return_url": null
}
Response samples
- 201
{- "url": "string"
}
Get all platform Stripe accounts
Authorizations:
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 100 ] Default: 100 PaginationLimit |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "config": null,
- "fee_percentage_bps": null,
- "id": "string",
- "mode": "string",
- "name": "string",
- "publishable_key": "string",
- "session_timeout_minutes": 0,
- "stripe_account_id": "string"
}
], - "total_results": 0
}
Create a platform Stripe account
Authorizations:
Request Body schema: application/json
account_webhook_endpoint_secret | string or null Default: null |
object or null Default: null | |
connect_webhook_endpoint_secret | string or null Default: null |
fee_percentage_bps | integer or null <int32> Default: null |
mode required | string |
name required | string |
publishable_key required | string |
secret_key required | string |
session_timeout_minutes required | integer <int32> |
stripe_account_id required | string |
Responses
Request samples
- Payload
{- "account_webhook_endpoint_secret": null,
- "config": null,
- "connect_webhook_endpoint_secret": null,
- "fee_percentage_bps": null,
- "mode": "string",
- "name": "string",
- "publishable_key": "string",
- "secret_key": "string",
- "session_timeout_minutes": 0,
- "stripe_account_id": "string"
}
Response samples
- 201
{- "config": null,
- "fee_percentage_bps": null,
- "id": "string",
- "mode": "string",
- "name": "string",
- "publishable_key": "string",
- "session_timeout_minutes": 0,
- "stripe_account_id": "string"
}
Get platform Stripe account by id
Authorizations:
path Parameters
platform_stripe_account_id required | string <uuid> |
Responses
Response samples
- 200
{- "config": null,
- "fee_percentage_bps": null,
- "id": "string",
- "mode": "string",
- "name": "string",
- "publishable_key": "string",
- "session_timeout_minutes": 0,
- "stripe_account_id": "string"
}
Update platform Stripe account
Authorizations:
path Parameters
platform_stripe_account_id required | string <uuid> |
Request Body schema: application/json
account_webhook_endpoint_secret | string or null Default: null |
object or null Default: null | |
connect_webhook_endpoint_secret | string or null Default: null |
fee_percentage_bps | integer or null <int32> Default: null |
mode | string or null Default: null |
name | string or null Default: null |
publishable_key | string or null Default: null |
secret_key | string or null Default: null |
session_timeout_minutes | integer or null <int32> Default: null |
stripe_account_id | string or null Default: null |
Responses
Request samples
- Payload
{- "account_webhook_endpoint_secret": null,
- "config": null,
- "connect_webhook_endpoint_secret": null,
- "fee_percentage_bps": null,
- "mode": null,
- "name": null,
- "publishable_key": null,
- "secret_key": null,
- "session_timeout_minutes": null,
- "stripe_account_id": null
}
Response samples
- 200
{- "config": null,
- "fee_percentage_bps": null,
- "id": "string",
- "mode": "string",
- "name": "string",
- "publishable_key": "string",
- "session_timeout_minutes": 0,
- "stripe_account_id": "string"
}
Send a Stripe integration command
Authorizations:
Request Body schema: application/json
command required | string |
Responses
Request samples
- Payload
{- "command": "string"
}
Response samples
- 201
{- "account_id": "string",
- "connect_type": "string",
- "platform_stripe_account": {
- "enabled": true,
- "id": "string",
- "mode": "string",
- "name": "string",
- "publishable_key": "string"
}, - "setup_complete": true
}
Get organization wallets
Authorizations:
path Parameters
organization_id required | string <uuid> |
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 100 ] Default: 100 PaginationLimit |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "address": "string",
- "auto_fund": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_default": true,
- "name": "string"
}
], - "total_results": 0
}
Get an organization wallet
Authorizations:
path Parameters
organization_id required | string <uuid> |
organization_wallet_id required | string <uuid> |
Responses
Response samples
- 200
{- "address": "string",
- "auto_fund": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_default": true,
- "name": "string"
}
Get the organization wallet balance per network
Authorizations:
path Parameters
organization_id required | string <uuid> |
organization_wallet_id required | string <uuid> |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true,
- "results": [
- {
- "balance": "string",
- "network_id": 0
}
], - "total_results": 0
}
Get platform wallets
Authorizations:
query Parameters
order_direction | string Default: null Enum: "ASC" "DESC" null |
cursor | string Default: null SafeString |
limit | number [ 1 .. 100 ] Default: 100 PaginationLimit |
Responses
Response samples
- 200
{- "cursor": null,
- "has_more": true