Payment Gateway API

Self Serve or Contact us

Creating a new order

POST /api/v2/create-order 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

 

  • Headers:

    • Content-Type: application/json
      Example: application/json
    • Accept: application/json
      Example: application/json
    • Authorization: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady

    Body Parameters:

    • order_id: (string, required)
      Example: "delectus"
    • amount: (float, required)
      Example: "10.00"
    • currency_name: (string, required)
      Example: "USD"
    • redirect_url: (string, optional)
      Example: "et"
    • user_id: (integer, optional)
      Example: "1"
    • order_date: (date, optional)
      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 } }
bash

Headers

  • Content-Type:
    Example: application/json
  • Accept:
    Example: application/json
  • Authorization:
    Example: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady

Body Parameters

order_ids:
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”: “delectus”,
“amount”: “10.00”,
“currency_name”: “USD”,
“redirect_url”: “et”,
“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 } }”
}’

Example Response (200):
{
“success”: true,
“data”: {
“checkout_page_url”: “”,
“payment_status”: “waiting”
},
“message”: “Order already exists. Waiting for the payment.”
}

Example Response (401):

{
“success”: false,
“message”: “Something went wrong!”
}

javascript

Headers

  • Content-Type:
    Example: application/json
  • Accept:
    Example: application/json
  • Authorization:
    Example: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady


Example Request:

 

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”: “delectus”,
“amount”: “10.00”,
“currency_name”: “USD”,
“redirect_url”: “et”,
“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());

Example Response (200):

{
“success”: true,
“data”: {
“checkout_page_url”: “”,
“payment_status”: “waiting”
},
“message”: “Order already exists. Waiting for the payment.”
}

Example Response (401):

{
“success”: false,
“message”: “Something went wrong!”
}

php

Headers

  • Content-Type:
    Example: application/json
  • Accept:
    Example: application/json
  • Authorization:
    Example: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady

    Example Request (PHP):

$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’ => ‘delectus’,
‘amount’ => ‘10.00’,
‘currency_name’ => ‘USD’,
‘redirect_url’ => ‘et’,
‘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));

Example Response (200):

{
“success”: true,
“data”: {
“checkout_page_url”: “”,
“payment_status”: “waiting”
},
“message”: “Order already exists. Waiting for the payment.”
}

Example Response (401):

{
“success”: false,
“message”: “Something went wrong!”
}

python

Example Request (Python):

import requests
import json

url = ‘https://dash.zypto.com/api/v2/create-order’
payload = {
“order_id”: “delectus”,
“amount”: “10.00”,
“currency_name”: “USD”,
“redirect_url”: “et”,
“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.post(url, headers=headers, json=payload)
print(response.json())

Example Response (200):

{
“success”: true,
“data”: {
“checkout_page_url”: “”,
“payment_status”: “waiting”
},
“message”: “Order already exists. Waiting for the payment.”
}

Example Response (401):

{
“success”: false,
“message”: “Something went wrong!”
}

Create Invoice

POST api/v2/create-invoice
  • name: (string, required)
    Name of your customer.
    Example: "API Invoice test"
  • invoice_number: (string, optional)
    The number of the invoice. Can accept any character.
    Example: "1234"
  • subject: (string, required)
    Subject as you’d like it to appear.
    Example: "API test"
  • description: (string, required)
    Description of items in the invoice.
    Example: "Rent for Q1"
  • currency_name: (string, required)
    The ISO-4217 currency code.
    Example: "USD"
  • items: (JSON, required)
    List of items in JSON format.
    Example:
    {
    “1”: { “Item Name”: “Test Item 1”, “Quantity”: “1”, “Price”: 50, “Total”: “50” },
    “2”: { “Item Name”: “Test Item 2”, “Quantity”: “2”, “Price”: 30, “Total”: “60” }
    }

    Headers:

    • Content-Type: application/json
      Example: application/json
    • Accept: application/json
      Example: application/json
    • Authorization: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady

    Body Parameters:

    • name: (string, required)
      Name of your customer.
      Example: "voluptatem"
    • subject: (string, required)
      Subject of the invoice.
      Example: "cum"
    • amount: (string, optional)
      The total amount of the invoice.
      Example: "100.05"
    • currency_name: (string, required)
      The ISO-4217 currency code.
      Example: "vel"
    • invoice_number: (string, optional)
      The number of the invoice.
      Example: "1234"
    • description: (string, optional)
      Description of items or services in the invoice.
      Example: "Rent for Q1"
    • items: (string, optional)
      List of items in JSON format.
      Example:

      {
      “1”: { “Item Name”: “Test Item 1”, “Quantity”: “1”, “Price”: 10, “Total”: “12” },
      “2”: { “Item Name”: “Test Item 2”, “Price”: 20 }
      }

bash

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”: “voluptatem”, “subject”: “cum”, “amount”: “100.05”, “currency_name”: “vel”, “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 } } }’

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!” }

