Table of Contents

    API

    Mock Server

    Use this URL to access a mockup of the API server. Your traffic will be recorded and compared to the documentation. You'll find your traffic analysis in the inspector or directly here in the documentation, right next to each resource.

The GoCoin API

The GoCoin API, a.k.a 'Merchant Core' provides core functionality for merchants/users to manage their resources and accept crypto-currency payments.

Open Source Libraries

node.js
php
java
.NET
ruby

Warning

The API is subject to change without notice. Please contact support@gocoin.com if you have any issues.

All requests are prefixed with "/api/v1"
ie:
https://api.gocoin.com/api/v1/merchants/:id
or
https://api.gocoin.com/api/v1/oauth/token

Please see the GoCoin Knowledgebase for more information on integrating with the API

Authorization (OAuth)

Get an access token.

POST

/oauth/token

Get an access token using the 'Authorization Code' grant type. This article has more information.

Response

200 (OK)
{
 "grant_type"    : "authorization_code",
 "code"          : "efsdSDASDlkfjoeiwjwekfmwemfwbvlbwi4d",
 "client_id"     : "676YDu5PS2hR8jbGhH2NSpsfGp7swUkWVWhRJnE5SwJKn2dePdE5rkNUwdve5qYw",
 "client_secret" : "rSMPwVhf2DXvcYh55bEh2exxVThWFgsnMZcyNjMNN8ShcMzab9smcxVrGbvwU9Ex",
 "redirect_uri"  : "http://etc.com"
}

Accounts

Manage accounts.

GoCoin currency accounts cannot be created or deleted.

GET

/merchants/:merchant_id/accounts

Gets a list of accounts and balances associated with a merchant.

Response

200 (OK)
[
    {
        "id": "b07996e8-38ed-11e3-a3de-080027fd9579",
        "currency": "BTC",
        "balance": "3.45100000"
    },
    {
        "id": "a840e3b4-38ed-11e3-b1e4-080027fd9579",
        "currency": "USD",
        "balance": "0.00"
    }
]

GET

/accounts/:account_id/transactions?start_time=:start_time&end_time=:end_time&page=:page_number&per_page=:per_page

Response

200 (OK)
{
    "status": 200,
    "transactions": [
        {
            "type": "credit",
            "amount": "61.0",
            "created_at": "2014-02-14T00:03:00.329Z",
            "commercial_document_id": "4fd17327-fe70-4fb2-a517-ce930cc71738",
            "commercial_document_type": "Invoice"
        },
        {
            "type": "debit",
            "amount": "1.0",
            "created_at": "2014-02-13T23:47:02.813Z",
            "commerical_document_id": "4b725260-5e00-4e8f-9962-9f5b36defdce",
            "commercial_document_type": "CurrencyConversion"
        },
        {
            "type": "credit",
            "amount": "0.01",
            "created_at": "2014-02-13T23:47:02.811Z",
            "commercial_document_id": "4b725260-5e00-4e8f-9962-9f5b36defdce",
            "commercial_document_type": "Invoice"
        }
    ],
    "paging_info": {
        "total": 7,
        "page": 2,
        "per_page": 3
    }
}

Invoices

Manage invoices.

POST

/merchants/:merchant_id/invoices

Create a new invoice.

Response

201 (Created)
Location: https://api.gocoin.com/api/v1/invoices/:invoice_id
{
    "id": "84c4fc04-66f2-49a5-a12a-36baf7f9f450",
    "status": "unpaid",
    "payment_address": "1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "price": "1.00000000",
    "crypto_balance_due": "1.00000000",
    "price_currency": "BTC",
    "valid_bill_payment_currencies": null,
    "base_price": "600.00",
    "base_price_currency": "USD",
    "service_fee_rate": "0.1",
    "usd_spot_rate": "1.0",
    "spot_rate": "0.00166667",
    "inverse_spot_rate": "600.0",
    "crypto_payout_split": "100",
    "confirmations_required": 2,
    "crypto_url": null,
    "gateway_url": "https://gateway.gocoin.com/invoices/84c4fc04-66f2-49a5-a12a-36baf7f9f450",
    "notification_level": null,
    "redirect_url": "http://www.example.com/redirect",
    "order_id": null,
    "refund_address": null,
    "item_name": null,
    "item_sku": null,
    "item_description": null,
    "physical": null,
    "customer_name": null,
    "customer_address_1": null,
    "customer_address_2": null,
    "customer_city": null,
    "customer_region": null,
    "customer_country": null,
    "customer_postal_code": null,
    "customer_email": null,
    "customer_phone": null,
    "user_defined_1": null,
    "user_defined_2": null,
    "user_defined_3": null,
    "user_defined_4": null,
    "user_defined_5": null,
    "user_defined_6": null,
    "user_defined_7": null,
    "user_defined_8": null,
    "data": null,
    "expires_at": "2014-01-02T22:08:09.599Z",
    "created_at": "2014-01-02T21:53:10.867Z",
    "updated_at": "2014-01-02T21:53:10.867Z",
    "server_time": "2014-01-02T23:59:12Z",
    "callback_url": "https://www.example.com/gocoin/callback",
    "merchant_id": "7af834d9-aa7a-423c-be16-33ea6a724007"
}

GET

/invoices/:invoice_id

