Coinify Merchant API

https://merchant.coinify.com/docs/api
Admin
Coinify Merchant API is a cryptocurrency payment processing API that enables merchants to accept...
Tokens:40,994
Snippets:151
Trust Score:9.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### Get All Altcoin Rates (Python, PHP, cURL)

Source: https://merchant.coinify.com/docs/api/index

This section provides examples for fetching rates of all supported altcoins against a default base currency (BTC). It covers implementations using the Coinify PHP SDK, cURL, and the Coinify Python SDK. The response includes details like name, rate, base currency, and minimum/maximum limits for each altcoin.

```php
<?php
/*
 * Using the Coinify PHP SDK
 */
$api = new CoinifyAPI();
$result = $api->altratesGet();

// ===============================================================

/*
 * Using cURL
 */
$ch = curl_init('https://api.coinify.com/v3/altrates');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode( curl_exec($ch) );
curl_close($ch);
?>
```

```python
"""
Using the Coinify Python SDK
"""
from coinify_api import CoinifyAPI

api = CoinifyAPI()
response = api.altrates_get()

# ================================================================

"""
Using the requests module 
"""
import requests

headers = {
            'Content-Type': 'application/json'
}

url = 'https://api.coinify.com/v3/altrates'
response = requests.request( 'GET', url, headers=headers ).json()
```

--------------------------------

### List All Buy Orders

Source: https://merchant.coinify.com/docs/api/index

Provides examples of how to list all buy orders using the Coinify API, with both PHP (cURL) and Python SDK examples.

```APIDOC
## List All Buy Orders

This endpoint allows you to retrieve a list of all your buy orders.

### Request Example (PHP using cURL)

```php
<?php
/*
 * Using the Coinify PHP SDK
 */
$api = new CoinifyAPI( $apikey, $apisecret );
$result = $api->buyOrdersList();

// ===============================================================

/*
 * Using cURL
 */
$ch = curl_init('https://api.coinify.com/v3/buys');
curl_setopt($ch, CURLOPT_HTTPHEADER, array($auth_header));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode( curl_exec($ch) );
curl_close($ch);
?>
```

### Request Example (Python SDK)

```python
"""
Using the Coinify Python SDK
"""
from coinify_api import CoinifyAPI

api = CoinifyAPI( apikey, apisecret )
response = api.buy_orders_list()
```
```

--------------------------------

### GET /currencies

Source: https://merchant.coinify.com/docs/api/index

List all supported input currencies.

```APIDOC
## GET /currencies

### Description
Retrieves a list of all currencies that Coinify supports as input for payments and other transactions.

### Method
GET

### Endpoint
`/v3/currencies`

### Response
#### Success Response (200)
- **currencies** (array) - An array of currency objects, each containing details like code and name.

#### Response Example
```json
{
  "currencies": [
    {
      "code": "EUR",
      "name": "Euro"
    },
    {
      "code": "BTC",
      "name": "Bitcoin"
    },
    {
      "code": "USD",
      "name": "United States Dollar"
    }
  ]
}
```
```

--------------------------------

### Get Specific Altcoin Rates (Python, PHP, cURL)

Source: https://merchant.coinify.com/docs/api/index

This section details how to retrieve rates for a specific altcoin. Examples are provided for the Coinify PHP SDK, cURL, and the Coinify Python SDK. The endpoint allows specifying the altcoin for which rates are requested.

```php
<?php
/*
 * Using the Coinify PHP SDK
 */
$api = new CoinifyAPI();
$result = $api->altratesGet($altcoin);

// ===============================================================

/*
 * Using cURL
 */
$ch = curl_init('https://api.coinify.com/v3/altrates/<altcoin>');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode( curl_exec($ch) );
curl_close($ch);
?>
```

```python
"""
Using the Coinify Python SDK
"""
from coinify_api import CoinifyAPI

api = CoinifyAPI()
response = api.altrates_get(altcoin)
```

--------------------------------

### List all payments (Python SDK)

Source: https://merchant.coinify.com/docs/api/index

Example of how to list all payments using the Coinify Python SDK.

```APIDOC
## List all payments (Python SDK)

### Description
This code snippet demonstrates how to retrieve a list of all payments using the Coinify Python SDK.

### Method
GET

### Endpoint
/v3/payments

### Request Example
```python
"""
Using the Coinify Python SDK
"""
from coinify_api import CoinifyAPI

api = CoinifyAPI( apikey, apisecret )
response = api.invoices_list()
```
```

--------------------------------

### Get All Currency Rates (Python, PHP, cURL)

Source: https://merchant.coinify.com/docs/api/index

This section demonstrates how to retrieve all available currency exchange rates from the Coinify API. It includes examples using Python's requests library, the Coinify PHP SDK, and cURL. The API returns a JSON object containing success status and a 'data' object with rates for various currencies.

```python
"""
Using the requests module 
"""
import requests

headers = {
            'Content-Type': 'application/json'
}

url = 'https://api.coinify.com/v3/rates'
response = requests.request( 'GET', url, headers=headers ).json()
```