javascript

Example Request:
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”: “voluptatem”, “subject”: “cum”, “amount”: “100.05”, “currency_name”: “vel”, “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());

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!” }

php

Example Request:
$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’ => ‘voluptatem’,
‘subject’ => ‘cum’,
‘amount’ => ‘100.05’,
‘currency_name’ => ‘vel’,
‘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));

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!”
}

python

Example Request

import requests

# Define the URL
url = ‘https://dash.zypto.com/api/v2/create-invoice’

# Define the payload
payload = {
“name”: “voluptatem”,
“subject”: “cum”,
“amount”: “100.05”, # No need for escaped quotes
“currency_name”: “vel”,
“invoice_number”: “1234”, # No need for escaped quotes
“description”: “Rent for Q1”, # No need for escaped quotes
“items”: {
“1”: {
“Item Name”: “Test Item 1”,
“Quantity”: “1”,
“Price”: 10,
“Total”: “12”
},
“2”: {
“Item Name”: “Test Item 2”,
“Price”: 20
}
}
}

# Define the headers
headers = {
‘Content-Type’: ‘application/json’,
‘Accept’: ‘application/json’,
‘Authorization’: ‘Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady’
}

# Make the POST request
response = requests.post(url, headers=headers, json=payload)

# Print the JSON response
print(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!”
}

Check Order

POST api/v2/check-order

Get Order Information

After creating an order, you can use the “check-order” request to verify if the order has been paid. This request will return a list of all payment details for the specified order.

Headers

  • Content-Type
    Example: application/json

  • Accept
    Example: application/json

  • Authorization
    Example: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady

Body Parameters

  • order_id
    Optional
    Type: string
    Example: "Test123"
bash

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”: “deleniti” }”

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!’, }

javascript

Example request:

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”: “deleniti” };

fetch(url, { method: “POST”, headers, body: JSON.stringify(body), }).then(response => 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!’, }

php

Example request:

$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’ => ‘deleniti’, ], ] ); $body = $response->getBody(); print_r(json_decode((string) $body));

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!’, }

python

Example request:

import requests import json

url = ‘https://dash.zypto.com/api/v2/check-order‘ payload = { “order_id”: “deleniti” } 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!’, }

Check Orders

POST api/v2/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.

Headers

  • Content-Type
    Example: application/json

  • Accept
    Example: application/json

  • Authorization
    Example: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady

Body Parameters

  • order_ids
    array. Optional
    Example: [“Test123”, “Test125”]
bash

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”: [“Test123”, “Test125″] }”

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!’, }

javascript

Example request:

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”: [“Test123”, “Test125”] };

fetch(url, { method: “POST”, headers, body: JSON.stringify(body), }).then(response => 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!’, }

php

Example request:

$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’ => [‘Test123’, ‘Test125’], ], ] ); $body = $response->getBody(); print_r(json_decode((string) $body));

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!’, }

python

Example request:

import requests import json

