Skip to main content

Cryptix API (v2.0)

Download OpenAPI specification:Download

The Cryptix API is organized around REST.

HTTP response status codes

Status Code Description
200 OK The request is successful.
202 Accepted The server accepted the request and will execute it later.
401 Unauthorized Indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.
403 Forbidden Indicates that the server understands the request but refuses to authorize it.
404 Not Found Indicates that the server cannot find the requested resource.
405 Method Not Allowed Indicates that the server knows the request method, but the target resource doesn't support this method.
422 Unprocessable Content Returned when the validation of the resource fails on POST or PUT requests. Response contains errors field with a list of errors.
429 Too Many Requests Indicates the user has sent too many requests in a given amount of time ("rate limiting").
500 Internal Server Error Server error.

Charges

List charges

Returns all charges

Authorizations:
CookieAuthBearerAuth
query Parameters
order
string
Enum: "asc" "desc"
Example: order=asc

Sort order

offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

limit
integer [ 1 .. 100 ]
Default: 25
Example: limit=25

A limit on the number of objects to be returned, between 1 and 100.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Create a charge

To get paid in cryptocurrency, you need to create a charge object and provide the user with a cryptocurrency address to which they must send cryptocurrency. Once a charge is created a customer must broadcast a payment to the blockchain before the charge expires.

Authorizations:
CookieAuthBearerAuth
Request Body schema: application/json
required
project_id
required
string <uuid>

ID of project

name
string

The charge's name, meant to be displayable to the customer

description
string

The charge's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes

pricing_type
required
string
Enum: "fixed_price" "no_price"

What type of prices do you want to offer?

required
object
object

Required for pricing_type: fixed_price

external_id
string^[0-9a-zA-Z:._-]{1,255}$

A unique string to reference the Charge. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the Charge with your internal systems

Responses

Request samples

