Skip to content

Commit

Permalink
Merge pull request #12 from marcinx/master
Browse files Browse the repository at this point in the history 
* replaces promise chains with async await for inactive HTTP request …
  • Loading branch information
@marcinx
marcinx authored Oct 1, 2022
2 parents a2107d4 + ac9da7f commit b30788c
Show file tree
Hide file tree
Showing 4 changed files with 236 additions and 324 deletions.
301 changes: 125 additions & 176 deletions src/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,34 +35,30 @@ Get your API key and secret here: https://www.coinqvest.com/en/api-settings
Creates a customer object, which can be associated with checkouts, payments, and invoices. Checkouts associated with a customer generate more transaction details, help with your accounting, and can automatically create invoices for your customer and yourself.

```javascript
client.post('/customer',
{
customer:{
email: 'john@doe.com',
firstname: 'John',
lastname: 'Doe',
company: 'ACME Inc.',
adr1: '810 Beach St',
adr2: 'Finance Department',
zip: 'CA 94133',
city: 'San Francisco',
countrycode: 'US'
}
},
function (response) {
let response = await client.post('/customer', {
customer:{
email: 'john@doe.com',
firstname: 'John',
lastname: 'Doe',
company: 'ACME Inc.',
adr1: '810 Beach St',
adr2: 'Finance Department',
zip: 'CA 94133',
city: 'San Francisco',
countrycode: 'US'
}
});

console.log(response.status);
console.log(response.data);
console.log(response.status);
console.log(response.data);

if (response.status !== 200) {
// something went wrong, let's abort and debug by looking at our log file
console.log('Could not create customer. Inspect above log entry.');
return;
}
if (response.status !== 200) {
// something went wrong, let's abort and debug by looking at our log file
console.log('Could not create customer. Inspect above log entry.');
return;
}

let customerId = response.data['customerId']; // store this persistently in your database
}
);
let customerId = response.data['customerId']; // store this persistently in your database
```