url = ‘https://dash.zypto.com/api/v2/check-orders‘ payload = { “order_ids”: [“Test123”, “Test125”] } headers = { ‘Content-Type’: ‘application/json’, ‘Accept’: ‘application/json’, ‘Authorization’: ‘Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady’ }

response = requests.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!’, }

Get Orders

POST api/v2/get-orders

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

Type values:

  • Top-up Physical: 6
  • Virtual card provider1: 4
  • Virtual card provider2: 13
  • Invoice: 2
  • Create Physical: 7
  • Create reloadable: 14
  • Top-up reloadable: 15
  • Bill: 12
  • Reloadable allowance: 16
  • Virtual allowance: 9
  • Physical allowance: 10

Period values:

  • daily: orders for the current day
  • monthly: orders for the current month
  • weekly: orders for the current week

Do not use period with from-to, as it may result in unexpected results.

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 type (integer, optional) – Example: 4 period (string, optional) – Example: daily from (date, optional) – Example: 02-17-2024 to (date, optional) – Example: 07-17-2024

bash

Example request:

curl –request POST
https://dash.zypto.com/api/v2/get-orders
–header “Content-Type: application/json”
–header “Accept: application/json”
–header “Authorization: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady”
–data “{ “length”: “10”, “page”: “1”, “type”: “4”, “period”: “daily”, “from”: “02-17-2024”, “to”: “07-17-2024″ }”

Example response (200):

