API Documentation
This API has been designed to assist individuals and businesses in funding orders with an automated systems. Before you attempt using the API, please make sure that you have setup an API key.

Load Card
Create a transaction to load the card. The main functionality of Nyerium Debit Card website.
URL: https://nyexcc.site/api/load/
Method: POST
Input:
  • api_key - Your Public API Key
  • currency_in - Any available digital currency ISO code available on our loading page.
  • cards - A list of card numbers in the format of expected_amt|load_currency|card_number|card_holder|country_code|phone_number, delimited by commas for multiple cards. The expected amount should be a decimal amount, and is optional (defaults to $10 as we load based on FMV).
Output:
An array of card loading data in the form of status, card number, transaction id, and deposit address.
[{"status":"waiting", "card_number":"4444", "txid":"f5624e2d-fc31-49cc-b64f-f735fd5cf8ed", "deposit_address":"1E8DKgCWqahmGyYPwwkYk97sj5cZf4BZzL"}, {"status":"error", "card_number":false, "message":"Missing Card Number" }]
NOTE: Leave card_holder, country_code and phone_number fields empty if currency_in is KZT, UAH or RUR!

Conversion Rate to Fiat / List Currencies
URL: https://nyexcc.site/api/rate/ [pair]
Method: GET
Input:
  • [Optional] pair - Currency pair of a crypto currency and a fiat currency (eg. btc_eur)
Output:
A single rate pair object, or an array of rate pair objects.
{"pair":"btc_usd","rate":"355.64000000"}


Market Information
URL: https://nyexcc.site/api/market/ [pair]
Method: GET
Input:
  • [Optional] pair - Currency pair of a crypto currency and a fiat currency (eg. btc_eur)
Output:
{"pair":"ltc_eur","rate":"3.68680901","min":"0.01773050","max":"249.05985757"}


Transaction Status
URL: https://nyexcc.site/api/status/ [txid/address]
Method: POST
Input:
  • api_key - Your Private API Key
  • txid / addr - Nyerium Debit Card Transaction ID or the Deposit Address
Output:
{"txid":"158d2cb7-5a74-4793-afa5-063a9411a6e0","address":"NhuJc32N6NhrR4YGHumMhYX13VEeR5yDUu","status":"loaded","card_number":"4444"}
                    


List Transactions
URL: https://nyexcc.site/api/history
Method: POST
Input:
  • api_key - Your Private API Key
  • [Optional] offset - Which record to start returning results from
  • [Optional] limit - How many records to return (See API Limits below)
  • Example:https://nyexcc.site/api/history/758a4569-eb8a-4fd3-129e-f8b33676e354
Output:
An array of transaction information stored in the system
{"txid":"674e3493-a6b6-423a-b346-da4ef9a9bf72","address":"NhuJc32N6NhrR4YGHumMhYX13VEeR5yDUu","status":"waiting","card_number":"4444","card_holder":"John Smith","ccode":"1","phone_number":"12345678","remarks":"Funds appear on card Oct 22, or 23","currency_in":"BTC","currency_out":"USD","currency_out_rate":"296.64000000","satoshi":"0","load_fee":"9","load_pct":1,"input_address":"15x9VHPSYNQTdRzvNVrCB2p52LtopiFrNF","destination_address":"15x9VHPSYNQTdRzvNVrCB2p52LtopiFrNF"}
NOTE: The fields card_holder, country_code and phone_number will be empty if currency_in is KZT, UAH or RUR!

API Limits
In order to ensure that the API is stable for everyone, we have placed safeguards on our systems to prevent abuse. Below is a list of the API Limits and their respective values. For more information, including applying for opting out of API Limits, please contact us .

  • You can query the API up to 30 requests per minute
  • You can load up to 10 cards in one transaction
  • When viewing transaction history, you can set the offset as far back as 100 records
    • In addition, you can return up to 100 records from the offset
    • If a limit is not specified, the system will return up to 10 records