Accounts

name

string · required

Account name in Fluxis database

external_id

string

Account external ID

Create account › Responses

Created

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Get notification email

GET

https://api.fluxis.us/v1

/account/notification-email/{accountId}

x-fluxis-api-key (header)

+Authorization (header)

Get the sales-notification email and switch for an account. notification_email is null when unset. sales_notifications_enabled is true when the switch has never been stored.

Get notification email › path Parameters

accountId

string · required

Account ID

Get notification email › Responses

SetNotificationEmailRequest

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Set notification email

PUT

https://api.fluxis.us/v1

/account/notification-email/{accountId}

x-fluxis-api-key (header)

+Authorization (header)

Partially update the sales-notification email and switch. Omit a field to leave it unchanged. Null or empty notification_email clears the address without disabling sends. Set sales_notifications_enabled to false to stop merchant sale emails.

Set notification email › path Parameters

accountId

string · required

Account ID

Set notification email › Request Body

notification_email

string

Address notified when a payment is credited. Omit to leave unchanged. Null or empty clears it.

sales_notifications_enabled

boolean

When false, completed, overpaid, and underpaid merchant sale emails are not sent. Omit or null to leave unchanged. A missing stored value stays true.

Set notification email › Responses

APIResponseSchema-GetAccountSettlementAddressesResponseSchema

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Get settlement addresses

GET

https://api.fluxis.us/v1

/account/settlement/{accountID}/settlement-addresses

x-fluxis-api-key (header)

+Authorization (header)

Get the settlement addresses for an account

Get settlement addresses › path Parameters

accountID

string · required

Account ID

Get settlement addresses › Responses

AccountUpdateSettlementAddressRequestSchema

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Update settlement addresses

PUT

https://api.fluxis.us/v1

/account/settlement/{accountID}/settlement-addresses

x-fluxis-api-key (header)

+Authorization (header)

Update the settlement addresses for an account

Update settlement addresses › path Parameters

accountID

string · required

Account ID

Update settlement addresses › Request Body

address

string · required

Address of the settlement address

network

string · required

Network of the settlement address

address_tag

string

Address tag of the settlement address - like memo or destination tag

Update settlement addresses › Responses

APIResponseSchema-AccountSettlementAddressResponseSchema

AccountSetSettlementAddressRequestSchema

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

PUT/account/settlement/{accountID}/settlement-addresses

curl https://api.fluxis.us/v1/account/settlement/:accountID/settlement-addresses \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'x-fluxis-api-key: <api-key>' \
  --header 'Authorization: <api-key>' \
  --data '{
  "address": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "address_tag": "nacho-memo",
  "network": "polygon"
}'

Example Request Body

{
  "address": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "address_tag": "nacho-memo",
  "network": "polygon"
}

json

application/json

Example Responses

{
  "data": {
    "address": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "address_tag": "nacho-memo",
    "network": "polygon"
  },
  "status": "success"
}

json

application/json

Set settlement addresses

POST

https://api.fluxis.us/v1

/account/settlement/{accountID}/settlement-addresses

x-fluxis-api-key (header)

+Authorization (header)

Set the settlement addresses for an account

Set settlement addresses › path Parameters

accountID

string · required

Account ID

Set settlement addresses › Request Body

address

string · required

Address of the settlement address

network

string · required

Network of the settlement address

address_tag

string

Address tag of the settlement address - like memo or destination tag

Set settlement addresses › Responses

Created

APIResponseSchema-AccountSettlementAddressResponseSchema

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

POST/account/settlement/{accountID}/settlement-addresses

curl https://api.fluxis.us/v1/account/settlement/:accountID/settlement-addresses \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-fluxis-api-key: <api-key>' \
  --header 'Authorization: <api-key>' \
  --data '{
  "address": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "address_tag": "nacho-memo",
  "network": "polygon"
}'

Example Request Body

{
  "address": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "address_tag": "nacho-memo",
  "network": "polygon"
}