Gets an invoice.

Response

200 (OK)
{
    "id": "84c4fc04-66f2-49a5-a12a-36baf7f9f450",
    "status": "unpaid",
    "payment_address": "1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "price": "1.00000000",
    "crypto_balance_due": "1.00000000",
    "price_currency": "BTC",
    "valid_bill_payment_currencies": null,
    "base_price": "600.00",
    "base_price_currency": "USD",
    "service_fee_rate": "0.01",
    "usd_spot_rate": "1.0",
    "spot_rate": "0.001666667",
    "inverse_spot_rate": "600.0",
    "crypto_payout_split": "100",
    "confirmations_required": 2,
    "crypto_url": null,
    "gateway_url": "https://gateway.gocoin.com/invoices/84c4fc04-66f2-49a5-a12a-36baf7f9f450",
    "notification_level": null,
    "redirect_url": "http://www.example.com/redirect",
    "order_id": null,
    "refund_address": null,
    "item_name": null,
    "item_sku": null,
    "item_description": null,
    "physical": null,
    "customer_name": null,
    "customer_address_1": null,
    "customer_address_2": null,
    "customer_city": null,
    "customer_region": null,
    "customer_country": null,
    "customer_postal_code": null,
    "customer_email": null,
    "customer_phone": null,
    "user_defined_1": null,
    "user_defined_2": null,
    "user_defined_3": null,
    "user_defined_4": null,
    "user_defined_5": null,
    "user_defined_6": null,
    "user_defined_7": null,
    "user_defined_8": null,
    "data": null,
    "expires_at": "2014-01-02T22:08:09.599Z",
    "created_at": "2014-01-02T21:53:10.867Z",
    "updated_at": "2014-01-02T21:53:10.867Z",
    "server_time": "2014-01-02T23:59:12Z",
    "callback_url": "https://www.example.com/gocoin/callback",
    "merchant_id": "7af834d9-aa7a-423c-be16-33ea6a724007"
}

GET

/invoices/search?merchant_id=:merchant_id&status=:status&start_time=:start_time&end_time=:end_time&order_id=:order_id&customer_name=:customer_name&item_name=:item_name&updated_since=:last_updated_time&page=:page_number&per_page=:per_page

Searches invoices.

Response

200 (OK)
{
    "status": 200,
    "invoices": [
        {
            "id": "84c4fc04-66f2-49a5-a12a-36baf7f9f450",
            "status": "unpaid",
            "payment_address": "1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "price": "1.00000000",
            "crypto_balance_due": "1.00000000",
            "price_currency": "BTC",
            "valid_bill_payment_currencies": null,
            "base_price": "600.00",
            "base_price_currency": "USD",
            "service_fee_rate": "0.01",
            "usd_spot_rate": "1.0",
            "spot_rate": "0.001666667",
            "inverse_spot_rate": "600.0",
            "crypto_payout_split": "100",
            "confirmations_required": 2,
            "crypto_url": null,
            "gateway_url": "https://gateway.gocoin.com/invoices/84c4fc04-66f2-49a5-a12a-36baf7f9f450",
            "notification_level": null,
            "redirect_url": "http://www.example.com/redirect",
            "order_id": null,
            "refund_address": null,
            "item_name": null,
            "item_sku": null,
            "item_description": null,
            "physical": null,
            "customer_name": null,
            "customer_address_1": null,
            "customer_address_2": null,
            "customer_city": null,
            "customer_region": null,
            "customer_country": null,
            "customer_postal_code": null,
            "customer_email": null,
            "customer_phone": null,
            "user_defined_1": null,
            "user_defined_2": null,
            "user_defined_3": null,
            "user_defined_4": null,
            "user_defined_5": null,
            "user_defined_6": null,
            "user_defined_7": null,
            "user_defined_8": null,
            "data": null,
            "expires_at": "2013-10-01T18:47:45.150Z",
            "created_at": "2013-10-01T18:32:45.153Z",
            "updated_at": "2013-10-01T18:32:45.153Z",
            "server_time": "2014-06-24T19:03:16Z",
            "callback_url": "https://www.example.com/gocoin/callback",
            "merchant_id": "63d3cd4c-1514-11e3-a3f0-080027fd9579"
        },
        {
            "id": "432fcd70-fbdc-11e3-a3ac-0800200c9a66",
            "status": "paid",
            "payment_address": "1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "price": "1.00000000",
            "crypto_balance_due": "0.0",
            "price_currency": "BTC",
            "valid_bill_payment_currencies": null,
            "base_price": "600.00",
            "base_price_currency": "USD",
            "service_fee_rate": "0.01",
            "usd_spot_rate": "1.0",
            "spot_rate": "0.001666667",
            "inverse_spot_rate": "600.0",
            "crypto_payout_split": "100",
            "confirmations_required": 2,
            "crypto_url": null,
            "gateway_url": "https://gateway.gocoin.com/invoices/432fcd70-fbdc-11e3-a3ac-0800200c9a66",
            "notification_level": null,
            "redirect_url": "http://www.example.com/redirect",
            "order_id": null,
            "refund_address": null,
            "item_name": null,
            "item_sku": null,
            "item_description": null,
            "physical": null,
            "customer_name": null,
            "customer_address_1": null,
            "customer_address_2": null,
            "customer_city": null,
            "customer_region": null,
            "customer_country": null,
            "customer_postal_code": null,
            "customer_email": null,
            "customer_phone": null,
            "user_defined_1": null,
            "user_defined_2": null,
            "user_defined_3": null,
            "user_defined_4": null,
            "user_defined_5": null,
            "user_defined_6": null,
            "user_defined_7": null,
            "user_defined_8": null,
            "data": null,
            "expires_at": "2013-11-01T18:47:45.150Z",
            "created_at": "2013-11-01T18:32:45.153Z",
            "updated_at": "2013-11-01T18:32:45.153Z",
            "server_time": "2014-06-24T19:03:16Z",
            "callback_url": "https://www.example.com/gocoin/callback",
            "merchant_id": "63d3cd4c-1514-11e3-a3f0-080027fd9579"
        },
        {
            "id": "3a1ccdf0-fbdc-11e3-a3ac-0800200c9a66",
            "status": "ready_to_ship",
            "payment_address": "1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "price": "1.00000000",
            "crypto_balance_due": "0.0",
            "price_currency": "BTC",
            "valid_bill_payment_currencies": null,
            "base_price": "600.00",
            "base_price_currency": "USD",
            "service_fee_rate": "0.01",
            "usd_spot_rate": "1.0",
            "spot_rate": "0.001666667",
            "inverse_spot_rate": "600.0",
            "crypto_payout_split": "100",
            "confirmations_required": 2,
            "crypto_url": null,
            "gateway_url": "https://gateway.gocoin.com/invoices/3a1ccdf0-fbdc-11e3-a3ac-0800200c9a66",
            "notification_level": null,
            "redirect_url": "http://www.example.com/redirect",
            "order_id": null,
            "refund_address": null,
            "item_name": null,
            "item_sku": null,
            "item_description": null,
            "physical": null,
            "customer_name": null,
            "customer_address_1": null,
            "customer_address_2": null,
            "customer_city": null,
            "customer_region": null,
            "customer_country": null,
            "customer_postal_code": null,
            "customer_email": null,
            "customer_phone": null,
            "user_defined_1": null,
            "user_defined_2": null,
            "user_defined_3": null,
            "user_defined_4": null,
            "user_defined_5": null,
            "user_defined_6": null,
            "user_defined_7": null,
            "user_defined_8": null,
            "data": null,
            "expires_at": "2013-12-01T18:47:45.150Z",
            "created_at": "2013-12-01T18:32:45.153Z",
            "updated_at": "2013-12-01T18:32:45.153Z",
            "server_time": "2014-06-24T19:03:16Z",
            "callback_url": "https://www.example.com/gocoin/callback",
            "merchant_id": "63d3cd4c-1514-11e3-a3f0-080027fd9579"
        }
    ],
    "paging_info": {
        "total": 31,
        "page": 1,
        "per_page": 3
    }
}

