Introduction

Base URL: https://dash.zypto.com

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

This API is not authenticated.

Admin api

Get fees

Example request:

curl --request GET \
    --get "https://dash.zypto.com/api/zypto/fees" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady"

const url = new URL(
    "https://dash.zypto.com/api/zypto/fees"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://dash.zypto.com/api/zypto/fees';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://dash.zypto.com/api/zypto/fees'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
     'success': true,
     'message': {
         'prepaid_card_fees': {
             'fcf_flat_fee': 10.00,
             'fcf_variable_fee': 2.00,
         },
         'physical_card_fees': {
             'fcf_flat_fee': 10.00,
             'fcf_variable_fee': 2.00,
             'fcf_top_up_flat_fee': 10.00,
             'fcf_top_up_variable_fee': 2.00,
         },
         'virtual_card_fees': {
             'fcf_flat_fee': 10.00,
             'fcf_variable_fee': 2.00,
         },
     },
}

Example response (200):


{
     'success': false,
     'message': 'Something went wrong!',
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

V2

Creating a new order

currency_name: The ISO-4217 currency

redirect_url: The page where you want to redirect users after the payment

items: List of items in JSON format

Example request:

curl --request POST \
    "https://dash.zypto.com/api/v2/create-order" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady" \
    --data "{
    \"order_id\": \"Nmd474yJ\",
    \"amount\": \"10.00\",
    \"currency_name\": \"USD\",
    \"redirect_url\": \"odit\",
    \"user_id\": \"1\",
    \"order_date\": \"2022-04-26\",
    \"items\": \"{ \\\"1\\\": { \\\"Item Name\\\": \\\"Test Item 1\\\", \\\"Quantity\\\":\\\"1\\\", \\\"Price\\\": 10, \\\"Total\\\":\\\"12\\\" }, \\\"2\\\": { \\\"Item Name\\\": \\\"Test Item 2\\\", \\\"Price\\\": 20 } }\"
}"

const url = new URL(
    "https://dash.zypto.com/api/v2/create-order"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady",
};

let body = {
    "order_id": "Nmd474yJ",
    "amount": "10.00",
    "currency_name": "USD",
    "redirect_url": "odit",
    "user_id": "1",
    "order_date": "2022-04-26",
    "items": "{ \"1\": { \"Item Name\": \"Test Item 1\", \"Quantity\":\"1\", \"Price\": 10, \"Total\":\"12\" }, \"2\": { \"Item Name\": \"Test Item 2\", \"Price\": 20 } }"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://dash.zypto.com/api/v2/create-order';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady',
        ],
        'json' => [
            'order_id' => 'Nmd474yJ',
            'amount' => '10.00',
            'currency_name' => 'USD',
            'redirect_url' => 'odit',
            'user_id' => '1',
            'order_date' => '2022-04-26',
            'items' => '{ "1": { "Item Name": "Test Item 1", "Quantity":"1", "Price": 10, "Total":"12" }, "2": { "Item Name": "Test Item 2", "Price": 20 } }',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://dash.zypto.com/api/v2/create-order'
payload = {
    "order_id": "Nmd474yJ",
    "amount": "10.00",
    "currency_name": "USD",
    "redirect_url": "odit",
    "user_id": "1",
    "order_date": "2022-04-26",
    "items": "{ \"1\": { \"Item Name\": \"Test Item 1\", \"Quantity\":\"1\", \"Price\": 10, \"Total\":\"12\" }, \"2\": { \"Item Name\": \"Test Item 2\", \"Price\": 20 } }"
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
     'success': true,
     'data'    => [
         'checkout_page_url' => '',
         'payment_status' => 'waiting'
         'hash' => 'hash_string',
         'merchant_order_id' => 'order_id_string',
     ],
     'message' => 'Order already exists. Waiting for the payment.'
}

Example response (401):


{
     'success': false,
     'message' => 'Something went wrong!',
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v2/create-order

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady

Body Parameters

order_id string. optional

Example: Nmd474yJ

amount required optional

float. Example: 10.00

currency_name required optional

string. Example: USD

redirect_url string

Example: odit

user_id integer. optional

Example: 1

order_date date optional

date_format:Y-m-d. Example: 2022-04-26

items string. optional

Example: { "1": { "Item Name": "Test Item 1", "Quantity":"1", "Price": 10, "Total":"12" }, "2": { "Item Name": "Test Item 2", "Price": 20 } }

Creating a new order deposit

currency_name: The ISO-4217 currency

redirect_url: The page where you want to redirect users after the payment

items: List of items in JSON format

Example request:

curl --request POST \
    "https://dash.zypto.com/api/v2/create-order-deposit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady" \
    --data "{
    \"amount\": \"33738.6\",
    \"token_symbol\": \"nihil\",
    \"currency_name\": \"eius\",
    \"order_date\": \"2026-04-24T09:39:33\",
    \"redirect_url\": \"http:\\/\\/www.schaefer.net\\/et-eos-aut-vero-fugit\",
    \"items\": \"{ \\\"1\\\": { \\\"Item Name\\\": \\\"Test Item 1\\\", \\\"Quantity\\\":\\\"1\\\", \\\"Price\\\": 10, \\\"Total\\\":\\\"12\\\" }, \\\"2\\\": { \\\"Item Name\\\": \\\"Test Item 2\\\", \\\"Price\\\": 20 } }\",
    \"user_id\": 17
}"

const url = new URL(
    "https://dash.zypto.com/api/v2/create-order-deposit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady",
};

let body = {
    "amount": "33738.6",
    "token_symbol": "nihil",
    "currency_name": "eius",
    "order_date": "2026-04-24T09:39:33",
    "redirect_url": "http:\/\/www.schaefer.net\/et-eos-aut-vero-fugit",
    "items": "{ \"1\": { \"Item Name\": \"Test Item 1\", \"Quantity\":\"1\", \"Price\": 10, \"Total\":\"12\" }, \"2\": { \"Item Name\": \"Test Item 2\", \"Price\": 20 } }",
    "user_id": 17
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://dash.zypto.com/api/v2/create-order-deposit';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady',
        ],
        'json' => [
            'amount' => '33738.6',
            'token_symbol' => 'nihil',
            'currency_name' => 'eius',
            'order_date' => '2026-04-24T09:39:33',
            'redirect_url' => 'http://www.schaefer.net/et-eos-aut-vero-fugit',
            'items' => '{ "1": { "Item Name": "Test Item 1", "Quantity":"1", "Price": 10, "Total":"12" }, "2": { "Item Name": "Test Item 2", "Price": 20 } }',
            'user_id' => 17,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://dash.zypto.com/api/v2/create-order-deposit'
payload = {
    "amount": "33738.6",
    "token_symbol": "nihil",
    "currency_name": "eius",
    "order_date": "2026-04-24T09:39:33",
    "redirect_url": "http:\/\/www.schaefer.net\/et-eos-aut-vero-fugit",
    "items": "{ \"1\": { \"Item Name\": \"Test Item 1\", \"Quantity\":\"1\", \"Price\": 10, \"Total\":\"12\" }, \"2\": { \"Item Name\": \"Test Item 2\", \"Price\": 20 } }",
    "user_id": 17
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
     'success': true,
     "data": {
         "status": "unpaid",
         "checkout_page_url": "https://checkout.fcfpay.com/pay/JDJ5JDEwJFNXNktTNE5kcW1vYXJzOEYzdnM4cy53c2p5TVYuMU40c3A1V1laZC9JOUZta1ZMU3NUSEQu",
         "data": {
             "order_id": "B25MsfHHMa",
             "user_id": "",
             "txs": [],
             "order_amount": "50",
             "total_fiat_amount": 0,
             "fiat_currency": "USD"
         },
         "address": "0x8B67499476C0C0f6Dd48aE30D63C8fe2Ea21Cb4A",
         "memo": 0,
         "crypto_currency_name": "AVAX Testnet",
         "crypto_currency_amount": 3.743353,
         "crypto_currency_amount_total": 1.9992996387711717,
         "total_usd": 45.38
     },
     "message": "Address successfully created"
 }

Example response (401):


{
     'success': false,
     'message' => 'Something went wrong!',
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v2/create-order-deposit

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady

Body Parameters

amount number

Must match the regex /^\d+(.\d{1,2})?$/. Example: 33738.6

token_symbol string

Example: nihil

currency_name string

Example: eius

order_date string optional

Must be a valid date. Example: 2026-04-24T09:39:33

redirect_url string optional

Must be a valid URL. Example: http://www.schaefer.net/et-eos-aut-vero-fugit

items string. optional

Example: { "1": { "Item Name": "Test Item 1", "Quantity":"1", "Price": 10, "Total":"12" }, "2": { "Item Name": "Test Item 2", "Price": 20 } }

user_id integer optional

Example: 17

Get surcharge currencies with %

Example request:

curl --request GET \
    --get "https://dash.zypto.com/api/v2/surcharge" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady"

const url = new URL(
    "https://dash.zypto.com/api/v2/surcharge"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://dash.zypto.com/api/v2/surcharge';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://dash.zypto.com/api/v2/surcharge'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
     'success': true,
     "data": "",
     "message": [
         {
             "discount_surcharge": 2.00,
             "crypto_currency": "ETH-USDT-ERC20",
             "crypto_currency_symbol": "ETH.USDT"
         },
         {
             "discount_surcharge": 1.00,
             "crypto_currency": "ETH-SHIB",
             "crypto_currency_symbol": "ETH.SHIB"
         },
     ]
}

Example response (401):


{
     'success': false,
     'message' => 'Something went wrong!',
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Check Order

Get order information

After creating the order you can make a "check-order" request to check if the order was paid or not. You will receive all payments details in a list.

Example request:

curl --request POST \
    "https://dash.zypto.com/api/v2/check-order" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady" \
    --data "{
    \"order_id\": \"quasi\"
}"

const url = new URL(
    "https://dash.zypto.com/api/v2/check-order"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady",
};

let body = {
    "order_id": "quasi"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://dash.zypto.com/api/v2/check-order';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady',
        ],
        'json' => [
            'order_id' => 'quasi',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://dash.zypto.com/api/v2/check-order'
payload = {
    "order_id": "quasi"
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
     'success': true,
     'data' => [
         'order_id' => '9384',
         'user_id' => 3333,
         'order_amount' => 0,
         'total_fiat_amount' => 0,
         'fiat_currency' => 'USD',
         'total_fiat_amount_adjusted' => 0,
         "card_uuid": "2231231--sadoajsdhh43-w"
     ],
     'message' => "Successfully fetched."
}

Example response (401):


{
     'success': false,
     'message' => 'Something went wrong!',
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v2/check-order

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady

Body Parameters

order_id string. optional

"Test123" Example: quasi

Check Orders

Get order information

You can make a "check-orders" request to check the payment status of multiple orders.

If there is a list of orders and from these one or more are not found, this API call will not return data for the order_ids that were not found

Example request:

curl --request POST \
    "https://dash.zypto.com/api/v2/check-orders" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady" \
    --data "{
    \"order_ids\": \"autem\"
}"

const url = new URL(
    "https://dash.zypto.com/api/v2/check-orders"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady",
};

let body = {
    "order_ids": "autem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://dash.zypto.com/api/v2/check-orders';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady',
        ],
        'json' => [
            'order_ids' => 'autem',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://dash.zypto.com/api/v2/check-orders'
payload = {
    "order_ids": "autem"
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
     'success': true,
     'data' => [
         'Test123' => [
             'order_id' => '9384',
             'user_id' => 3333,
             'order_amount' => 0,
             'total_fiat_amount' => 0,
             'fiat_currency' => 'USD',
             'total_fiat_amount_adjusted' => 0,
         ]
     ],
     'message' => "Successfully fetched."
}

Example response (401):


{
     'success': false,
     'message' => 'Something went wrong!',
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v2/check-orders

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady

Body Parameters

order_ids array. optional

["Test123", "Test125"] Example: autem

Get Orders for user

Get orders information

Length values: 10, 20, 30, 50 Default 10

Example request:

curl --request POST \
    "https://dash.zypto.com/api/v2/orders-for-user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady" \
    --data "{
    \"length\": \"10\",
    \"page\": \"1\",
    \"user_id\": \"4\"
}"

const url = new URL(
    "https://dash.zypto.com/api/v2/orders-for-user"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady",
};

let body = {
    "length": "10",
    "page": "1",
    "user_id": "4"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://dash.zypto.com/api/v2/orders-for-user';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady',
        ],
        'json' => [
            'length' => '10',
            'page' => '1',
            'user_id' => '4',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://dash.zypto.com/api/v2/orders-for-user'
payload = {
    "length": "10",
    "page": "1",
    "user_id": "4"
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
     'success': true,
     'data' => [
         'orders' => [
             'id' => 1,
             'type' => 'Mastercard allowance',
             'merchant_order_id' => 'YV2XUfasG2',
             'obs_order_id' => '123123123123',
             'order_amount' => 100,
             'currency_name' => 'USD',
             'amount' => 100,
             'deposited_amount' => 100,
             'created_at' => '2021-01-01 00:00:00',
             'updated_at' => '2021-01-01 00:00:00',
             'order_email' => '[email protected]',
             'order_message' => 'Order message',
             'transactions' => [
                 {
                     'currency_name' => 'AVAX',
                     'amount' => 10.087,
                 }
             ],
         ],
         'page' => 1,
         'from' => 1,
         'to' => 10,
         'ordersCount' => 100,
     ],
}

Example response (401):


{
     'success': false,
     'message' => 'Something went wrong!',
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v2/orders-for-user

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady

Body Parameters

length integer. optional

Example: 10

page integer. optional

Example: 1

user_id integer. optional

Example: 4

Check balances

Example request:

curl --request POST \
    "https://dash.zypto.com/api/v2/check-account-balance" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady"

const url = new URL(
    "https://dash.zypto.com/api/v2/check-account-balance"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://dash.zypto.com/api/v2/check-account-balance';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://dash.zypto.com/api/v2/check-account-balance'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady'
}

response = requests.request('POST', url, headers=headers)
response.json()

Example response (200):


{
    "success": true,
    "data": {
        "currencies": [
            {
                "balance": "6.24866848",
                "currency_name": "BSC-USDT-BEP20",
                "usd": "6.25"
            },
            {
                "balance": "0.10714544",
                "currency_name": "BTC",
                "usd": "7139.15"
            },
            {
                "balance": "-9.58127395",
                "currency_name": "BSC",
                "usd": "-5491.05"
            }
        ],
        "total_usd_value": 1654.34
    },
    "message": "success"
}

Example response (401):


{
     'success': false,
     'message' => 'Something went wrong!',
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Check referral

Example request:

curl --request POST \
    "https://dash.zypto.com/api/v2/check-referral" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady" \
    --data "{
    \"email\": \"et\"
}"

const url = new URL(
    "https://dash.zypto.com/api/v2/check-referral"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady",
};

let body = {
    "email": "et"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://dash.zypto.com/api/v2/check-referral';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady',
        ],
        'json' => [
            'email' => 'et',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://dash.zypto.com/api/v2/check-referral'
payload = {
    "email": "et"
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "success": true,
    "message": '[email protected]'
}

Example response (401):


{
     'success': false,
     'message' => 'Something went wrong!',
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v2/check-referral

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady

Body Parameters

email string

Example: et

Get Order Receipt

Get order receipt

Example request:

curl --request POST \
    "https://dash.zypto.com/api/v2/get-receipt" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady" \
    --data "{
    \"order_id\": \"et\"
}"

const url = new URL(
    "https://dash.zypto.com/api/v2/get-receipt"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady",
};

let body = {
    "order_id": "et"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://dash.zypto.com/api/v2/get-receipt';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady',
        ],
        'json' => [
            'order_id' => 'et',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://dash.zypto.com/api/v2/get-receipt'
payload = {
    "order_id": "et"
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
     'content':  'application/pdf'
}

Example response (401):


{
     'success': false,
     'message' => 'Something went wrong!',
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v2/get-receipt

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady

Body Parameters

order_id string. optional

"Test123" Example: et

Create Invoice

Creating a new Invoice

name: Name of your customer. Example: "API Invoice test"

invoice_number: The number of the invoice (optional). Can accept any character. Example: "1234"

subject: Subject as you'd like it to appear. Example: "API test"

description: Description of items in the invoice. Example: "Rent for Q1"

currency_name: The ISO-4217 currency. Example: "USD"

items: List of items in JSON format

Example request:

curl --request POST \
    "https://dash.zypto.com/api/v2/create-invoice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady" \
    --data "{
    \"name\": \"nesciunt\",
    \"subject\": \"sit\",
    \"amount\": \"\\\"100.05\\\"\",
    \"currency_name\": \"quos\",
    \"invoice_number\": \"\\\"1234\\\"\",
    \"description\": \"\\\"Rent for Q1\\\"\",
    \"items\": \"{ \\\"1\\\": { \\\"Item Name\\\": \\\"Test Item 1\\\", \\\"Quantity\\\":\\\"1\\\", \\\"Price\\\": 10, \\\"Total\\\":\\\"12\\\" }, \\\"2\\\": { \\\"Item Name\\\": \\\"Test Item 2\\\", \\\"Price\\\": 20 } }\"
}"

const url = new URL(
    "https://dash.zypto.com/api/v2/create-invoice"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady",
};

let body = {
    "name": "nesciunt",
    "subject": "sit",
    "amount": "\"100.05\"",
    "currency_name": "quos",
    "invoice_number": "\"1234\"",
    "description": "\"Rent for Q1\"",
    "items": "{ \"1\": { \"Item Name\": \"Test Item 1\", \"Quantity\":\"1\", \"Price\": 10, \"Total\":\"12\" }, \"2\": { \"Item Name\": \"Test Item 2\", \"Price\": 20 } }"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://dash.zypto.com/api/v2/create-invoice';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady',
        ],
        'json' => [
            'name' => 'nesciunt',
            'subject' => 'sit',
            'amount' => '"100.05"',
            'currency_name' => 'quos',
            'invoice_number' => '"1234"',
            'description' => '"Rent for Q1"',
            'items' => '{ "1": { "Item Name": "Test Item 1", "Quantity":"1", "Price": 10, "Total":"12" }, "2": { "Item Name": "Test Item 2", "Price": 20 } }',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://dash.zypto.com/api/v2/create-invoice'
payload = {
    "name": "nesciunt",
    "subject": "sit",
    "amount": "\"100.05\"",
    "currency_name": "quos",
    "invoice_number": "\"1234\"",
    "description": "\"Rent for Q1\"",
    "items": "{ \"1\": { \"Item Name\": \"Test Item 1\", \"Quantity\":\"1\", \"Price\": 10, \"Total\":\"12\" }, \"2\": { \"Item Name\": \"Test Item 2\", \"Price\": 20 } }"
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
     'success': true,
     'data'    => [
         'checkout_page_url' => '',
         'payment_status' => 'waiting'
     ],
     'message' => 'Invoice successfully created. Waiting for the payment.'
}

Example response (401):


{
     'success': false,
     'message' => 'Something went wrong!',
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v2/create-invoice

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady

Body Parameters

name string

Example: nesciunt

subject string

Example: sit

amount string. optional

Example: "100.05"

currency_name string

Example: quos

invoice_number string. optional

Example: "1234"

description string. optional

Example: "Rent for Q1"

items string. optional

Example: { "1": { "Item Name": "Test Item 1", "Quantity":"1", "Price": 10, "Total":"12" }, "2": { "Item Name": "Test Item 2", "Price": 20 } }

Introduction

Authenticating requests

Admin api

Get fees

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

V2

Creating a new order

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Creating a new order deposit

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Get surcharge currencies with %

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Check Order

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Check Orders

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Get Orders for user

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Check balances

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Check referral

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Get Order Receipt

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Create Invoice

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request