json

application/json

Example Responses

{
  "data": {
    "address": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "address_tag": "nacho-memo",
    "network": "polygon"
  },
  "status": "success"
}

json

application/json

Delete settlement addresses

DELETE

https://api.fluxis.us/v1

/account/settlement/{accountID}/settlement-addresses

x-fluxis-api-key (header)

+Authorization (header)

Delete the settlement addresses for an account

Delete settlement addresses › path Parameters

accountID

string · required

Account ID

Delete settlement addresses › query Parameters

network

string · required

Network

Delete settlement addresses › Responses

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Get account by ID

GET

https://api.fluxis.us/v1

/account/{accountId}

x-fluxis-api-key (header)

+Authorization (header)

Retrieve an account by its ID

Get account by ID › path Parameters

accountId

string · required

Account ID

Get account by ID › Responses

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Update account

PUT

https://api.fluxis.us/v1

/account/{accountId}

x-fluxis-api-key (header)

+Authorization (header)

Update an existing account

Update account › path Parameters

accountId

string · required

Account ID

Update account › Request Body

name

string · required

Account name in Fluxis database

external_id

string

Account external ID

Update account › Responses

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Delete account

DELETE

https://api.fluxis.us/v1

/account/{accountId}

x-fluxis-api-key (header)

+Authorization (header)

Delete an existing account

Delete account › path Parameters

accountId

string · required

Account ID

Delete account › Responses

APIResponseSchema-GetAccountSettlementAddressesResponseSchema

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Get settlement addresses

GET

https://api.fluxis.us/v1

/account/{accountId}/settlement-addresses

x-fluxis-api-key (header)

+Authorization (header)

Get the settlement addresses for an account

Get settlement addresses › path Parameters

accountId

string · required

Account ID

Get settlement addresses › Responses

Organization Point of Sale

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Fluxis Core API

Accounts

Server

Get all accounts

GET

https://api.fluxis.us/v1

/account

x-fluxis-api-key (header)

+Authorization (header)

Retrieve all accounts

Get all accounts › Responses

APIResponseSchema-array_GetAccountResponseSchema

GetAccountResponseSchema[]

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Create account

POST

https://api.fluxis.us/v1

/account

x-fluxis-api-key (header)

+Authorization (header)

Create a new account

Create account › Request Body

name

string · required

Account name in Fluxis database

external_id

string

Account external ID

Create account › Responses

Created

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Get notification email

GET

https://api.fluxis.us/v1

/account/notification-email/{accountId}

x-fluxis-api-key (header)

+Authorization (header)

Get the sales-notification email and switch for an account. notification_email is null when unset. sales_notifications_enabled is true when the switch has never been stored.

Get notification email › path Parameters

accountId

string · required

Account ID

Get notification email › Responses

SetNotificationEmailRequest

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Set notification email

PUT

https://api.fluxis.us/v1

/account/notification-email/{accountId}

x-fluxis-api-key (header)

+Authorization (header)

Set notification email › path Parameters

accountId

string · required

Account ID

Set notification email › Request Body

notification_email

string

Address notified when a payment is credited. Omit to leave unchanged. Null or empty clears it.

sales_notifications_enabled

boolean

When false, completed, overpaid, and underpaid merchant sale emails are not sent. Omit or null to leave unchanged. A missing stored value stays true.

Set notification email › Responses

APIResponseSchema-GetAccountSettlementAddressesResponseSchema

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Get settlement addresses

GET

https://api.fluxis.us/v1

/account/settlement/{accountID}/settlement-addresses

x-fluxis-api-key (header)

+Authorization (header)

Get the settlement addresses for an account

Get settlement addresses › path Parameters

accountID

string · required

Account ID

Get settlement addresses › Responses

AccountUpdateSettlementAddressRequestSchema

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Update settlement addresses

PUT

https://api.fluxis.us/v1

/account/settlement/{accountID}/settlement-addresses