PUT

/invoices/:invoice_id/refresh_merchant_review_spot_rate

Refresh the spot rate of an invoice in Merchant Review

Response

200 (OK)
{
    "id":"4d4607cf-a2b0-4fc4-acb4-93350e04e94c",
    "merchant_id":"78966b46-fe9d-47ac-af61-e1ea1cfab855",
    "status":"merchant_review",
    "payment_address":"14j3ZHx7JE7yBCVXWQDDQz6MDohSygTuhB",
    "refund_address":null,
    "crypto_url":null,
    "gateway_url":"https://gateway.gocoin.com/invoices/4d4607cf-a2b0-4fc4-acb4-93350e04e94c",
    "redirect_url":null,
    "callback_url":null,
    "base_price":"0.02",
    "price":"0.00010000",
    "crypto_balance_due":"0.0",
    "crypto_payout_split":100,
    "service_fee_rate":0.01,
    "base_price_currency":"USD",
    "price_currency":"BTC",
    "payout_currency":"USD",
    "base_price_currency_detail":{"id":"USD","name":"United States Dollar"
    ,"symbol":"$","is_crypto":false,"sort_order":100,"precision":2,"aliases":[]},
    "price_currency_detail":{"id":"BTC","name":"Bitcoin","symbol":"Ƀ","is_crypto":true,"sort_order":1,"precision":8,"aliases":["XBT"
    ]},
    "payout_currency_detail":{"id":"USD","name":"United States Dollar","symbol":"$","is_crypto":false
    ,"sort_order":100,"precision":2,"aliases":[]},
    "spot_rate":"0.005",
    "inverse_spot_rate":"200.0",
    "usd_spot_rate":"1.0",
    "valid_bill_payment_currencies":null,
    "valid_bill_payment_currency_details":null,
    "merchant_review_reason":"Paid late",
    "merchant_review_gain_loss":{"payout_currency":"0.0","price_currency":"0.0"},
    "merchant_review_spot_rate":"0.002",
    "order_id":null,
    "item_name":null,
    "item_sku":null,
    "item_description":null,
    "physical":null,
    "customer_name":null,
    "customer_address_1":null,
    "customer_address_2":null,
    "customer_city":null,
    "customer_region":null,
    "customer_country":null,
    "customer_postal_code":null,
    "customer_email":null,
    "customer_phone":null,
    "user_defined_1":null,
    "user_defined_2":null,
    "user_defined_3":null,
    "user_defined_4":null,
    "user_defined_5":null,
    "user_defined_6":null,
    "user_defined_7":null,
    "user_defined_8":null,
    "data":null,
    "expires_at":"2015-02-12T20:17:46.644Z",
    "created_at":"2015-02-12T19:43:38.127Z",
    "updated_at":"2015-05-12T23:33:51.945Z",
    "server_time":"2015-05-12T23:33:51.965Z"
}