```php
<?php
/*
 * Using the Coinify PHP SDK
 */
$api = new CoinifyAPI();
$result = $api->ratesGet($currency);

// ===============================================================

/*
 * Using cURL
 */
$ch = curl_init('https://api.coinify.com/v3/rates/<currency>');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode( curl_exec($ch) );
curl_close($ch);
?>
```

```python
"""
Using the Coinify Python SDK
"""
from coinify_api import CoinifyAPI

api = CoinifyAPI()
response = api.rates_get(currency)

# ================================================================

"""
Using the requests module 
"""
import requests

headers = {
            'Content-Type': 'application/json'
}

url = 'https://api.coinify.com/v3/rates/<currency>'
response = requests.request( 'GET', url, headers=headers ).json()
```

--------------------------------

### List all payments (PHP SDK)

Source: https://merchant.coinify.com/docs/api/index

Example of how to list all payments using the Coinify PHP SDK.

```APIDOC
## List all payments (PHP SDK)

### Description
This code snippet demonstrates how to retrieve a list of all payments using the Coinify PHP SDK.

### Method
GET

### Endpoint
/v3/payments

### Request Example
```php
<?php
/*
 * Using the Coinify PHP SDK
 */
$api = new CoinifyAPI( $apikey, $apisecret );
$result = $api->invoicesList();
?>
```
```

--------------------------------

### List Buy Orders using PHP

Source: https://merchant.coinify.com/docs/api/index

Example of how to list all buy orders using the Coinify PHP SDK or a direct cURL request. Requires an API key and secret for authentication.

```php
<?php
/*
 * Using the Coinify PHP SDK
 */
$api = new CoinifyAPI( $apikey, $apisecret );
$result = $api->buyOrdersList();

// ===============================================================

/*
 * Using cURL
 */
$ch = curl_init('https://api.coinify.com/v3/buys');
curl_setopt($ch, CURLOPT_HTTPHEADER, array($auth_header));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode( curl_exec($ch) );
curl_close($ch);
?>
```

--------------------------------

### GET /buyorders

Source: https://merchant.coinify.com/docs/api/index

List all buy orders.

```APIDOC
## GET /buyorders

### Description
Retrieves a list of all buy orders placed through your account. Supports filtering and pagination.

### Method
GET

### Endpoint
`/v3/buyorders`

### Query Parameters
- **limit** (integer) - Optional - The maximum number of buy orders to return.
- **offset** (integer) - Optional - The number of buy orders to skip.
- **status** (string) - Optional - Filter buy orders by status (e.g., 'completed', 'pending').

### Response
#### Success Response (200)
- **buyorders** (array) - An array of buy order objects.

#### Response Example
```json
{
  "buyorders": [
    {
      "id": "buy_111",
      "amount": {
        "currency": "BTC",
        "value": "0.10000000"
      },
      "status": "completed"
    }
  ]
}
```
```

--------------------------------

### List all payments (cURL)

Source: https://merchant.coinify.com/docs/api/index

Example of how to list all payments using cURL.

```APIDOC
## List all payments (cURL)

### Description
This code snippet demonstrates how to retrieve a list of all payments using a cURL request.

### Method
GET

### Endpoint
https://api.coinify.com/v3/payments

### Request Example
```php
<?php
/*
 * Using cURL
 */
$ch = curl_init('https://api.coinify.com/v3/payments');
curl_setopt($ch, CURLOPT_HTTPHEADER, array($auth_header));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode( curl_exec($ch) );
curl_close($ch);
?>
```
```

--------------------------------

### GET /altcoin_rates

Source: https://merchant.coinify.com/docs/api/index

Get all altcoin exchange rates.

```APIDOC
## GET /altcoin_rates

### Description
Retrieves the exchange rates for all supported altcoins against major currencies.

### Method
GET

### Endpoint
`/v3/altcoin_rates`

### Response
#### Success Response (200)
- **altcoin_rates** (object) - An object containing altcoin symbols as keys and their exchange rates against major currencies as values.

#### Response Example
```json
{
  "altcoin_rates": {
    "ETH": {
      "EUR": 2000,
      "USD": 2160
    },
    "XRP": {
      "EUR": 0.5,
      "USD": 0.54
    }
  }
}
```
```

--------------------------------

### GET /rates/{currency}

Source: https://merchant.coinify.com/docs/api/index

Get exchange rates for a specific currency against all other supported currencies.

```APIDOC
## GET /rates/{currency}

### Description
Retrieves exchange rates for a specific currency against all other supported currencies.

### Method
GET

### Endpoint
`/v3/rates/{currency}`

### Path Parameters
- **currency** (string) - Required - The currency code (e.g., 'BTC') for which to fetch rates.

### Response
#### Success Response (200)
- **rates** (object) - An object containing currency codes as keys and their corresponding rates as values against the specified currency.

#### Response Example
```json
{
  "rates": {
    "EUR": 40000,
    "USD": 43200
  }
}
```
```

--------------------------------