**Create a Hosted Checkout** (https://www.coinqvest.com/en/api-docs#post-checkout-hosted)
Expand All @@ -74,208 +70,161 @@ Using this endpoint, your server submits a set of parameters, such as the paymen
Upon visiting the URL, your customer is presented with a checkout page hosted on COINQVEST servers. This page displays all the information the customer needs to complete payment.

```javascript
client.post('/checkout/hosted',
{
charge:{
customerId: customerId, // associates this charge with a customer
currency: 'USD', // specifies the billing currency
lineItems: [{ // a list of line items included in this charge
description: 'T-Shirt',
netAmount: 10,
quantity: 1
}],
discountItems: [{ // an optional list of discounts
description: 'Loyalty Discount',
netAmount: 0.5
}],
shippingCostItems: [{ // an optional list of shipping and handling costs
description: 'Shipping and Handling',
netAmount: 3.99,
taxable: false // sometimes shipping costs are taxable
}],
taxItems: [{
name: 'CA Sales Tax',
percent: 0.0825 // 8.25% CA sales tax
}]
},
settlementCurrency: 'EUR' // specifies in which currency you want to settle
let response = await client.post('/checkout/hosted', {
charge:{
customerId: customerId, // associates this charge with a customer
currency: 'USD', // specifies the billing currency
lineItems: [{ // a list of line items included in this charge
description: 'T-Shirt',
netAmount: 10,
quantity: 1
}],
discountItems: [{ // an optional list of discounts
description: 'Loyalty Discount',
netAmount: 0.5
}],
shippingCostItems: [{ // an optional list of shipping and handling costs
description: 'Shipping and Handling',
netAmount: 3.99,
taxable: false // sometimes shipping costs are taxable
}],
taxItems: [{
name: 'CA Sales Tax',
percent: 0.0825 // 8.25% CA sales tax
}]
},
function (response) {

console.log(response.status);
console.log(response.data);
settlementCurrency: 'EUR' // specifies in which currency you want to settle
});

if (response.status !== 200) {
// something went wrong, let's abort and debug by looking at our log file
console.log('Could not create checkout.');
return;
}
console.log(response.status);
console.log(response.data);

// the checkout was created
// response.data now contains an object as specified in the success response here: https://www.coinqvest.com/en/api-docs#post-checkout
let checkoutId = response.data['checkoutId']; // store this persistently in your database
let url = response.data['url']; // redirect your customer to this URL to complete the payment
if (response.status !== 200) {
// something went wrong, let's abort and debug by looking at our log file
console.log('Could not create checkout.');
return;
}

}
);
// the checkout was created
// response.data now contains an object as specified in the success response here: https://www.coinqvest.com/en/api-docs#post-checkout
let checkoutId = response.data['checkoutId']; // store this persistently in your database
let url = response.data['url']; // redirect your customer to this URL to complete the payment
```

**Monitor Payment State** (https://www.coinqvest.com/en/api-docs#get-checkout)

Once the payment is captured we notify you via email, [webhook](https://www.coinqvest.com/en/api-docs#webhook-concepts). You can also poll [GET /checkout](https://www.coinqvest.com/en/api-docs#get-checkout) for payment status updates:

```javascript
client.get('/checkout',
{id: checkoutId},
function(response) {
console.log(response.status);
console.log(response.data);

if (response.status === 200) {
let state = response.data['checkout']['state'];
if (['COMPLETED', 'DELAYED_COMPLETED', 'RESOLVED'].includes(state)) {
console.log("The payment has completed and your account was credited. You can now ship the goods.");
} else {
// try again in 30 seconds or so...
}
}
let response = await client.get('/checkout', {id: checkoutId});

console.log(response.status);
console.log(response.data);

if (response.status === 200) {
let state = response.data['checkout']['state'];
if (['COMPLETED'].includes(state)) {
console.log("The payment has completed and your account was credited. You can now ship the goods.");
} else {
// try again in 30 seconds or so...
}
);
}
```

**Query your USD Wallet** (https://www.coinqvest.com/en/api-docs#get-wallet)
```javascript
client.get('/wallet',
{assetCode: 'USD'},
function(response) {
console.log(response.status);
console.log(response.data);
}
);
let response = await client.get('/wallet', {assetCode: 'USD'});

console.log(response.status);
console.log(response.data);
```

**Query all Wallets** (https://www.coinqvest.com/en/api-docs#get-wallets)
```javascript
client.get('/wallets',
null,
function(response) {
console.log(response.status);
console.log(response.data);
}
);
let response = await client.get('/wallets');

console.log(response.status);
console.log(response.data);
```

**Withdraw to your NGN Bank Account** (https://www.coinqvest.com/en/api-docs#post-withdrawal)
```javascript
client.post('/withdrawal',
{
sourceAsset: 'USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX', // withdraw from your USD wallet
sourceAmount: 100,
targetNetwork: 'NGN', // send to an NGN bank account
targetAccount: {
nuban: '3080494548',
bankName: 'FirstBank'
}
},
function (response) {
console.log(response.status);
console.log(response.data);
let response = await client.post('/withdrawal', {
sourceAsset: 'USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX', // withdraw from your USD wallet
sourceAmount: 100,
targetNetwork: 'NGN', // send to an NGN bank account
targetAccount: {
nuban: '3080494548',
bankName: 'FirstBank'
}
);
});

console.log(response.status);
console.log(response.data);
```

**Withdraw to your Bitcoin Account** (https://www.coinqvest.com/en/api-docs#post-withdrawal)
```javascript
client.post('/withdrawal',
{
sourceAsset: 'USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX', // withdraw from your USD wallet
sourceAmount: 100,
targetNetwork: 'BTC', // send to a BTC address
targetAccount: {
address: 'bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23'
}
},
function (response) {
console.log(response.status);
console.log(response.data);
let response = await client.post('/withdrawal', {
sourceAsset: 'USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX', // withdraw from your USD wallet
sourceAmount: 100,
targetNetwork: 'BTC', // send to a BTC address
targetAccount: {
address: 'bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23'
}
);
});

console.log(response.status);
console.log(response.data);
```

**Withdraw to your Stellar Account** (https://www.coinqvest.com/en/api-docs#post-withdrawal)
```javascript
client.post('/withdrawal',
{
sourceAsset: 'USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX', // withdraw from your USD wallet
sourceAmount: 100,
targetNetwork: 'XLM', // send to a Stellar account
targetAccount: {
account: 'bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23',
memo: 'Exodus',
memoType: 'text'
}
},
function (response) {
console.log(response.status);
console.log(response.data);
let response = await client.post('/withdrawal', {
sourceAsset: 'USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX', // withdraw from your USD wallet
sourceAmount: 100,
targetNetwork: 'XLM', // send to a Stellar account
targetAccount: {
account: 'bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23',
memo: 'Exodus',
memoType: 'text'
}
);
});

console.log(response.status);
console.log(response.data);
```

**Update a Customer** (https://www.coinqvest.com/en/api-docs#put-customer)
```javascript
client.put('/customer',
{customer:{id: 'CUSTOMER-ID', email: 'john@doe-2.com'}},
function (response) {
console.log(response.status);
console.log(response.data);
}
);
let response = await client.put('/customer', {customer:{id: 'CUSTOMER-ID', email: 'john@doe-2.com'}});

console.log(response.status);
console.log(response.data);
```

**Delete a Customer** (https://www.coinqvest.com/en/api-docs#delete-customer)
```javascript
client.delete('/customer',
{id: 'CUSTOMER-ID'},
function (response) {
console.log(response.status);
console.log(response.data);
}
);
let response = await client.delete('/customer', {id: 'CUSTOMER-ID'});

console.log(response.status);
console.log(response.data);
```

**List your 250 newest customers** (https://www.coinqvest.com/en/api-docs#get-customers)
```javascript
client.get('/wallet',
{limit: 250},
function(response) {
console.log(response.status);
console.log(response.data);
}
);
```
let response = await client.get('/wallet', {limit: 250});

**List all available blockchains** (https://www.coinqvest.com/en/api-docs#get-blockchains)
```javascript
client.get('/blockchains',
null,
function(response) {
console.log(response.status);
console.log(response.data);
}
);
console.log(response.status);
console.log(response.data);
```

**List all available fiat currencies** (https://www.coinqvest.com/en/api-docs#get-blockchains)
**List all available networks** (https://www.coinqvest.com/en/api-docs#get-networks)
```javascript
client.get(
'/fiat-currencies',
null,
function(response) {
console.log(response.status);
console.log(response.data);
}
);
let response = await client.get('/blockchains');

console.log(response.status);
console.log(response.data);
```

**The response object** ([axios](https://github.com/axios/axios) HTTP response as given to your callback function)
Expand Down
Loading

0 comments on commit b30788c

Please sign in to comment.