PUT

/invoices/:invoice_id/cancel

Reject an invoice that is in Merchant Review

Response

200 (OK)
{
    "id":"4d4607cf-a2b0-4fc4-acb4-93350e04e94c",
    "merchant_id":"78966b46-fe9d-47ac-af61-e1ea1cfab855",
    "status":"merchant_review",
    "payment_address":"14j3ZHx7JE7yBCVXWQDDQz6MDohSygTuhB",
    "refund_address":"1AkUkFZScRPCAPVuJrvhTQu9s3SsMEUwee",
    "crypto_url":null,
    "gateway_url":"https://gateway.gocoin.com/invoices/4d4607cf-a2b0-4fc4-acb4-93350e04e94c",
    "redirect_url":null,
    "callback_url":null,
    "base_price":"0.02",
    "price":"0.00010000",
    "crypto_balance_due":"0.0",
    "crypto_payout_split":100,
    "service_fee_rate":0.01,
    "base_price_currency":"USD",
    "price_currency":"BTC",
    "payout_currency":"USD",
    "base_price_currency_detail":{"id":"USD","name":"United States Dollar"
    ,"symbol":"$","is_crypto":false,"sort_order":100,"precision":2,"aliases":[]},
    "price_currency_detail":{"id":"BTC","name":"Bitcoin","symbol":"Ƀ","is_crypto":true,"sort_order":1,"precision":8,"aliases":["XBT"
    ]},
    "payout_currency_detail":{"id":"USD","name":"United States Dollar","symbol":"$","is_crypto":false
    ,"sort_order":100,"precision":2,"aliases":[]},
    "spot_rate":"0.005",
    "inverse_spot_rate":"200.0",
    "usd_spot_rate":"1.0",
    "valid_bill_payment_currencies":null,
    "valid_bill_payment_currency_details":null,
    "merchant_review_reason":"Paid late",
    "merchant_review_gain_loss":{"payout_currency":"0.0","price_currency":"0.0"},
    "merchant_review_spot_rate":"0.002",
    "order_id":null,
    "item_name":null,
    "item_sku":null,
    "item_description":null,
    "physical":null,
    "customer_name":null,
    "customer_address_1":null,
    "customer_address_2":null,
    "customer_city":null,
    "customer_region":null,
    "customer_country":null,
    "customer_postal_code":null,
    "customer_email":null,
    "customer_phone":null,
    "user_defined_1":null,
    "user_defined_2":null,
    "user_defined_3":null,
    "user_defined_4":null,
    "user_defined_5":null,
    "user_defined_6":null,
    "user_defined_7":null,
    "user_defined_8":null,
    "data":null,
    "expires_at":"2015-02-12T20:17:46.644Z",
    "created_at":"2015-02-12T19:43:38.127Z",
    "updated_at":"2015-05-12T23:33:51.945Z",
    "server_time":"2015-05-12T23:33:51.965Z"
}

PUT

/invoices/:invoice_id/accept

Accept the spot rate of an invoice in Merchant Review

Response

200 (OK)
{
    "id":"4d4607cf-a2b0-4fc4-acb4-93350e04e94c",
    "merchant_id":"78966b46-fe9d-47ac-af61-e1ea1cfab855",
    "status":"merchant_review",
    "payment_address":"14j3ZHx7JE7yBCVXWQDDQz6MDohSygTuhB",
    "refund_address":null,
    "crypto_url":null,
    "gateway_url":"https://gateway.gocoin.com/invoices/4d4607cf-a2b0-4fc4-acb4-93350e04e94c",
    "redirect_url":null,
    "callback_url":null,
    "base_price":"0.02",
    "price":"0.00010000",
    "crypto_balance_due":"0.0",
    "crypto_payout_split":100,
    "service_fee_rate":0.01,
    "base_price_currency":"USD",
    "price_currency":"BTC",
    "payout_currency":"USD",
    "base_price_currency_detail":{"id":"USD","name":"United States Dollar"
    ,"symbol":"$","is_crypto":false,"sort_order":100,"precision":2,"aliases":[]},
    "price_currency_detail":{"id":"BTC","name":"Bitcoin","symbol":"Ƀ","is_crypto":true,"sort_order":1,"precision":8,"aliases":["XBT"
    ]},
    "payout_currency_detail":{"id":"USD","name":"United States Dollar","symbol":"$","is_crypto":false
    ,"sort_order":100,"precision":2,"aliases":[]},
    "spot_rate":"0.005",
    "inverse_spot_rate":"200.0",
    "usd_spot_rate":"1.0",
    "valid_bill_payment_currencies":null,
    "valid_bill_payment_currency_details":null,
    "merchant_review_reason":"Paid late",
    "merchant_review_gain_loss":{"payout_currency":"0.0","price_currency":"0.0"},
    "merchant_review_spot_rate":"0.002",
    "order_id":null,
    "item_name":null,
    "item_sku":null,
    "item_description":null,
    "physical":null,
    "customer_name":null,
    "customer_address_1":null,
    "customer_address_2":null,
    "customer_city":null,
    "customer_region":null,
    "customer_country":null,
    "customer_postal_code":null,
    "customer_email":null,
    "customer_phone":null,
    "user_defined_1":null,
    "user_defined_2":null,
    "user_defined_3":null,
    "user_defined_4":null,
    "user_defined_5":null,
    "user_defined_6":null,
    "user_defined_7":null,
    "user_defined_8":null,
    "data":null,
    "expires_at":"2015-02-12T20:17:46.644Z",
    "created_at":"2015-02-12T19:43:38.127Z",
    "updated_at":"2015-05-12T23:33:51.945Z",
    "server_time":"2015-05-12T23:33:51.965Z"
}