{ “success”: true, “data”: { “orders”: [ { “amount”: 21.28, “currency_name”: “USD”, “hash”: “JDJ5JDEwJE1iRzN4aVJrSmlzY1BxVEVHUk5wRC5nTFN1UFJrRnhwdXc4cWUudUlEMHQ5bmpBbjNQRnVX”, “card”: { “id”: 154, “tenant_id”: null, “merchant_id”: 1, “iframe_id”: null, “amount”: “20.00”, “fee_include”: 0, “currency_code”: “USD”, “name”: null, “middlename”: null, “firstName”: null, “surname”: null, “address_line1”: null, “address_line2”: null, “city”: null, “state”: null, “country”: “ca”, “zip”: null, “telephone”: null, “countryCallingCode”: null, “callingCode”: null, “cellPhoneNumber”: null, “email”: “y@devurai.com“, “cards_number”: “6g9zJTIMXW”, “uuid”: “fytgyh-gfhgvhb”, “created_at”: “2024-01-22T10:37:07.000000Z”, “updated_at”: “2024-01-22T10:37:07.000000Z”, “status”: 1, “status_link”: “https://checkout.local/redeem-info/N1UFJrRnhwdXc4cWUudUlEMHQ5bmpBbjNQRnVX“, “order_id”: 747, “amount_deposited”: null }, “data”: { “order_id”: “eNdz6BMSAA”, “user_id”: “”, “order_amount”: “23.20”, “total_fiat_amount”: 0, “fiat_currency”: “USD”, “total_fiat_amount_adjusted”: 0, “card_uuid”: null, “txs”: [ { “deposited”: true, “txid”: “”, “block_explorer”: “”, “confirm_blocks”: “”, “status”: “deposited”, “amount_usd”: “23.20”, “fiat_amount”: null, “fiat_currency”: null, “amount_trim”: “0.00050959”, “amount”: “50959”, “currency”: “BTC”, “fees”: “”, “decimal”: 8, “fee_decimal”: 8, “date”: “Jan 10 2024 12:00:44”, “coefficient”: 1, “fiat_amount_adjusted”: null } ] }, “bill”: null, “type”: 13, “items”: null, “created_at”: “2024-04-01T11:30:43.000000Z”, “updated_at”: “2024-04-01T11:47:07.000000Z”, “on_ramp”: 1, “home_redirect”: null, “has_txs”: 0, “current_txs_count”: 0, “last_status”: “”, “transaction_id”: “6g9zJTIMXW”, “invoice”: null, “invoice_description”: null }, ] }, “page”: “1”, “from”: 1, “to”: 10, “ordersCount”: 713, “totalAmountDeposited”: $110 }, “message”: “success” }

Example response (401):

{ ‘success’: false, ‘message’: ‘Something went wrong!’, }

javascript

Example request:

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

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

let body = { “length”: “10”, “page”: “1”, “type”: “4”, “period”: “daily”, “from”: “02-17-2024”, “to”: “07-17-2024” };

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

Example response (200):

{ “success”: true, “data”: { “orders”: [ { “amount”: 21.28, “currency_name”: “USD”, “hash”: “JDJ5JDEwJE1iRzN4aVJrSmlzY1BxVEVHUk5wRC5nTFN1UFJrRnhwdXc4cWUudUlEMHQ5bmpBbjNQRnVX”, “card”: { “id”: 154, “tenant_id”: null, “merchant_id”: 1, “iframe_id”: null, “amount”: “20.00”, “fee_include”: 0, “currency_code”: “USD”, “name”: null, “middlename”: null, “firstName”: null, “surname”: null, “address_line1”: null, “address_line2”: null, “city”: null, “state”: null, “country”: “ca”, “zip”: null, “telephone”: null, “countryCallingCode”: null, “callingCode”: null, “cellPhoneNumber”: null, “email”: “y@devurai.com“, “cards_number”: “6g9zJTIMXW”, “uuid”: “fytgyh-gfhgvhb”, “created_at”: “2024-01-22T10:37:07.000000Z”, “updated_at”: “2024-01-22T10:37:07.000000Z”, “status”: 1, “status_link”: “https://checkout.local/redeem-info/N1UFJrRnhwdXc4cWUudUlEMHQ5bmpBbjNQRnVX“, “order_id”: 747, “amount_deposited”: null }, “data”: { “order_id”: “eNdz6BMSAA”, “user_id”: “”, “order_amount”: “23.20”, “total_fiat_amount”: 0, “fiat_currency”: “USD”, “total_fiat_amount_adjusted”: 0, “card_uuid”: null, “txs”: [ { “deposited”: true, “txid”: “”, “block_explorer”: “”, “confirm_blocks”: “”, “status”: “deposited”, “amount_usd”: “23.20”, “fiat_amount”: null, “fiat_currency”: null, “amount_trim”: “0.00050959”, “amount”: “50959”, “currency”: “BTC”, “fees”: “”, “decimal”: 8, “fee_decimal”: 8, “date”: “Jan 10 2024 12:00:44”, “coefficient”: 1, “fiat_amount_adjusted”: null } ] }, “bill”: null, “type”: 13, “items”: null, “created_at”: “2024-04-01T11:30:43.000000Z”, “updated_at”: “2024-04-01T11:47:07.000000Z”, “on_ramp”: 1, “home_redirect”: null, “has_txs”: 0, “current_txs_count”: 0, “last_status”: “”, “transaction_id”: “6g9zJTIMXW”, “invoice”: null, “invoice_description”: null } ], “page”: “1”, “from”: 1, “to”: 10, “ordersCount”: 713, “totalAmountDeposited”: “$110” }, “message”: “success” }

Example response (401):

{ ‘success’: false, ‘message’: ‘Something went wrong!’, }

php

Example request:

$client = new \GuzzleHttp\Client(); $url = ‘https://dash.zypto.com/api/v2/get-orders‘; $response = $client->post( $url, [ ‘headers’ => [ ‘Content-Type’ => ‘application/json’, ‘Accept’ => ‘application/json’, ‘Authorization’ => ‘Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady’, ], ‘json’ => [ ‘length’ => ’10’, ‘page’ => ‘1’, ‘type’ => ‘4’, ‘period’ => ‘daily’, ‘from’ => ’02-17-2024′, ‘to’ => ’07-17-2024′, ], ] ); $body = $response->getBody(); print_r(json_decode((string) $body));

Example response (200):

{ “success”: true, “data”: { “orders”: [ { “amount”: 21.28, “currency_name”: “USD”, “hash”: “JDJ5JDEwJE1iRzN4aVJrSmlzY1BxVEVHUk5wRC5nTFN1UFJrRnhwdXc4cWUudUlEMHQ5bmpBbjNQRnVX”, “card”: { “id”: 154, “tenant_id”: null, “merchant_id”: 1, “iframe_id”: null, “amount”: “20.00”, “fee_include”: 0, “currency_code”: “USD”, “name”: null, “middlename”: null, “firstName”: null, “surname”: null, “address_line1”: null, “address_line2”: null, “city”: null, “state”: null, “country”: “ca”, “zip”: null, “telephone”: null, “countryCallingCode”: null, “callingCode”: null, “cellPhoneNumber”: null, “email”: “y@devurai.com“, “cards_number”: “6g9zJTIMXW”, “uuid”: “fytgyh-gfhgvhb”, “created_at”: “2024-01-22T10:37:07.000000Z”, “updated_at”: “2024-01-22T10:37:07.000000Z”, “status”: 1, “status_link”: “https://checkout.local/redeem-info/N1UFJrRnhwdXc4cWUudUlEMHQ5bmpBbjNQRnVX“, “order_id”: 747, “amount_deposited”: null }, “data”: { “order_id”: “eNdz6BMSAA”, “user_id”: “”, “order_amount”: “23.20”, “total_fiat_amount”: 0, “fiat_currency”: “USD”, “total_fiat_amount_adjusted”: 0, “card_uuid”: null, “txs”: [ { “deposited”: true, “txid”: “”, “block_explorer”: “”, “confirm_blocks”: “”, “status”: “deposited”, “amount_usd”: “23.20”, “fiat_amount”: null, “fiat_currency”: null, “amount_trim”: “0.00050959”, “amount”: “50959”, “currency”: “BTC”, “fees”: “”, “decimal”: 8, “fee_decimal”: 8, “date”: “Jan 10 2024 12:00:44”, “coefficient”: 1, “fiat_amount_adjusted”: null } ] }, “bill”: null, “type”: 13, “items”: null, “created_at”: “2024-04-01T11:30:43.000000Z”, “updated_at”: “2024-04-01T11:47:07.000000Z”, “on_ramp”: 1, “home_redirect”: null, “has_txs”: 0, “current_txs_count”: 0, “last_status”: “”, “transaction_id”: “6g9zJTIMXW”, “invoice”: null, “invoice_description”: null } ], “page”: “1”, “from”: 1, “to”: 10, “ordersCount”: 713, “totalAmountDeposited”: “$110” }, “message”: “success” }

Example response (401):

{ ‘success’: false, ‘message’: ‘Something went wrong!’, }

python

Example request:

import requests import json

url = ‘https://dash.zypto.com/api/v2/get-orders‘ payload = { “length”: “10”, “page”: “1”, “type”: “4”, “period”: “daily”, “from”: “02-17-2024”, “to”: “07-17-2024” } headers = { ‘Content-Type’: ‘application/json’, ‘Accept’: ‘application/json’, ‘Authorization’: ‘Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady’ }

response = requests.post(url, headers=headers, json=payload) print(response.json())

Example response (200):

{ “success”: true, “data”: { “orders”: [ { “amount”: 21.28, “currency_name”: “USD”, “hash”: “JDJ5JDEwJE1iRzN4aVJrSmlzY1BxVEVHUk5wRC5nTFN1UFJrRnhwdXc4cWUudUlEMHQ5bmpBbjNQRnVX”, “card”: { “id”: 154, “tenant_id”: null, “merchant_id”: 1, “iframe_id”: null, “amount”: “20.00”, “fee_include”: 0, “currency_code”: “USD”, “name”: null, “middlename”: null, “firstName”: null, “surname”: null, “address_line1”: null, “address_line2”: null, “city”: null, “state”: null, “country”: “ca”, “zip”: null, “telephone”: null, “countryCallingCode”: null, “callingCode”: null, “cellPhoneNumber”: null, “email”: “y@devurai.com“, “cards_number”: “6g9zJTIMXW”, “uuid”: “fytgyh-gfhgvhb”, “created_at”: “2024-01-22T10:37:07.000000Z”, “updated_at”: “2024-01-22T10:37:07.000000Z”, “status”: 1, “status_link”: “https://checkout.local/redeem-info/N1UFJrRnhwdXc4cWUudUlEMHQ5bmpBbjNQRnVX“, “order_id”: 747, “amount_deposited”: null }, “data”: { “order_id”: “eNdz6BMSAA”, “user_id”: “”, “order_amount”: “23.20”, “total_fiat_amount”: 0, “fiat_currency”: “USD”, “total_fiat_amount_adjusted”: 0, “card_uuid”: null, “txs”: [ { “deposited”: true, “txid”: “”, “block_explorer”: “”, “confirm_blocks”: “”, “status”: “deposited”, “amount_usd”: “23.20”, “fiat_amount”: null, “fiat_currency”: null, “amount_trim”: “0.00050959”, “amount”: “50959”, “currency”: “BTC”, “fees”: “”, “decimal”: 8, “fee_decimal”: 8, “date”: “Jan 10 2024 12:00:44”, “coefficient”: 1, “fiat_amount_adjusted”: null } ] }, “bill”: null, “type”: 13, “items”: null, “created_at”: “2024-04-01T11:30:43.000000Z”, “updated_at”: “2024-04-01T11:47:07.000000Z”, “on_ramp”: 1, “home_redirect”: null, “has_txs”: 0, “current_txs_count”: 0, “last_status”: “”, “transaction_id”: “6g9zJTIMXW”, “invoice”: null, “invoice_description”: null } ], “page”: “1”, “from”: 1, “to”: 10, “ordersCount”: 713, “totalAmountDeposited”: 110 }, “message”: “success” }

Example response (401):

{ “success”: false, “message”: “Something went wrong!”

Check Balances

POST api/v2/check-account-balance

Content-Type: application/json

Accept: application/json

Authorization: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady

bash

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”

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!” }

javascript

Example request:
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());

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!”
}

php

Example request:
$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));

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!”
}

python

Example request:
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!”
}

Check Referral

POST api/v2/check-referral

Headers
Content-Type
Example: application/json

Accept
Example: application/json

Authorization
Example: Bearer 5ScRiAOgI5BlgdjSwWNUbNagsj8fFCjady

Body Parameters
email
string
Example: illo

bash

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”: “illo” }”

Example response (200):
{
“success”: true,
“message”: “emai@gmail.com
}

Example response (401):
{
“success”: false,
“message”: “Something went wrong!”
}

javascript

Example request:
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”: “illo”
};

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

Example response (200):
{
“success”: true,
“message”: “emai@gmail.com
}

Example response (401):
{
“success”: false,
“message”: “Something went wrong!”
}

php

Example request:
$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’ => ‘illo’
]
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):
{
“success”: true,
“message”: “emai@gmail.com
}

Example response (401):
{
“success”: false,
“message”: “Something went wrong!”
}

python

Example request:
import requests
import json

url = ‘https://dash.zypto.com/api/v2/check-referral
payload = {
“email”: “illo”
}
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”: “emai@gmail.com
}

Example response (401):
{
“success”: false,
“message”: “Something went wrong!”
}

Some endpoints are currently undergoing maintenance and will be available once the updates are completed. The following endpoints are being updated:

-“check-client-balance”
-“on-chain-withdraw”
-“on-chain-deposit”
-“internal-transfer”
-“get-access-token”
-“refresh-access-token”

Postman Collection
Open API

OpenApi Spec Download

Test API Online

Test Here

Subscribe to the Zypto Newsletter!

Don’t Miss a Beat

Get weekly crypto insights and the latest from Zypto - straight to your inbox.

Welcome, Zyptonian!

Share This