### Create Refund using Coinify Python SDK

Source: https://merchant.coinify.com/docs/api/index

Utilizes the Coinify Python SDK to create a refund. This example specifies the payment ID, refund amount, currency, and the customer's email address.

```python
payment_id = 12345
# Refund 100 EUR
refund_amount = 100
refund_currency = 'EUR'
# Refund to email address
email_address = 'customer@coinify.com'

"""
Using the Coinify Python SDK
"""
from coinify_api import CoinifyAPI

api = CoinifyAPI( apikey, apisecret )
response = api.invoice_refund_create( payment_id, 
     amount=refund_amount, currency=refund_currency,
     email_address=email_address )
```

--------------------------------

### API Versioning Example

Source: https://merchant.coinify.com/docs/api/index

This snippet shows the base URL structure for API versioning. All API requests must include a version number in the URL path, such as '/v3'. Currently, version 3 is the only supported version.

```text
https://api.coinify.com/v3
```

--------------------------------

### GET /refunds

Source: https://merchant.coinify.com/docs/api/index

List all refunds associated with payments.

```APIDOC
## GET /refunds

### Description
Retrieves a list of all refunds processed for payments. Supports filtering by payment ID.

### Method
GET

### Endpoint
`/v3/refunds`

### Query Parameters
- **payment_id** (string) - Optional - Filter refunds by the associated payment ID.

### Response
#### Success Response (200)
- **refunds** (array) - An array of refund objects.

#### Response Example
```json
{
  "refunds": [
    {
      "id": "ref_abc",
      "payment_id": "pay_123",
      "amount": {
        "currency": "EUR",
        "value": "50.00"
      },
      "status": "completed"
    }
  ]
}
```
```

--------------------------------

### Respond to HTTP Callback (PHP)

Source: https://merchant.coinify.com/docs/api/index

Example of how to respond to an incoming HTTP callback from Coinify. It demonstrates setting a 200 OK status code and returning an empty body, which is the required behavior regardless of the validation outcome.

```php
<?php
header('HTTP/1.1 200 OK');

// Don't output anything back to the client performing the HTTP callback
?>
```

--------------------------------

### GET /v3/altrates

Source: https://merchant.coinify.com/docs/api/index

Retrieves the rates for all supported altcoins, with default base currency BTC.

```APIDOC
## GET /v3/altrates

### Description
This endpoint retrieves the rates for all supported altcoins. The default base currency is BTC. See the Input currencies section for supported altcoins.

### Method
GET

### Endpoint
`https://api.coinify.com/v3/altrates`

### Parameters
#### Query Parameters
- **baseCurrency** (string) - Optional - Currency to use as base for rates and limits. Defaults to 'BTC'.

### Request Example
```json
{
  "example": "GET https://api.coinify.com/v3/altrates?baseCurrency=USD"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the altcoin rates and limits.
  - **[ALTCOIN_SYMBOL]** (object) - Information for a specific altcoin.
    - **name** (string) - Name of the altcoin.
    - **rate** (number) - The rate of the altcoin against the base currency (e.g., 1 BTC is worth X altcoins).
    - **baseCurrency** (string) - The base currency used for the rate.
    - **limits** (object) - Trading limits for the altcoin.
      - **minimum** (number) - The minimum amount of altcoin supported for transactions.
      - **maximum** (number) - The maximum amount of altcoin supported for transactions.

#### Response Example
```json
{
  "success": true,
  "data": {
    "LTC": {
        "name": "Litecoin",
        "rate":121.55487804,
        "baseCurrency": "BTC",
        "limits": {
            "minimum": 0.00251036,
            "maximum": 1.25518439
        }
     },
     "XRP": {
        "name":"Ripple",
        "rate":54200.65252854,
        "baseCurrency": "BTC",
        "limits": {
            "minimum": 0.0025101,
            "maximum": 1.25505308
        }
     }
  }
}
```
```

--------------------------------

### Get All Exchange Rates - Python

Source: https://merchant.coinify.com/docs/api/index

This snippet demonstrates how to fetch all supported currency exchange rates using the Coinify Python SDK. This endpoint is public and does not require authentication. The response contains buy and sell rates for various currencies relative to BTC.

```python
from coinify_api import CoinifyAPI

# Assuming CoinifyAPI is installed and configured
api = CoinifyAPI()
response = api.rates_get()

if response.get("success", False):
    print("Exchange Rates:", response.get("data"))
else:
    print("Error fetching rates:", response.get("error"))

```

--------------------------------

### Authentication

Source: https://merchant.coinify.com/docs/api/index

Details on how to authenticate API requests using an API key and secret, with examples in PHP and Python.

```APIDOC
## Authentication

> To authorize, use the following code. Make sure to replace `coinifyapikey` and `coinifyapisecret` with your API key and API secret, respectively.

### PHP Example
```php
<?php
// Provide your API key and secret
$apikey = "coinifyapikey";
$apisecret = "coinifyapisecret";

/*
 * Using the Coinify PHP SDK
 */