Merchants

GET

/merchants

Admin-Only: Gets a list of all merchants.

Response

200 (OK)
Content-Type: application/json
[
    {
        "id": "08d3bedf-7cb3-4ccc-9d20-cd221df9443d",
        "name": "BlingBling",
        "address_1": "100 Main St.",
        "address_2": null,
        "city": "Venice",
        "region": "CA",
        "country_code": "US",
        "postal_code": "90291",
        "contact_name": "Dr. Merchant",
        "contact_email": "merchant@example.com",
        "phone": "555-555-1234",
        "website": "http://merchant.com",
        "description": null,
        "logo_url": null,
        "is_verified": true,
        "terms_of_service_id": 1,
        "terms_of_service_accepted_at": "2013-08-13T04:10:22.511Z",
        "is_tos_current": false,
        "created_at": "2013-08-13T04:07:43.867Z",
        "updated_at": "2013-08-13T04:10:49.785Z",
        "currencies": [
        {
            "currency": "BTC",
            "service_fee_rate": 0.01,
            "payment_crypto_split": 0
        },
        {
            "currency": "LTC",
            "service_fee_rate": 0.01,
            "payment_crypto_split": 0
        },
        {
            "currency": "XDG",
            "service_fee_rate": 0.01,
            "payment_crypto_split": 0
        }
        ]
    }
]

POST

/merchants

Admin-Only: Adds a new merchant.

Response

201 (Created)
Content-Type: application/json
{
    "id": "d07cde90-fbdf-11e3-a3ac-0800200c9a66",
    "name" : "Blingin' Merchant", 
    "address_1" : "123 Main St.",
    "address_2": "Suite 1", 
    "city" : "Los Angeles", 
    "region": "CA", 
    "country_code": "US", 
    "postal_code" : "90000", 
    "contact_name": "Bling McBlingerton", 
    "contact_email": "merchant@example.com",
    "phone": "1-555-555-5555", 
    "website": "http://www.blinginmerchant.com", 
    "description": "Some description.", 
    "logo_url": null,
    "is_verified": true,
    "terms_of_service_id": 1,
    "terms_of_service_accepted_at": "2013-08-13T04:10:22.511Z",
    "is_tos_current": false,
    "created_at": "2013-08-13T04:07:43.867Z",
    "updated_at": "2013-08-13T04:10:49.785Z",
    "currencies": [
    {
        "currency": "BTC",
        "service_fee_rate": 0.01,
        "payment_crypto_split": 0
    },
    {
        "currency": "LTC",
        "service_fee_rate": 0.01,
        "payment_crypto_split": 0
    },
    {
        "currency": "XDG",
        "service_fee_rate": 0.01,
        "payment_crypto_split": 0
    }
    ]
}

GET

/merchants/:merchant_id

Gets an existing merchant.

Response

200 (OK)
Content-Type: application/json
{
    "id": "d07cde90-fbdf-11e3-a3ac-0800200c9a66",
    "name" : "Blingin' Merchant", 
    "address_1" : "123 Main St.",
    "address_2": "Suite 1", 
    "city" : "Los Angeles", 
    "region": "CA", 
    "country_code": "US", 
    "postal_code" : "90000", 
    "contact_name": "Bling McBlingerton", 
    "contact_email": "merchant@example.com",
    "phone": "1-555-555-5555", 
    "website": "http://www.blinginmerchant.com", 
    "description": "Some description.", 
    "logo_url": null,
    "is_verified": true,
    "terms_of_service_id": 1,
    "terms_of_service_accepted_at": "2013-08-13T04:10:22.511Z",
    "is_tos_current": false,
    "created_at": "2013-08-13T04:07:43.867Z",
    "updated_at": "2013-08-13T04:10:49.785Z",
    "currencies": [
    {
        "currency": "BTC",
        "service_fee_rate": 0.01,
        "payment_crypto_split": 0
    },
    {
        "currency": "LTC",
        "service_fee_rate": 0.01,
        "payment_crypto_split": 0
    },
    {
        "currency": "XDG",
        "service_fee_rate": 0.01,
        "payment_crypto_split": 0
    }
    ]
}

GET

/merchants/:merchant_id/children

White Label Admin-Only: Lists the child merchants of an existing merchant.

Response