x-fluxis-api-key (header)

+Authorization (header)

Update the settlement addresses for an account

Update settlement addresses › path Parameters

accountID

string · required

Account ID

Update settlement addresses › Request Body

address

string · required

Address of the settlement address

network

string · required

Network of the settlement address

address_tag

string

Address tag of the settlement address - like memo or destination tag

Update settlement addresses › Responses

APIResponseSchema-AccountSettlementAddressResponseSchema

AccountSetSettlementAddressRequestSchema

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

PUT/account/settlement/{accountID}/settlement-addresses

curl https://api.fluxis.us/v1/account/settlement/:accountID/settlement-addresses \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'x-fluxis-api-key: <api-key>' \
  --header 'Authorization: <api-key>' \
  --data '{
  "address": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "address_tag": "nacho-memo",
  "network": "polygon"
}'

Example Request Body

{
  "address": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "address_tag": "nacho-memo",
  "network": "polygon"
}

json

application/json

Example Responses

{
  "data": {
    "address": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "address_tag": "nacho-memo",
    "network": "polygon"
  },
  "status": "success"
}

json

application/json

Set settlement addresses

POST

https://api.fluxis.us/v1

/account/settlement/{accountID}/settlement-addresses

x-fluxis-api-key (header)

+Authorization (header)

Set the settlement addresses for an account

Set settlement addresses › path Parameters

accountID

string · required

Account ID

Set settlement addresses › Request Body

address

string · required

Address of the settlement address

network

string · required

Network of the settlement address

address_tag

string

Address tag of the settlement address - like memo or destination tag

Set settlement addresses › Responses

Created

APIResponseSchema-AccountSettlementAddressResponseSchema

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

POST/account/settlement/{accountID}/settlement-addresses

curl https://api.fluxis.us/v1/account/settlement/:accountID/settlement-addresses \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-fluxis-api-key: <api-key>' \
  --header 'Authorization: <api-key>' \
  --data '{
  "address": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "address_tag": "nacho-memo",
  "network": "polygon"
}'

Example Request Body

{
  "address": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "address_tag": "nacho-memo",
  "network": "polygon"
}

json

application/json

Example Responses

{
  "data": {
    "address": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "address_tag": "nacho-memo",
    "network": "polygon"
  },
  "status": "success"
}

json

application/json

Delete settlement addresses

DELETE

https://api.fluxis.us/v1

/account/settlement/{accountID}/settlement-addresses

x-fluxis-api-key (header)

+Authorization (header)

Delete the settlement addresses for an account

Delete settlement addresses › path Parameters

accountID

string · required

Account ID

Delete settlement addresses › query Parameters

network

string · required

Network

Delete settlement addresses › Responses

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Get account by ID

GET

https://api.fluxis.us/v1

/account/{accountId}

x-fluxis-api-key (header)

+Authorization (header)

Retrieve an account by its ID

Get account by ID › path Parameters

accountId

string · required

Account ID

Get account by ID › Responses

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Update account

PUT

https://api.fluxis.us/v1

/account/{accountId}

x-fluxis-api-key (header)

+Authorization (header)

Update an existing account

Update account › path Parameters

accountId

string · required

Account ID

Update account › Request Body

name

string · required

Account name in Fluxis database

external_id

string

Account external ID

Update account › Responses

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Delete account

DELETE

https://api.fluxis.us/v1

/account/{accountId}

x-fluxis-api-key (header)

+Authorization (header)

Delete an existing account

Delete account › path Parameters

accountId

string · required

Account ID

Delete account › Responses

APIResponseSchema-GetAccountSettlementAddressesResponseSchema

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Get settlement addresses

GET

https://api.fluxis.us/v1

/account/{accountId}/settlement-addresses

x-fluxis-api-key (header)

+Authorization (header)

Get the settlement addresses for an account

Get settlement addresses › path Parameters

accountId

string · required

Account ID

Get settlement addresses › Responses