$api = new CoinifyAPI( $apikey, $apisecret );

// ===============================================================

/*
 * Using cURL
 */
// Generate a nonce
$mt = explode(' ', microtime());
$nonce = $mt[1] . substr($mt[0], 2, 6);

// Concatenate the nonce and the API key
$message = $nonce . $apikey;
// Compute the signature and convert it to lowercase
$signature = strtolower( hash_hmac('sha256', $message, $apisecret, false ) );

// Construct the HTTP Authorization header.
$auth_header = "Authorization: Coinify apikey=\"$apikey\", nonce=\"$nonce\", signature=\"$signature\"";

// We assume that you are using PHP cURL to perform the API calls,
// but you can use any other HTTP client library
// that supports setting custom request headers.
$ch = curl_init('https://api.coinify.com/v3/invoices');
curl_setopt($ch, CURLOPT_HTTPHEADER, array($auth_header));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
?>
```

### Python Example
```python
# Provide your API key and secret
apikey = "coinifyapikey"
apisecret = "coinifyapisecret"

"""
Using the Coinify Python SDK
"""
from coinify_api import CoinifyAPI

api = CoinifyAPI( apikey, apisecret )

# ================================================================

"""
Using the requests module 
"""
import requests, time
import hmac
import hashlib

# Generate nonce, based on the current Unix timestamp
nonce = str( int( time.time() * 1000000 ) )

# Concatenate nonce and API key
message = nonce + apikey

# Compute signature
signature = hmac.new(apisecret.encode('utf-8'), msg=message.encode('utf-8'), digestmod=hashlib.sha256).hexdigest()

# Construct the header
auth_header = 'Coinify apikey="%s", nonce="%s", signature="%s"' % ( apikey, nonce, signature )

# Ready the HTTP headers
headers = {
    'Authorization': auth_header,
    'Content-Type': 'application/json'
}

# Example request using requests module (replace with actual endpoint)
# response = requests.get('https://api.coinify.com/v3/some/endpoint', headers=headers)
```

```

--------------------------------

### GET /v3/buys

Source: https://merchant.coinify.com/docs/api/index

Retrieves a list of all your buy orders, sorted by newest first. Supports filtering and pagination.

```APIDOC
## GET /v3/buys

### Description
Retrieves all your buy orders, sorted by newest first.

### Method
GET

### Endpoint
https://api.coinify.com/v3/buys

### Query Parameters
- **limit** (Integer) - Optional - Maximum number of buy orders to retrieve. Maximum is 200. Defaults to 100.
- **offset** (Integer) - Optional - How many buy orders to skip. Defaults to 0.
- **include_cancelled** (Boolean) - Optional - If set to true, cancelled buy orders are included in the result. Defaults to false.

### Response
#### Success Response (200)
- **success** (Boolean) - Indicates if the request was successful.
- **data** (Array) - An array of buy order objects.
  - **id** (Integer) - Unique identifier for the buy order.
  - **uuid** (String) - Universally unique identifier for the buy order.
  - **create_time** (String) - Timestamp when the buy order was created (ISO 8601 format).
  - **expire_time** (String) - Timestamp when the buy order expires (ISO 8601 format).
  - **state** (String) - Current state of the buy order (e.g., "complete").
  - **fiat_currency** (String) - The fiat currency used for the order (e.g., "USD").
  - **fiat_amount** (Integer) - The amount in fiat currency.
  - **btc_rate** (Float) - The Bitcoin exchange rate at the time of the order.
  - **btc_amount** (Float) - The amount in Bitcoin.
  - **btc_address** (String) - The Bitcoin address for the transaction.
  - **btc_txid** (String) - The Bitcoin transaction ID.
  - **failure_reason** (Null) - Reason for failure, if applicable.
  - **callback_url** (String) - The URL for callbacks.
  - **callback_email** (Null) - The email for callbacks.
  - **custom** (Object) - Custom data associated with the order.
    - **sample_data** (String) - Example custom field.

#### Response Example
```json
{
  "success": true,
  "data": [
    {
      "id": 12345,
      "uuid": "5a0c1a16-d46c-4d20-b919-9cec171791bd",
      "create_time": "2015-01-01T12:00:00Z",
      "expire_time": "2015-01-01T12:01:00Z",
      "state": "complete",
      "fiat_currency": "USD",
      "fiat_amount": 1000,
      "btc_rate": 231.58,
      "btc_amount": 4.31819481,
      "btc_address": "176WSTb4ZMtSKjSampleBitcoinAddress",
      "btc_txid": "bd59acf87db5a7859fd6a95ad69569b5d6bf9dbfa65f6dfa35f2afdbfbcfad1f",
      "failure_reason": null,
      "callback_url": "https://myshop.com/callbacks/coinify",
      "callback_email": null,
      "custom": {
        "sample_data": "value"
      }
    }
  ]
}
```
```

--------------------------------

### GET /v3/rates

Source: https://merchant.coinify.com/docs/api/index

Retrieves the buy and sell rates for all supported fiat currencies against a default base currency (usually USD or EUR).