200 (OK)
Content-Type: application/json
[
    {
        "id": "d07cde90-fbdf-11e3-a3ac-0800200c9a66",
        "name" : "Blingin' Merchant", 
        "address_1" : "123 Main St.",
        "address_2": "Suite 1", 
        "city" : "Los Angeles", 
        "region": "CA", 
        "country_code": "US", 
        "postal_code" : "90000", 
        "contact_name": "Bling McBlingerton", 
        "contact_email": "merchant@example.com",
        "phone": "1-555-555-5555", 
        "website": "http://www.blinginmerchant.com", 
        "description": "Some description.", 
        "logo_url": null,
        "is_verified": true,
        "terms_of_service_id": 1,
        "terms_of_service_accepted_at": "2013-08-13T04:10:22.511Z",
        "is_tos_current": false,
        "created_at": "2013-08-13T04:07:43.867Z",
        "updated_at": "2013-08-13T04:10:49.785Z",
        "currencies": [
        {
            "currency": "BTC",
            "service_fee_rate": 0.01,
            "payment_crypto_split": 0
        },
        {
            "currency": "LTC",
            "service_fee_rate": 0.01,
            "payment_crypto_split": 0
        },
        {
            "currency": "XDG",
            "service_fee_rate": 0.01,
            "payment_crypto_split": 0
        }
        ]
    }
]

PATCH

/merchants/:merchant_id

Updates an existing merchant.

Response

200 (OK)
Content-Type: application/json
{
    "id": "d07cde90-fbdf-11e3-a3ac-0800200c9a66",
    "name" : "Blingin' Merchant", 
    "address_1" : "123 Main St.",
    "address_2": "Suite 1", 
    "city" : "Los Angeles", 
    "region": "CA", 
    "country_code": "US", 
    "postal_code" : "90000", 
    "contact_name": "Bling McBlingerton", 
    "contact_email": "merchant@example.com",
    "phone": "1-555-555-5555", 
    "website": "http://www.blinginmerchant.com", 
    "description": "Different description.", 
    "logo_url": null,
    "is_verified": true,
    "terms_of_service_id": 1,
    "terms_of_service_accepted_at": "2013-08-13T04:10:22.511Z",
    "is_tos_current": false,
    "created_at": "2013-08-13T04:07:43.867Z",
    "updated_at": "2013-08-13T04:10:49.785Z",
    "currencies": [
    {
        "currency": "BTC",
        "service_fee_rate": 0.01,
        "payment_crypto_split": 0
    },
    {
        "currency": "LTC",
        "service_fee_rate": 0.01,
        "payment_crypto_split": 0
    },
    {
        "currency": "XDG",
        "service_fee_rate": 0.01,
        "payment_crypto_split": 0
    }
    ]
}

Payouts

Manage payouts to Merchants.

GET

/merchants/:merchant_id/payouts/:payout_id?verbose=:verbosity

Gets an existing merchant payout.

Response

200 (OK)
Content-Type: application/json
{
    "id": "c5307e14-1c60-4719-b93d-4ea6e8540a20",
    "payout_account_id": "f0b893cc-240e-409f-938e-44f3bbf96066",
    "currency": "BTC",
    "amount": "1.0",
    "status": "initiated",
    "created_at": "2014-03-20T19:07:33.246Z",
    "updated_at": "2014-03-20T19:07:33.246Z",
    "reconciliations": [
        {
            "commercial_document_id": "58d2d3e5-8f99-4439-950e-f438b86fc177",
            "commercial_document_type": "Invoice",
            "amount": "0.8"
        },
        {
            "commercial_document_id": "e722fac4-403a-4599-a436-c92cbc776185",
            "commercial_document_type": "Invoice",
            "amount": "0.2"
        }
    ]
}

GET

/merchants/:merchant_id/payouts

Gets a list of all payouts for a merchant.

Response

200 (OK)
Content-Type: application/json
[
    {
        "id": "c5307e14-1c60-4719-b93d-4ea6e8540a20",
        "payout_account_id": "f0b893cc-240e-409f-938e-44f3bbf96066",
        "currency": "BTC",
        "amount": "1.0",
        "status": "initiated",
        "created_at": "2014-03-20T19:07:33.246Z",
        "updated_at": "2014-03-20T19:07:33.246Z",
        "reconciliations": null
    },
    {
        "id": "e3b8b230-b063-11e3-a5e2-0800200c9a66",
        "payout_account_id": "d9f48b20-b063-11e3-a5e2-0800200c9a66",
        "currency": "USD",
        "amount": "20.0",
        "status": "initiated",
        "created_at": "2014-01-20T19:07:33.246Z",
        "updated_at": "2014-01-20T19:07:33.246Z",
        "reconcilations": null
    }
]

Merchant Users

Manage the users that are associated with a merchant.

GET

/merchants/:merchant_id/users

Gets a list of all merchant users.

Response

200 (OK)
Content-Type: application/json
[
    "b172a3d6-0950-11e3-93f6-080027fd9579", 
    "c136feca-0950-11e3-8e45-080027fd9579"
]

POST

/merchants/:merchant_id/users

Admin-Only: Adds a user to a merchant account.

Response

204 (No Content)

DELETE

/merchants/:merchant_id/users/:user_id

Admin-Only: Deletes a user from a merchant account.

Response

204 (No Content)

Refunds

Manage refunds associated with invoices.

