Welcome to Carbon's docs!

Get Started    

Order Status

You can always query for the status of an order using its UUID.


JWT Required (Super)

orderIDrequiredthe UUID associated with your order

Get order status

// legacy auth that will be deprecated in our v2 api
let jwtToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJlMzE3YjdlNy0yMzQ1LTQ0MWMtODA0Ni1kYjgxNTkyYmEyN2YiLCJzdXBlclVzZXIiOnRydWUsImNvbnRhY3QiOmZhbHNlLCJlbWFpbCI6ImRhbmllbEBjYXJib24ubW9uZXkiLCJpYXQiOjE1NTczMjc5MTR9.WZnSR5N1FebmT9nMu97PJvku49NY0jk4aKVPKm_1MlM';
// we strongly recommend using your secret key to more securely authenticate your superuser instead
let secretKey = 'sk_test_A41Hm6IY3Q5LJ7ham34Zpkcj';

let headers = {
  headers: {
    Authorization: `Bearer ${secretKey}`

let url = `${ROOT}/v1/status?orderId=96010901-5e4a-4731-a9bb-529906af3e35&contactId=ab5bb41b-5979-4a54-b734-23eb9076188e`;

axios.get(url, headers).then(result => console.log(result)).catch(err => console.log(err));
  "message": "Successfully pulled order status",
  "code": 200,
  "details": {
    "cryptocurrencyAssetPurchase": "EOS",
    "cryptocurrencyAmountPurchase": "0.20166698",
    "transactionHash": "174805e7149b694a62f6dbe2f2433d7f7ed1956f3df2539ddeec90aba0cc90ce",
    "status": "0",
    "timeInitiated": "Tue May 21 2019 20:10:32 GMT-0400 (EDT)",
    "timeCompleted": "Tue May 21 2019 20:10:34 GMT-0400 (EDT)",
    "fiatBaseCurrency": "HKD",
    "paymentType": "Credit/Debit",
    "paymentDetails": {
      "pan": "xxxx-xxxx-xxx-0611",
      "chargeAmount": "1.15",
      "chargedCurrency": "EUR"
    "receiveAddress": "gavinmai1111",
    "uuid": "96010901-5e4a-4731-a9bb-529906af3e35"
// 400
    "message": "no order found",
    "code": 400

// 500
    "message": "internal server error",
    "code": 500
Thank you for your feedback


Status refers to the status of the charge on the user's credit/debit card

There may be some delay between status change on the users bank statement and our database. Note that status' of 1 and 2 are unlikely to ever occur.

-1No charge attempted on card
0Transaction is pending settlement - Crypto has been sent
1Transaction is pending manual settlement
2Transaction is suspended
3Transaction is cancelled - If there is an error involving the delivery of the purchased asset, we will cancel the charge
10Transaction settlement process underway
100Transaction settlement process is complete
7000Transaction declined - generally resulting from the user's bank blocking the transaction, no crypto sent

Updated 6 months ago

What's Next


Order Status

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.