```APIDOC
## GET /v3/rates

### Description
This endpoint retrieves the rates for all supported fiat currencies. The rates are typically provided against a default base currency.

### Method
GET

### Endpoint
`https://api.coinify.com/v3/rates`

### Parameters
#### Query Parameters
- **baseCurrency** (string) - Optional - The currency to use as the base for the rates. Defaults to BTC.

### Request Example
```json
{
  "example": "GET https://api.coinify.com/v3/rates?baseCurrency=USD"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the currency rates.
  - **[CURRENCY_CODE]** (object) - Information for a specific currency.
    - **name** (string) - The full name of the currency.
    - **buy** (number) - The buy rate for the currency.
    - **sell** (number) - The sell rate for the currency.

#### Response Example
```json
{
  "success": true,
  "data": {
    "AED": {
      "name": "United Arab Emirates Dirham",
      "buy": 1316.8847,
      "sell": 1316.8479
    },
    "AFN": {
      "name": "Afghanistan Afghani",
      "buy": 23532.5964,
      "sell": 23531.9400
    },
    "ALL": {
      "name": "Albanian Lek",
      "buy": 46183.0427,
      "sell": 46181.7545
    }
  }
}
```
```

--------------------------------

### Retrieve a Specific Payment using Coinify PHP SDK

Source: https://merchant.coinify.com/docs/api/index

This code example shows how to retrieve a specific payment by its ID using the Coinify PHP SDK. It initializes the SDK with API credentials and calls the `invoiceGet` method. An API key and secret are required for authentication.

```php
<?php
$payment_id = 12345;

/*
 * Using the Coinify PHP SDK
 */
$api = new CoinifyAPI( $apikey, $apisecret );
$result = $api->invoiceGet($payment_id);
```

--------------------------------

### Get All Exchange Rates - PHP

Source: https://merchant.coinify.com/docs/api/index

This snippet shows how to retrieve all supported currency exchange rates using PHP. It includes examples for both the Coinify PHP SDK and a direct cURL implementation. No API key or secret is required for this public endpoint. The rates are returned in JSON format.

```php
<?php
/*
 * Using the Coinify PHP SDK
 */
// Assuming CoinifyAPI class is available and configured
// $api = new CoinifyAPI();
// $result = $api->ratesGet();
// print_r($result);

/*
 * Using cURL
 */
$ch = curl_init('https://api.coinify.com/v3/rates');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode( curl_exec($ch) );
curl_close($ch);

if ($result && $result->success) {
    echo "Exchange Rates:\n";
    print_r($result->data);
} else {
    echo "Error fetching rates: " . ($result->error->message ?? 'Unknown error');
}
?>

```

--------------------------------

### List Buy Orders using Python

Source: https://merchant.coinify.com/docs/api/index

Demonstrates how to retrieve a list of buy orders using the Coinify Python SDK. Authentication is handled via API key and secret.

```python
"""
Using the Coinify Python SDK
"""
from coinify_api import CoinifyAPI

api = CoinifyAPI( apikey, apisecret )
response = api.buy_orders_list()

```

--------------------------------

### GET /altcoin_rates/{altcoin}

Source: https://merchant.coinify.com/docs/api/index

Get exchange rates for a specific altcoin.

```APIDOC
## GET /altcoin_rates/{altcoin}

### Description
Retrieves the exchange rates for a specific altcoin against major currencies.

### Method
GET

### Endpoint
`/v3/altcoin_rates/{altcoin}`

### Path Parameters
- **altcoin** (string) - Required - The symbol of the altcoin (e.g., 'ETH').

### Response
#### Success Response (200)
- **rates** (object) - An object containing currency codes as keys and their corresponding rates as values against the specified altcoin.

#### Response Example
```json
{
  "rates": {
    "EUR": 2000,
    "USD": 2160
  }
}
```
```

--------------------------------

### Authentication using Python

Source: https://merchant.coinify.com/docs/api/index

Illustrates how to authenticate API requests using the Coinify Python SDK or the 'requests' module. It covers generating a nonce and computing a SHA256 HMAC signature with API credentials.

```python
import requests
import time
import hmac
import hashlib

# Provide your API key and secret
apikey = "coinifyapikey"
apisecret = "coinifyapisecret"

"""
Using the Coinify Python SDK
"""
from coinify_api import CoinifyAPI

api = CoinifyAPI( apikey, apisecret )

# ================================================================

"""
Using the requests module 
"""

# Generate nonce, based on the current Unix timestamp
nonce = str( int( time.time() * 1000000 ) )

# Concatenate nonce and API key
message = nonce + apikey

# Compute signature
signature = hmac.new(apisecret.encode('utf-8'), msg=message.encode('utf-8'), digestmod=hashlib.sha256).hexdigest()

# Construct the header
auth_header = 'Coinify apikey="%s", nonce="%s", signature="%s"' % ( apikey, nonce, signature )

# Ready the HTTP headers
headers = {
    'Authorization': auth_header,
    'Content-Type': 'application/json'
}

# Example API call using requests (replace with actual endpoint)
# response = requests.get('https://api.coinify.com/v3/some_endpoint', headers=headers)

```