POST

/invoices/:invoice_id/refunds

Create a new refund on an invoice.

Response

201 (Created)
{
    "id":"3c93b850-9e92-4e78-97dd-55a946ebed6d",
    "status":"requested",
    "invoice_id":"9384a112-cde2-4b53-ad02-9a23c6a77c50",
    "payment_address":"1AkUkFZScRPCAPVuJrvhTQu9s3SsMEUwee",
    "amount":"0.05",
    "currency":"USD",
    "payment_currency":"BTC",
    "amount_in_payment_currency":"0.0001",
    "base_to_payment_spot_rate":"0.002",
    "payout_to_payment_spot_rate":"0.002",
    "currency_detail":
        {
            "id":"USD",
            "name":"United States Dollar",
            "symbol":"$",
            "is_crypto":false,
            "sort_order":100,
            "precision":2,
            "aliases":[]
        },
    "payment_currency_detail":
        {
            "id":"BTC",
            "name":"Bitcoin",
            "symbol":"Ƀ",
            "is_crypto":true,
            "sort_order":1,
            "precision":8,
            "aliases":["XBT"]
        },
    "spot_rate_quote_expires_at":"2015-05-12T23:16:15.108Z",
    "created_at":"2015-05-12T23:11:15.325Z",
    "updated_at":"2015-05-12T23:11:23.809Z"
}

GET

/invoices/:invoice_id/refunds

Gets a list of all refunds on an invoice.

Response

200 (OK)
Content-Type: application/json
[
    {
        "id":"3c93b850-9e92-4e78-97dd-55a946ebed6d",
        "status":"initiated",
        "invoice_id":"9384a112-cde2-4b53-ad02-9a23c6a77c50",
        "payment_address":"1AkUkFZScRPCAPVuJrvhTQu9s3SsMEUwee",
        "amount":"0.05",
        "currency":"USD",
        "payment_currency":"BTC",
        "amount_in_payment_currency":"0.0001",
        "base_to_payment_spot_rate":"0.002",
        "payout_to_payment_spot_rate":"0.002",
        "currency_detail":
            {
                "id":"USD",
                "name":"United States Dollar",
                "symbol":"$",
                "is_crypto":false,
                "sort_order":100,
                "precision":2,
                "aliases":[]
            },
        "payment_currency_detail":
            {
                "id":"BTC",
                "name":"Bitcoin",
                "symbol":"Ƀ",
                "is_crypto":true,
                "sort_order":1,
                "precision":8,
                "aliases":["XBT"]
            },
        "spot_rate_quote_expires_at":"2015-05-12T23:16:15.108Z",
        "created_at":"2015-05-12T23:11:15.325Z",
        "updated_at":"2015-05-12T23:11:23.809Z"
    }
]

GET

/refunds/:refund_id

Get a refund.

Response

200 (OK)
Content-Type: application/json
{
    "id":"3c93b850-9e92-4e78-97dd-55a946ebed6d",
    "status":"initiated",
    "invoice_id":"9384a112-cde2-4b53-ad02-9a23c6a77c50",
    "payment_address":"1AkUkFZScRPCAPVuJrvhTQu9s3SsMEUwee",
    "amount":"0.05",
    "currency":"USD",
    "payment_currency":"BTC",
    "amount_in_payment_currency":"0.0001",
    "base_to_payment_spot_rate":"0.002",
    "payout_to_payment_spot_rate":"0.002",
    "currency_detail":
        {
            "id":"USD",
            "name":"United States Dollar",
            "symbol":"$",
            "is_crypto":false,
            "sort_order":100,
            "precision":2,
            "aliases":[]
        },
    "payment_currency_detail":
        {
            "id":"BTC",
            "name":"Bitcoin",
            "symbol":"Ƀ",
            "is_crypto":true,
            "sort_order":1,
            "precision":8,
            "aliases":["XBT"]
        },
    "spot_rate_quote_expires_at":"2015-05-12T23:16:15.108Z",
    "created_at":"2015-05-12T23:11:15.325Z",
    "updated_at":"2015-05-12T23:11:23.809Z"
}

DELETE

/refunds/:refund_id

Delete a refund.

Response

204 (No Content)

PUT

/refunds/:refund_id/refresh_spot_rate

Refresh the invoice spot rate if expired

Response

200 (OK)
Content-Type: application/json
{
    "id":"3c93b850-9e92-4e78-97dd-55a946ebed6d",
    "status":"requested",
    "invoice_id":"9384a112-cde2-4b53-ad02-9a23c6a77c50",
    "payment_address":"1AkUkFZScRPCAPVuJrvhTQu9s3SsMEUwee",
    "amount":"0.05",
    "currency":"USD",
    "payment_currency":"BTC",
    "amount_in_payment_currency":"0.0001",
    "base_to_payment_spot_rate":"0.002",
    "payout_to_payment_spot_rate":"0.002",
    "currency_detail":
        {
            "id":"USD",
            "name":"United States Dollar",
            "symbol":"$",
            "is_crypto":false,
            "sort_order":100,
            "precision":2,
            "aliases":[]
        },
    "payment_currency_detail":
        {
            "id":"BTC",
            "name":"Bitcoin",
            "symbol":"Ƀ",
            "is_crypto":true,
            "sort_order":1,
            "precision":8,
            "aliases":["XBT"]
        },
    "spot_rate_quote_expires_at":"2015-05-12T23:16:15.108Z",
    "created_at":"2015-05-12T23:11:15.325Z",
    "updated_at":"2015-05-12T23:11:23.809Z"
}