Content type
application/json
{
  • "project_id": "75b777f0-7a18-4bc9-b828-70ed1574c6b4",
  • "name": "Charge name",
  • "description": "More detailed description",
  • "pricing_type": "fixed_price",
  • "crypto": {
    },
  • "fiat_price": {
    },
  • "external_id": "UW71JD5"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Show a charge

Retrieves the details of a charge that has been previously created.

path Parameters
id
required
string <uuid>

ID of charge

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Checkouts

List checkouts

Lists all checkouts

Authorizations:
CookieAuthBearerAuth
query Parameters
order
string
Enum: "asc" "desc"
Example: order=asc

Sort order

offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

limit
integer [ 1 .. 100 ]
Default: 25
Example: limit=25

A limit on the number of objects to be returned, between 1 and 100.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Create a checkout

Create a new checkout

Authorizations:
CookieAuthBearerAuth
Request Body schema: application/json
required
project_id
required
string <uuid>

ID of project

pricing_type
required
string
Enum: "fixed_price" "no_price"

What type of prices do you want to offer?

object

Required for pricing_type: fixed_price

name
required
string

The product’s name, meant to be displayable to the customer

description
required
string

The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes

Responses

Request samples

Content type
application/json
{
  • "project_id": "75b777f0-7a18-4bc9-b828-70ed1574c6b4",
  • "pricing_type": "fixed_price",
  • "fiat_price": {
    },
  • "name": "Checkout name",
  • "description": "More detailed description"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Show a checkout

Show a single checkout

path Parameters
id
required
string <uuid>

ID of checkout

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update a checkout

Update a checkout

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
string <uuid>

ID of checkout

Request Body schema: application/json
required
object

Required for pricing_type: fixed_price

name
required
string

The product’s name, meant to be displayable to the customer

description
required
string

The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes

Responses

Request samples

Content type
application/json
{
  • "fiat_price": {
    },
  • "name": "Checkout name",
  • "description": "More detailed description"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete a checkout

Delete a checkout

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
string <uuid>

ID of checkout

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Invoices

List invoices

Lists all invoices

Authorizations:
CookieAuthBearerAuth
query Parameters
order
string
Enum: "asc" "desc"
Example: order=asc

Sort order

offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

limit
integer [ 1 .. 100 ]
Default: 25
Example: limit=25

A limit on the number of objects to be returned, between 1 and 100.

project_id
string
status
string
Enum: "open" "viewed" "paid" "void" "unresolved"
id
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Create an invoice

To send an invoice in cryptocurrency, you need to create an invoice object and provide the user with the hosted url where they will be able to pay. Once an invoice is viewed at the hosted url, a charge will be generated on the invoice.

Authorizations:
CookieAuthBearerAuth
Request Body schema: application/json
required
project_id
required
string <uuid>

ID of project

required
object
customer_name
string

The customer’s full name or business name

customer_email
required
string <email>

Customer’s email address

memo
string
void_after_seconds
integer or null

Responses

Request samples

Content type
application/json
{
  • "project_id": "75b777f0-7a18-4bc9-b828-70ed1574c6b4",
  • "fiat_price": {
    },
  • "customer_name": "Test Customer",
  • "customer_email": "customer@test.com",
  • "memo": "Accounting and tax consultation services",
  • "void_after_seconds": 3600
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Show an invoice

Retrieves the details of an invoice that has been previously created.

path Parameters
id
required
string <uuid>

ID of invoice

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Void an invoice

Voids an invoice that has been previously created. Supply the unique invoice ID that was returned when the invoice was created.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
string <uuid>

ID of invoice

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Resolve an invoice

Resolve an invoice that has been previously marked as unresolved. Supply the unique invoice ID that was returned when the invoice was created.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
string <uuid>

ID of invoice

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

MassPayouts

List of mass payouts

List of mass payouts

Authorizations:
CookieAuthBearerAuth
query Parameters
external_id
string^[0-9a-zA-Z:._-]{1,255}$
Example: external_id=ABC-123

External ID

created_at_from
string <date-time>
Example: created_at_from=2023-07-28T14:41:09Z

CreatedAt from value (inclusive)

created_at_to
string <date-time>
Example: created_at_to=2023-09-01T14:00:00Z

CreatedAt to value (exclusive)

order
string
Enum: "asc" "desc"
Example: order=asc

Sort order

offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

limit
integer [ 1 .. 100 ]
Default: 25
Example: limit=25

A limit on the number of objects to be returned, between 1 and 100.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Create a mass payout

Create a mass payout

Authorizations:
CookieAuthBearerAuth
Request Body schema:
required
id
required
string <uuid>

Unique ID of mass payout (UUID format)

external_id
string^[0-9a-zA-Z:._-]{1,255}$

Merchant's external ID for mass payout.

callback_url
string <url>

Merchant's callback URL.

fee_payer
string
Enum: "merchant" "customer"

Fee payer.

required
Array of objects

List of payout objects.

otp
string

OTP code (if enabled)

Responses

Callbacks

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "external_id": "string",
  • "callback_url": "https://example.com/callback",
  • "fee_payer": "customer",
  • "payouts": [
    ],
  • "otp": "123456"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Callback payload samples

Callback
POST: {$request.body#/callback_url}
Content type
application/json
{
  • "id": "b58850d3-fb4a-468c-a16f-be94962d48ae",
  • "type": "payout:pending",
  • "data": {
    },
  • "created_at": "2023-08-08T10:17:14.815487+03:00"
}

List of payouts from a mass payout

List of payouts from a mass payout

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
string <uuid>
query Parameters
external_id
string^[0-9a-zA-Z:._-]{1,255}$
Example: external_id=ABC-123

External ID

created_at_from
string <date-time>
Example: created_at_from=2023-07-28T14:41:09Z

CreatedAt from value (inclusive)

created_at_to
string <date-time>
Example: created_at_to=2023-09-01T14:00:00Z

CreatedAt to value (exclusive)

order
string
Enum: "asc" "desc"
Example: order=asc

Sort order

offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

limit
integer [ 1 .. 100 ]
Default: 25
Example: limit=25

A limit on the number of objects to be returned, between 1 and 100.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}