--------------------------------

### Instant vs. Non-Instant Orders

Source: https://merchant.coinify.com/docs/api/index

Explains the difference between instant and non-instant buy orders, including the quote process and confirmation requirements.

```APIDOC
## Instant Order Creation

When creating buy orders, you can choose between an instant or a non-instant order.

### Non-Instant Orders

If you create a non-instant order, the API will return a quote. You must then perform another API call to accept the quote and execute the order. Non-instant orders have a **1-minute** window to be accepted before they are cancelled. The `expire_time` field in the buy order object indicates when the order will expire.
```

--------------------------------

### List Payments using Coinify Python SDK

Source: https://merchant.coinify.com/docs/api/index

Illustrates how to list all payments using the Coinify Python SDK. Authentication is handled via API key and secret.

```python
"""
Using the Coinify Python SDK
"""
from coinify_api import CoinifyAPI

api = CoinifyAPI( apikey, apisecret )
response = api.invoices_list()

```

--------------------------------

### GET /payments

Source: https://merchant.coinify.com/docs/api/index

List all payments associated with your account.

```APIDOC
## GET /payments

### Description
Retrieves a list of all payments made or received through your Coinify account. Supports filtering and pagination.

### Method
GET

### Endpoint
`/v3/payments`

### Query Parameters
- **limit** (integer) - Optional - The maximum number of payments to return.
- **offset** (integer) - Optional - The number of payments to skip before starting to collect the result set.
- **status** (string) - Optional - Filter payments by status (e.g., 'completed', 'pending').

### Response
#### Success Response (200)
- **payments** (array) - An array of payment objects.

#### Response Example
```json
{
  "payments": [
    {
      "id": "pay_123",
      "amount": {
        "currency": "EUR",
        "value": "100.00"
      },
      "status": "completed"
    },
    {
      "id": "pay_456",
      "amount": {
        "currency": "BTC",
        "value": "0.50000000"
      },
      "status": "pending"
    }
  ]
}
```
```

--------------------------------

### GET /balance

Source: https://merchant.coinify.com/docs/api/index

Check the balance of your Coinify account.

```APIDOC
## GET /balance

### Description
Retrieves the current balance of your Coinify account across different currencies.

### Method
GET

### Endpoint
`/v3/balance`

### Response
#### Success Response (200)
- **balance** (object) - An object where keys are currency codes and values are the available balances.

#### Response Example
```json
{
  "balance": {
    "BTC": "1.50000000",
    "EUR": "1500.75"
  }
}
```
```

--------------------------------

### GET /buyorders/{id}

Source: https://merchant.coinify.com/docs/api/index

Retrieve details for a specific buy order.

```APIDOC
## GET /buyorders/{id}

### Description
Retrieves detailed information about a specific buy order using its unique identifier.

### Method
GET

### Endpoint
`/v3/buyorders/{id}`

### Path Parameters
- **id** (string) - Required - The unique identifier of the buy order.

### Response
#### Success Response (200)
- **buyorder** (object) - A buy order object containing all details.

#### Response Example
```json
{
  "buyorder": {
    "id": "buy_111",
    "amount": {
      "currency": "BTC",
      "value": "0.10000000"
    },
    "status": "completed",
    "created_at": "2023-10-27T13:00:00Z"
  }
}
```
```

--------------------------------

### Create Buy Order using Coinify API (PHP & Python)

Source: https://merchant.coinify.com/docs/api/index

This snippet demonstrates how to create a new buy order via the Coinify API. It includes examples using both the Coinify PHP SDK with cURL and the Coinify Python SDK with the 'requests' library. Both methods require API credentials and specific order parameters like amount, currency, and destination Bitcoin address.

```php
<?php

$amount = 32.00;
$currency = 'USD';
$btc_address = '176WSTb4ZMtSKjSampleBitcoinAddress';
$instant_order = true;
$callback_url = 'https://myshop.com/callbacks/coinify';
$callback_email = 'callback@example.com';
$custom = ['sample_data' => 'value'];

/*
 * Using the Coinify PHP SDK
 */
$api = new CoinifyAPI( $apikey, $apisecret );
$result = $api->buyOrderCreate( $amount, $currency, $btc_address,
    $instant_order, $callback_url, $callback_email, $custom );

// ===============================================================

/*
 * Using cURL
 */
$params = array(
  'amount' => $amount,
  'currency' => $currency,
  'btc_address' => $btc_address,
  'instant_order' => $instant_order,
  'callback_url' => $callback_url,
  'callback_email' => $callback_email,
  'custom' => $custom
);

$url = 'https://api.coinify.com/v3/buys';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, array($auth_header));
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$result = json_decode( curl_exec($ch) );
curl_close($ch);
?>

```