PUT

/refunds/:refund_id/accept_spot_rate

Accept the quoted spot rate and initiate the refund

Response

200 (OK)
Content-Type: application/json
{
    "id":"3c93b850-9e92-4e78-97dd-55a946ebed6d",
    "status":"initiated",
    "invoice_id":"9384a112-cde2-4b53-ad02-9a23c6a77c50",
    "payment_address":"1AkUkFZScRPCAPVuJrvhTQu9s3SsMEUwee",
    "amount":"0.05",
    "currency":"USD",
    "payment_currency":"BTC",
    "amount_in_payment_currency":"0.0001",
    "base_to_payment_spot_rate":"0.002",
    "payout_to_payment_spot_rate":"0.002",
    "currency_detail":
        {
            "id":"USD",
            "name":"United States Dollar",
            "symbol":"$",
            "is_crypto":false,
            "sort_order":100,
            "precision":2,
            "aliases":[]
        },
    "payment_currency_detail":
        {
            "id":"BTC",
            "name":"Bitcoin",
            "symbol":"Ƀ",
            "is_crypto":true,
            "sort_order":1,
            "precision":8,
            "aliases":["XBT"]
        },
    "spot_rate_quote_expires_at":"2015-05-12T23:16:15.108Z",
    "created_at":"2015-05-12T23:11:15.325Z",
    "updated_at":"2015-05-12T23:11:23.809Z"
}

Users

GET

/users

Admin-Only: Gets a list of all users.

Response

200 (OK)
Content-Type: application/json
[
    {
        "id": "dd456fd9-9928-4649-89d2-379368787845",
        "email": "user@gocoin.com",
        "first_name": "GoCoin",
        "last_name": "User",
        "created_at": "2013-08-04T07:05:44.590Z",
        "updated_at": "2013-08-04T07:05:44.590Z",
        "image_url": null,
        "merchant_id": "08d3bedf-7cb3-4ccc-9d20-cd221df9443d"
    }
] 

POST

/users

Admin-Only: Adds a new user.

Response

201 (Created)
Content-Type: application/json
{
    "id": "dd456fd9-9928-4649-89d2-379368787845",
    "email": "user@gocoin.com",
    "first_name": "GoCoin",
    "last_name": "User",
    "created_at": "2013-08-04T07:05:44.590Z",
    "updated_at": "2013-08-04T07:05:44.590Z",
    "image_url": null,
    "merchant_id": "08d3bedf-7cb3-4ccc-9d20-cd221df9443d"
}

Response

422
Content-Type: application/json
{ errors: ["list of errors"] }

GET

/users/:user_id

Gets an existing user.

Response

200 (OK)
Content-Type: application/json
{
    "id": "dd456fd9-9928-4649-89d2-379368787845",
    "email": "user@gocoin.com",
    "first_name": "GoCoin",
    "last_name": "User",
    "created_at": "2013-08-04T07:05:44.590Z",
    "updated_at": "2013-08-04T07:05:44.590Z",
    "image_url": null,
    "merchant_id": "08d3bedf-7cb3-4ccc-9d20-cd221df9443d"
}

GET

/user

Gets resource owner user.

Response

200 (OK)
Content-Type: application/json
{
    "id": "dd456fd9-9928-4649-89d2-379368787845",
    "email": "user@gocoin.com",
    "first_name": "GoCoin",
    "last_name": "User",
    "created_at": "2013-08-04T07:05:44.590Z",
    "updated_at": "2013-08-04T07:05:44.590Z",
    "image_url": null,
    "merchant_id": "08d3bedf-7cb3-4ccc-9d20-cd221df9443d"
}

PATCH

/users/:user_id

Updates an existing user.

Response

201 (Created)
Content-Type: application/json
{
    "id": "dd456fd9-9928-4649-89d2-379368787845",
    "email": "user@gocoin.com",
    "first_name": "GoCoin",
    "last_name": "User",
    "created_at": "2013-08-04T07:05:44.590Z",
    "updated_at": "2013-08-04T07:05:44.590Z",
    "image_url": null,
    "merchant_id": "08d3bedf-7cb3-4ccc-9d20-cd221df9443d"
}

DELETE

/users/:id

Admin-Only: Deletes an existing user.

Response

204 (No Content)
Content-Type: application/json

PATCH

/users/:user_id/password

Changes user password.

Response

204 (No Content)
Content-Type: application/json

POST

/users/request_password_reset

Request password reset.

Response

204 (No Content)

PATCH

/users/:user_id/reset_password/:reset_token

Reset password.

Response

204 (No Content)
Content-Type: application/json

GET

/users/:user_id/confirm_account/:confirmation_token

Confirm user account.

Response

301 (Moved Permanently)
Location: http://tbd/?status=user_confirmed

POST

/users/request_new_confirmation_email

Request new confirmation e-mail.

Response

204 (No Content)

GET

/users/:user_id/applications

Get applications for user.

Response

200 (OK)
Content-Type: application/json