```python
amount = 32.00
currency = 'USD'
btc_address = '176WSTb4ZMtSKjSampleBitcoinAddress'
instant_order = True
callback_url = 'https://myshop.com/callbacks/coinify'
callback_email = 'callback@example.com'
custom = {'sample_data': 'value'}

"""
Using the Coinify Python SDK
"""
from coinify_api import CoinifyAPI

api = CoinifyAPI( apikey, apisecret )
response = api.buy_order_create( amount, currency, btc_address,
    instant_order, callback_url, callback_email, custom )

# ================================================================

"""
Using the requests module 
"""
import requests

headers = {
            'Authorization': auth_header,
            'Content-Type': 'application/json'
}

params = {
    'amount': amount,
    'currency': currency,
    'btc_address': btc_address,
    'instant_order': instant_order,
    'callback_url': callback_url,
    'callback_email': callback_email,
    'custom': custom
}

url = 'https://api.coinify.com/v3/buys'

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

```

--------------------------------

### POST /buyorders

Source: https://merchant.coinify.com/docs/api/index

Create a new buy order.

```APIDOC
## POST /buyorders

### Description
Creates a new buy order. You specify the amount and currency you want to buy, and the currency you will use to pay.

### Method
POST

### Endpoint
`/v3/buyorders`

### Request Body
- **amount_to_buy** (object) - Required - The amount and currency you wish to buy.
  - **currency** (string) - Required - The currency code to buy (e.g., 'BTC').
  - **value** (string) - Required - The value to buy.
- **payment_currency** (string) - Required - The currency code you will use to pay (e.g., 'EUR').
- **instant** (boolean) - Optional - Set to true for an instant buy order, false for a non-instant order.

### Request Example
```json
{
  "amount_to_buy": {
    "currency": "BTC",
    "value": "0.10000000"
  },
  "payment_currency": "EUR",
  "instant": true
}
```

### Response
#### Success Response (201)
- **buyorder** (object) - The newly created buy order object.

#### Response Example
```json
{
  "buyorder": {
    "id": "buy_222",
    "amount_to_buy": {
      "currency": "BTC",
      "value": "0.10000000"
    },
    "payment_currency": "EUR",
    "status": "pending_payment",
    "created_at": "2023-10-27T14:00:00Z"
  }
}
```
```

--------------------------------

### GET /payments/{id}

Source: https://merchant.coinify.com/docs/api/index

Retrieve details for a specific payment by its ID.

```APIDOC
## GET /payments/{id}

### Description
Retrieves detailed information about a specific payment using its unique identifier.

### Method
GET

### Endpoint
`/v3/payments/{id}`

### Path Parameters
- **id** (string) - Required - The unique identifier of the payment.

### Response
#### Success Response (200)
- **payment** (object) - A payment object containing all details.

#### Response Example
```json
{
  "payment": {
    "id": "pay_123",
    "amount": {
      "currency": "EUR",
      "value": "100.00"
    },
    "status": "completed",
    "created_at": "2023-10-27T10:00:00Z",
    "updated_at": "2023-10-27T10:05:00Z"
  }
}
```
```

--------------------------------

### GET /v3/buys/{ID}

Source: https://merchant.coinify.com/docs/api/index

Retrieves the details of a specific buy order by its ID.

```APIDOC
## GET /v3/buys/{ID}

### Description
Retrieves a specific buy order.

### Method
GET

### Endpoint
https://api.coinify.com/v3/buys/<ID>

### Path Parameters
- **ID** (Integer) - Required - The ID of the buy order to retrieve.

### Response
#### Success Response (200)
- **success** (Boolean) - Indicates if the request was successful.
- **data** (Object) - The buy order object.
  - **id** (Integer) - Unique identifier for the buy order.
  - **uuid** (String) - Universally unique identifier for the buy order.
  - **create_time** (String) - Timestamp when the buy order was created (ISO 8601 format).
  - **expire_time** (String) - Timestamp when the buy order expires (ISO 8601 format).
  - **state** (String) - Current state of the buy order (e.g., "complete").
  - **fiat_currency** (String) - The fiat currency used for the order (e.g., "USD").
  - **fiat_amount** (Integer) - The amount in fiat currency.
  - **btc_rate** (Float) - The Bitcoin exchange rate at the time of the order.
  - **btc_amount** (Float) - The amount in Bitcoin.
  - **btc_address** (String) - The Bitcoin address for the transaction.
  - **btc_txid** (String) - The Bitcoin transaction ID.
  - **failure_reason** (Null) - Reason for failure, if applicable.
  - **callback_url** (String) - The URL for callbacks.
  - **callback_email** (Null) - The email for callbacks.
  - **custom** (Object) - Custom data associated with the order.
    - **sample_data** (String) - Example custom field.

#### Response Example
```json
{
  "success": true,
  "data": {
    "id": 12345,
    "uuid": "5a0c1a16-d46c-4d20-b919-9cec171791bd",
    "create_time": "2015-01-01T12:00:00Z",
    "expire_time": "2015-01-01T12:01:00Z",
    "state": "complete",
    "fiat_currency": "USD",
    "fiat_amount": 1000,
    "btc_rate": 231.58,
    "btc_amount": 4.31819481,
    "btc_address": "176WSTb4ZMtSKjSampleBitcoinAddress",
    "btc_txid": "bd59acf87db5a7859fd6a95ad69569b5d6bf9dbfa65f6dfa35f2afdbfbcfad1f",
    "failure_reason": null,
    "callback_url": "https://myshop.com/callbacks/coinify",
    "callback_email": null,
    "custom": {
      "sample_data": "value"
    }
  }
}
```
```

--------------------------------

### Create Refund using Coinify PHP SDK

Source: https://merchant.coinify.com/docs/api/index

Demonstrates how to create a refund for a payment using the Coinify PHP SDK. It specifies the payment ID, refund amount, currency, and the customer's email address.

```php
<?php
$payment_id = 12345;
// Refund 100 EUR
$refund_amount = 100;
$refund_currency = 'EUR';
// Refund to email address
$email_address = 'customer@coinify.com';

/*
 * Using the Coinify PHP SDK
 */
$api = new CoinifyAPI( $apikey, $apisecret );
$result = $api->invoiceRefundCreate($payment_id, 
    $refund_amount, $refund_currency, $email_address );
?>
```

--------------------------------

### GET /v3/payments/{ID}

Source: https://merchant.coinify.com/docs/api/index

Retrieves the details of a specific payment using its unique ID.

```APIDOC
## GET /v3/payments/{ID}

### Description
Retrieves the details of a specific payment using its unique ID.

### Method
GET

### Endpoint
https://api.coinify.com/v3/payments/<ID>

### Parameters
#### Path Parameters
- **ID** (Integer) - Required - The ID of the payment to retrieve.

### Request Example
```
GET https://api.coinify.com/v3/payments/12345
```

### Response
#### Success Response (200)
- **success** (Boolean) - Indicates if the request was successful.
- **data** (Object) - The payment object.
  - **id** (Integer) - The unique identifier for the payment.
  - **uuid** (String) - The universally unique identifier for the payment.
  - **create_time** (String) - The timestamp when the payment was created (ISO 8601 format).
  - **expire_time** (String) - The timestamp when the payment expires (ISO 8601 format).
  - **state** (String) - The current state of the payment (e.g., 'new', 'paid', 'expired').
  - **type** (String) - The type of the payment (e.g., 'normal').
  - **bitcoin** (Object) - Details related to the Bitcoin payment.
    - **amount** (Float) - The amount in Bitcoin.
    - **address** (String) - The Bitcoin address for the payment.
    - **amount_paid** (Float) - The amount of Bitcoin already paid.
    - **amount_due** (Float) - The remaining amount due in Bitcoin.
    - **payment_uri** (String) - The Bitcoin payment URI.
  - **native** (Object) - Details of the payment in the native currency.
    - **amount** (Float) - The amount in the native currency.
    - **currency** (String) - The native currency code (e.g., 'EUR').
  - **transfer** (Object) - Details of the transfer in the native currency.
    - **amount** (Float) - The amount for the transfer.
    - **currency** (String) - The currency code for the transfer.
  - **description** (String) - A description for the payment.
  - **custom** (Object) - Custom data associated with the payment.
  - **payment_url** (String) - A URL to the payment page.
  - **inputs** (Array) - List of payment inputs (used for payments in different currencies than BTC).
  - **callback_url** (String) - A URL to send payment notifications to.
  - **callback_email** (String or null) - An email address to send payment notifications to.
  - **return_url** (String) - The URL to redirect the user to after a successful payment.
  - **cancel_url** (String) - The URL to redirect the user to if the payment is cancelled.
  - **payments** (Array) - List of Bitcoin transactions associated with this payment.

#### Response Example
```json
{
  "success": true,
  "data": {
    "id": 12345,
    "uuid": "0155d80d-a535-4b10-ab91-0d61f6969ccd",
    "create_time": "2016-01-26T12:09:01Z",
    "expire_time": "2016-01-26T12:24:01Z",
    "state": "new",
    "type": "normal",
    "bitcoin": {
      "amount": 0.00282,
      "address": "14KRwZqXrRxi1mag9B52r5fyn37AiWRPYi",
      "amount_paid": 0,
      "amount_due": 0.00282,
      "payment_uri": "bitcoin:14KRwZqXrRxi1mag9B52r5fyn37AiWRPYi?amount=0.00282&r=https://merchant.coinify.com/payment/abc/def"
    },
    "native": {
      "amount": 1,
      "currency": "EUR"
    },
    "transfer": {
      "amount": 1,
      "currency": "EUR"
    },
    "description": "Sample payment",
    "custom": {
      "sample_data": "value"
    },
    "payment_url": "https://merchant.coinify.com/payment/abc/def",
    "inputs": [],
    "callback_url": "https://myshop.com/callbacks/coinify",
    "callback_email": null,
    "return_url": "https://myshop.com/order_paid/xyz",
    "cancel_url": "https://myshop.com/order_cancelled/xyz",
    "payments": []
  }
}
```
```
Tokens:
Raw